REST API

Створюйте рішення на основі своїх проєктів Skimle

JSON-ендпоінти для читання й запису даних проєкту та для запуску проєкту від початку до кінця. Автентифікуйтеся ключем Bearer, надішліть дію й отримайте JSON у відповідь.

Почніть за три кроки

Від нуля до першого автентифікованого запиту.

1

Створіть ключ API

Ключ проєкту дає доступ до одного проєкту. Ключ акаунта дає доступ до однієї команди й може створювати в ній проєкти. Обидва бувають рівня читання та редагування.

  1. 1. Відкрийте сторінку ключів API
  2. 2. Виберіть проєкт, до якого матиме доступ ключ, і оберіть доступ для читання чи редагування
  3. 3. Скопіюйте ключ: Skimle зберігає лише його хеш

Скопіюйте ключ одразу.

Повне значення ключа показується один раз під час створення. Після закриття діалогу в нас залишається лише хеш, тож загублений ключ доведеться випустити заново.

2

Надішліть перший запит

Передайте ключ як токен Bearer, а дію в тілі JSON. Кожен ендпоінт приймає JSON і повертає JSON.

curl -X POST https://app.skimle.com/api/skimle-read \
  -H "Authorization: Bearer skm_…r" \
  -H "Content-Type: application/json" \
  -d '{ "action": "get_categories" }'

Ключі для читання закінчуються на r, ключі для редагування на e. Ключі проєкту викликають /api/skimle-read і /api/skimle-write. Ключі акаунта викликають /api/skimle-account.

3

Відкрийте довідник API

Переглядайте всі ендпоінти з описами, форматами запитів і панеллю для тестування. Кожен маршрут приймає тіло у вигляді розмеченого об’єднання за полем action.

Специфікація OpenAPI 3.1 доступна за адресою /api/openapi.json.

Готові почати?

Керуйте ключами проєктів або ознайомтеся із сервером MCP для агентних клієнтів.