Обзор API

Большая часть функций веб-интерфейса доступна через API — запускайте flows из CI/CD, получайте результаты в собственные инструменты или создавайте интеграции.

Создание токена

1. В веб-интерфейсе перейдите в раздел Settings → API Tokens.
2. Нажмите Create Token, при необходимости задайте имя и установите срок действия от 1 минуты до 3 лет.
3. Скопируйте токен сразу после создания — он отображается только один раз.

Токен привязан к вашей учётной записи и наследует разрешения вашей роли. Пользователи, роли и токены API, шаблоны flow, избранное и ваши настройки управляются только из авторизованного сеанса браузера: токен получает ошибку 403 на маршрутах REST /users, /roles и /tokens, а также ошибку от соответствующих операций GraphQL.

Обращение к API

curl -X POST https://your-pentagi-host:8443/api/v1/graphql \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ flows { id title status } }"}'

curl https://your-pentagi-host:8443/api/v1/flows/ \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Запустите flow с помощью мутации GraphQL:

mutation CreateFlow {
  createFlow(modelProvider: "openai", input: "Test the security of https://example.com") {
    id
    title
    status
    createdAt
  }
}

Генерация клиента

• GraphQL — схема доступна по адресу backend/pkg/graph/schema.graphqls в репозитории; используйте GraphQL Code Generator, genqlient или Apollo.
• REST — спецификация OpenAPI доступна по адресу /api/v1/swagger/doc.json:

openapi-generator-cli generate \
  -i https://your-pentagi-host:8443/api/v1/swagger/doc.json \
  -g python \
  -o ./pentagi-client