Panoramica API

La maggior parte di ciò che puoi fare nell'interfaccia web è disponibile tramite l'API: avvia flows da CI/CD, importa i risultati nei tuoi strumenti o crea integrazioni.

Crea un token

1. Apri Settings → API Tokens nell'interfaccia web.
2. Clicca su Create Token, assegnagli facoltativamente un nome e imposta una scadenza tra 1 minuto e 3 anni.
3. Copia subito il token: viene mostrato una sola volta.

Un token è associato al tuo account ed eredita i permessi del tuo ruolo. Utenti, ruoli e token API, template dei flow, preferiti e le tue impostazioni sono gestiti solo da una sessione del browser con accesso effettuato: un token riceve 403 sulle route REST /users, /roles e /tokens e un errore da quelle operazioni GraphQL.

Chiama l'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"

Avvia un flow con una mutazione GraphQL:

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

Genera un client

• GraphQL — lo schema si trova in backend/pkg/graph/schema.graphqls nel repository; usa GraphQL Code Generator, genqlient o Apollo.
• REST — la specifica OpenAPI è disponibile su /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