API-Übersicht

Die Crowdee REST API bietet Ihnen programmatischen Zugriff auf Projekte, Dateien, Verifizierungspipelines und die Organisationsverwaltung. Alle Endpunkte geben JSON zurück und folgen konventionellen HTTP-Semantiken.

Basis-URL

https://api.crowdee.ai/v2

Alle Pfade in dieser Referenz sind relativ zu dieser Basis.

Authentifizierung

Die API unterstützt drei Authentifizierungsmethoden. API-Schlüssel werden für Server-zu-Server-Integrationen empfohlen.

Methode	Header	Verwendungszweck
API-Schlüssel	`X-API-Key: crw_...`	Server-zu-Server, CI/CD, Skripte
JWT Bearer	`Authorization: Bearer <token>`	Sitzungsbasierte Backend-Aufrufe
OIDC	Cookie / OIDC-Flow	Browserzugriff

Für API-Schlüssel fügen Sie den Schlüssel bei jeder Anfrage ein:

curl https://api.crowdee.ai/v2/projects \
  -H "X-API-Key: crw_YOUR_API_KEY"

API-Schlüssel sind einer Rolle zugeordnet (viewer, user, admin) und können optional auf bestimmte Organisationen beschränkt werden. Weitere Informationen zum Erstellen von Schlüsseln, zur Verwaltung von Geltungsbereichen und zum Verständnis von Rollenberechtigungen finden Sie unter Authentifizierung.

Anfrageformat

Senden Sie einen Content-Type: application/json-Header und einen JSON-Body für alle Nicht-Datei-Endpunkte:

curl -X POST https://api.crowdee.ai/v2/projects \
  -H "X-API-Key: crw_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "News Investigation Q4", "type": "research"}'

Datei-Uploads verwenden multipart/form-data. Lassen Sie den Content-Type-Header weg und lassen Sie curl ihn automatisch setzen:

curl -X POST https://api.crowdee.ai/v2/projects/proj_abc123/files \
  -H "X-API-Key: crw_YOUR_API_KEY" \
  -F "file=@footage.mp4"

Paginierung

Listen-Endpunkte akzeptieren die Query-Parameter limit und offset. Antworten enthalten ein total-Feld auf oberster Ebene mit der Gesamtzahl der übereinstimmenden Datensätze.

Parameter	Standard	Maximum
`limit`	20	200
`offset`	0	—

# Seite 3 der Ergebnisse mit 50 Einträgen pro Seite abrufen
curl "https://api.crowdee.ai/v2/projects?limit=50&offset=100" \
  -H "X-API-Key: crw_YOUR_API_KEY"

Beispiel einer paginierten Antwort:

{
  "data": [...],
  "total": 237,
  "limit": 50,
  "offset": 100
}

Ratenbegrenzung

Authentifizierungsstatus	Limit
Authentifiziert	3.000 Anfragen pro 15-Minuten-Fenster
Anonym	150 Anfragen pro 15-Minuten-Fenster

Jede Antwort enthält Header zur Ratenbegrenzung, damit Sie Ihren Verbrauch verfolgen können:

Header	Beschreibung
`X-RateLimit-Limit`	Gesamtzahl der zulässigen Anfragen im aktuellen Fenster
`X-RateLimit-Remaining`	Verbleibende Anfragen bis zum Zurücksetzen des Fensters
`X-RateLimit-Reset`	Unix-Zeitstempel, wann das Fenster zurückgesetzt wird

Wenn X-RateLimit-Remaining den Wert 0 erreicht, geben alle nachfolgenden Anfragen 429 Too Many Requests zurück, bis das Fenster zurückgesetzt wird. Implementieren Sie Wiederholungslogik mit exponentiellem Backoff und beachten Sie den Retry-After-Header, der in 429-Antworten enthalten ist.

OpenAPI-Spezifikation

Eine maschinenlesbare OpenAPI 3.1-Spezifikation ist verfügbar unter:

https://api.crowdee.ai/v2/openapi.json

Sie können jeden Endpunkt interaktiv über die Scalar-Benutzeroberfläche erkunden unter:

https://api.crowdee.ai/v2

Die Spezifikation ist auch unter /v2/llms.txt als Klartext-Zusammenfassung verfügbar, die für den LLM-Konsum optimiert ist.