Dateien API

Dateien hochladen, Anreicherungsstatus abfragen, vorzeichenbehaftete Download-URLs abrufen und Datei-Metadaten verwalten.

Dateien sind die primären Eingaben für Verifizierungspipelines. Nach dem Hochladen reichert Crowdee jede Datei automatisch an — dabei werden technische Metadaten, Inhalts-Fingerabdrücke und formatspezifische Signale extrahiert —, sodass Pipelines auf strukturierten Daten statt auf rohen Bytes arbeiten können.

Endpunkt-Referenz

Methode	Pfad	Beschreibung
`POST`	`/v2/projects/{projectId}/files`	Eine Datei hochladen
`GET`	`/v2/projects/{projectId}/files`	Projektdateien auflisten
`GET`	`/v2/files/{fileId}`	Dateidetails abrufen
`PUT`	`/v2/files/{fileId}`	Datei-Metadaten aktualisieren
`DELETE`	`/v2/files/{fileId}`	Eine Datei löschen
`GET`	`/v2/files/{fileId}/download`	Vorzeichenbehaftete Download-URL abrufen

Eine Datei hochladen

POST /v2/projects/{projectId}/files

Dateien werden als multipart/form-data hochgeladen. Setzen Sie den Content-Type-Header nicht manuell — lassen Sie den HTTP-Client ihn (mit dem korrekten Boundary) automatisch setzen.

Unterstützte Formate

Kategorie	Akzeptierte MIME-Typen
Bild	`image/jpeg`, `image/png`, `image/webp`, `image/gif`, `image/bmp`, `image/heic`, `image/avif`
Audio	`audio/mpeg`, `audio/wav`, `audio/ogg`, `audio/mp4`, `audio/flac`
Video	`video/mp4`, `video/webm`, `video/quicktime`, `video/x-msvideo`
Dokument	`application/pdf`, `text/plain`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`

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

Antwort

{
  "id": "file_xyz789",
  "projectId": "proj_abc123",
  "name": "photo.jpg",
  "mimeType": "image/jpeg",
  "size": 2457600,
  "enrichmentStatus": "pending",
  "tags": [],
  "privacyLevel": "private",
  "createdAt": "2024-11-15T10:01:00Z",
  "updatedAt": "2024-11-15T10:01:00Z"
}

Die Anreicherung startet automatisch. Der enrichmentStatus wechselt innerhalb von Sekunden von pending zu running.

Anreicherungsstatus abfragen

GET /v2/files/{fileId} oder GET /v2/projects/{projectId}/files/{fileId} — beide Endpunkte geben dasselbe Objekt zurück.

Das Feld enrichmentStatus folgt diesem Zustandsautomaten:

pending → running → completed
                 ↘ failed

Starten Sie keinen Verifizierungslauf, bis enrichmentStatus den Wert "completed" hat. Das Einreichen eines Laufs für eine nicht angereicherte Datei gibt einen 422 UNPROCESSABLE_ENTITY-Fehler zurück.

Empfohlene Abfrageintervalle:

Dateityp	Abfrageintervall
Bild	Alle 5 Sekunden
Audio (< 10 Min.)	Alle 10 Sekunden
Audio (> 10 Min.)	Alle 30 Sekunden
Video (< 5 Min.)	Alle 15 Sekunden
Video (> 5 Min.)	Alle 30–60 Sekunden
Dokument / Text	Alle 5 Sekunden

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

Antwort für eine angereicherte Datei:

{
  "id": "file_xyz789",
  "name": "photo.jpg",
  "mimeType": "image/jpeg",
  "size": 2457600,
  "enrichmentStatus": "completed",
  "enrichment": {
    "width": 3024,
    "height": 4032,
    "colorSpace": "sRGB",
    "hasExif": true,
    "captureDevice": "Apple iPhone 15 Pro",
    "capturedAt": "2024-10-28T14:32:11Z",
    "gpsCoordinates": { "lat": 52.5200, "lng": 13.4050 }
  },
  "createdAt": "2024-11-15T10:01:00Z",
  "updatedAt": "2024-11-15T10:01:07Z"
}

Projektdateien auflisten

GET /v2/projects/{projectId}/files

Abfrageparameter

Parameter	Typ	Beschreibung
`enrichmentStatus`	string	Nach Status filtern: `pending`, `running`, `completed`, `failed`
`mimeType`	string	Nach MIME-Typ-Präfix filtern, z. B. `image/` oder `video/mp4`
`limit`	integer	Standard 20, maximal 200
`offset`	integer	Standard 0

curl "https://api.crowdee.ai/v2/projects/proj_abc123/files?enrichmentStatus=completed&limit=100" \
  -H "X-API-Key: crw_YOUR_API_KEY"

Datei-Metadaten aktualisieren

PUT /v2/files/{fileId}

Aktualisieren Sie den Anzeigenamen, die Tags, die Datenschutzstufe oder benutzerdefinierte Metadaten der Datei. Der Dateiinhalt und die Anreicherungsdaten sind nach dem Hochladen unveränderlich.

Aktualisierbare Felder

Feld	Typ	Beschreibung
`name`	string	Anzeigename der Datei
`tags`	string[]	Beliebige Bezeichnungen zum Gruppieren und Filtern
`privacyLevel`	string	`private` \| `sensitive` \| `internal` \| `public`
`additionalInfo`	object	Freiform-JSONB für benutzerdefinierte Metadaten

curl -X PUT https://api.crowdee.ai/v2/files/file_xyz789 \
  -H "X-API-Key: crw_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "protest-photo-berlin-2024.jpg",
    "tags": ["berlin", "protest", "2024"],
    "privacyLevel": "sensitive",
    "additionalInfo": {
      "source": "Telegram channel",
      "receivedAt": "2024-10-28T15:00:00Z"
    }
  }'

Vorzeichenbehaftete Download-URL

GET /v2/files/{fileId}/download

Gibt eine 302-Weiterleitung zu einer temporären vorzeichenbehafteten S3-URL zurück. Die URL ist 15 Minuten lang gültig.

Vorzeichenbehaftete URLs laufen nach 15 Minuten ab. Rufen Sie den /download-Endpunkt bei Bedarf erneut ab — er gibt stets eine neue URL zurück. Speichern Sie das Weiterleitungsziel nicht länger als 10 Minuten im Cache.

# Use -L to follow the redirect and save the file
curl -L https://api.crowdee.ai/v2/files/file_xyz789/download \
  -H "X-API-Key: crw_YOUR_API_KEY" \
  -o photo.jpg

Eine Datei löschen

DELETE /v2/files/{fileId}

Das Löschen einer Datei entfernt sie dauerhaft aus dem Speicher. Verifizierungsläufe, die auf die Datei verwiesen haben, behalten ihre Ergebnisse und Urteile, ein erneutes Ausführen ist jedoch ohne erneutes Hochladen der Datei nicht möglich. Erwägen Sie, die Datei über privacyLevel: "sensitive" zu archivieren, bevor Sie sie löschen.

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

Gibt bei Erfolg 204 No Content zurück.

On this page