API-Referenz

Pipe2.ai stellt eine vollständige GraphQL-API bereit. Nutze das interaktive Playground unten, um das Schema zu erkunden, Abfragen auszuführen und Mutationen mit deinem eigenen JWT-Token zu testen.

Playground

Endpoint https://api.pipe2.ai/v1/graphql

Explore the full schema, run queries, and test mutations interactively. Set your JWT token in the Headers tab to authenticate.

Open GraphQL Playground Opens Apollo Sandbox in a new tab

Hinweis

Du musst authentifiziert sein, um das vollständige Schema zu sehen. Setze dein JWT-Token im Tab Headers, bevor du das Schema erkundest — ohne es wird die Introspektion blockiert.

Authentifizierung

Alle Anfragen erfordern ein JWT-Bearer-Token. Hol dir dein Token aus dem Pipe2.ai-Dashboard und setze es dann im Tab Headers des Playgrounds:

{
  "Authorization": "Bearer YOUR_JWT_TOKEN"
}

Kurzbeispiele

Alle Pipelines auflisten:

query {
  pipelines {
    id
    name
    slug
    credit_cost
    description
  }
}

Eine Pipeline ausführen:

mutation RunPipeline($input: RunPipelineInput!) {
  run_pipeline(input: $input) {
    pipeline_run_id
  }
}

Dein Credit-Guthaben prüfen:

mutation {
  get_credit_balance {
    balance
    reserved
    available
  }
}

Schema-Referenz

Automatisch aus dem Live-GraphQL-Schema generiert — nützlich für SEO und schnelles Nachschlagen.

Queries Alle verfügbaren GraphQL-Queries — Pipelines, Assets, Läufe und mehr abrufen.

Mutations Alle verfügbaren GraphQL-Mutations — Pipelines ausführen, API-Schlüssel verwalten, Daten einfügen.

Types Objekttypen, Eingabetypen und Enums, die in der gesamten API verwendet werden.