API-Übersicht

Das Meiste, was Sie in der Web-UI tun können, ist auch über die API verfügbar – starten Sie Flows aus CI/CD-Pipelines, rufen Sie Ergebnisse in Ihre eigenen Tools ab oder erstellen Sie Integrationen.

Token erstellen

1. Öffnen Sie Settings → API Tokens in der Web-UI.
2. Klicken Sie auf Create Token, vergeben Sie optional einen Namen und legen Sie eine Ablaufzeit zwischen 1 Minute und 3 Jahren fest.
3. Kopieren Sie den Token sofort – er wird nur einmal angezeigt.

Ein Token gehört zu Ihrem Konto und erbt die Berechtigungen Ihrer Rolle. Benutzer, Rollen und API-Tokens, Flow-Vorlagen, Favoriten und Ihre Einstellungen werden nur aus einer angemeldeten Browsersitzung verwaltet: Ein Token erhält auf den REST-Routen /users, /roles und /tokens den Status 403 sowie einen Fehler bei diesen GraphQL-Operationen.

API aufrufen

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"

Starten Sie einen Flow mit einer GraphQL-Mutation:

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

Client generieren

• GraphQL – das Schema befindet sich unter backend/pkg/graph/schema.graphqls im Repository; verwenden Sie GraphQL Code Generator, genqlient oder Apollo.
• REST – die OpenAPI-Spezifikation wird unter /api/v1/swagger/doc.json bereitgestellt:

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