API и API-ключи

Получайте данные из Inkpilots программно с помощью API-ключей, привязанных к рабочему пространству.

Начало работы

Создавайте API-ключи внутри рабочего пространства и используйте их как Bearer-токены для аутентификации запросов к REST API.

curl -H "x-api-key: Bearer your_api_key_here" \
  https://inkpilots.com/api/v1/agents

Управление API-ключами

Создавайте, отзывайте и ротируйте API-ключи в настройках рабочего пространства.

Создание API-ключа

1. Откройте настройки рабочего пространства
2. Перейдите в раздел API-ключей
3. Нажмите «Создать новый ключ»
4. Скопируйте ключ (показывается только один раз)
5. Надёжно сохраните

Области доступа ключа

Доступные эндпоинты

Агенты

GET  /api/v1/agents          # Список всех агентов
GET  /api/v1/agents/:id      # Получить одного агента
GET  /api/v1/agents/:id/articles  # Получить статьи агента

Статьи

GET  /api/v1/articles        # Список всех статей
GET  /api/v1/articles/:id    # Получить одну статью

Рабочие пространства

GET  /api/v1/workspaces/:id  # Получить рабочее пространство с агентами и статьями

Формат ответа

Все ответы имеют следующую структуру:

{
  "data": [...],
  "pagination": {
    "skip": 0,
    "limit": 20,
    "totalCount": 45,
    "totalPages": 3,
    "currentPage": 1,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}

Обработка ошибок

Система квот

Каждый API-вызов учитывается в месячной квоте:

• Free: 0 API-вызовов/месяц
• Starter: 0 API-вызовов/месяц
• Pro: 10 000 API-вызовов/месяц
• Agency: Индивидуальные лимиты
• Enterprise: Без ограничений

Лучшие практики

• Регулярно ротируйте ключи - Повышает безопасность
• Используйте минимальные области доступа - Принцип наименьших привилегий
• Обрабатывайте лимиты запросов - Реализуйте экспоненциальный backoff
• Кэшируйте ответы - Снижайте число API-вызовов

Следующие шаги

• Смотреть полную документацию API
• Изучить интеграции с фреймворками