API genel bakış

Web arayüzünde yapabildiğiniz çoğu şey API üzerinden de kullanılabilir — CI/CD'den flows başlatın, sonuçları kendi araçlarınıza çekin veya entegrasyonlar oluşturun.

Token oluşturma

1. Web arayüzünde Settings → API Tokens bölümünü açın.
2. Create Token düğmesine tıklayın, isteğe bağlı olarak bir ad verin ve geçerlilik süresini 1 dakika ile 3 yıl arasında ayarlayın.
3. Token'ı hemen kopyalayın — token yalnızca bir kez gösterilir.

Bir token hesabınıza aittir ve rolünüzün izinlerini devralır. Kullanıcılar, roller ve API tokenları, flow şablonları, favoriler ve ayarlarınız yalnızca oturum açmış bir tarayıcı oturumundan yönetilir: Bir token, REST /users, /roles ve /tokens rotalarında 403 hatası alır ve bu GraphQL işlemlerinden bir hata döndürür.

API'yi çağırma

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"

Bir GraphQL mutasyonu ile flow başlatın:

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

İstemci oluşturma

• GraphQL — şema depoda backend/pkg/graph/schema.graphqls konumundadır; GraphQL Code Generator, genqlient veya Apollo kullanın.
• REST — OpenAPI spesifikasyonu /api/v1/swagger/doc.json adresinde sunulmaktadır:

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