Crowdee
API-Referenz

Datensätze API

Versionierte Mediendateisammlungen erstellen und verwalten, Bereinigungs-Pipelines anwenden und verarbeitete Dateien exportieren.

Datensätze sind organisations-übergreifende versionierte Dateisammlungen. Dateien werden in eine unveränderliche Roh-Version hochgeladen; Bereinigung und Anreicherung erstellen neue abgeleitete Versionen, ohne die Quelle zu verändern.

Endpunkt-Übersicht

MethodePfadBeschreibung
GET/v2/datasetsAlle Datensätze der aktiven Organisation auflisten
POST/v2/datasetsDatensatz erstellen
GET/v2/datasets/{datasetId}Datensatz mit allen Versionen abrufen
PATCH/v2/datasets/{datasetId}Name oder Beschreibung aktualisieren
DELETE/v2/datasets/{datasetId}Datensatz und alle Versionen löschen
POST/v2/datasets/{datasetId}/filesDateien in die Roh-Version hochladen
DELETE/v2/datasets/{datasetId}/files/{fileId}Datei aus der Roh-Version entfernen
GET/v2/datasets/{datasetId}/versionsAlle Versionen auflisten
GET/v2/datasets/{datasetId}/versions/{versionId}Version mit paginiertem Datei-Listing abrufen
POST/v2/datasets/{datasetId}/versions/{versionId}/cleanBereinigungs-Pipeline starten
POST/v2/datasets/{datasetId}/versions/{versionId}/enrichAnreicherung für alle Dateien starten
GET/v2/datasets/{datasetId}/versions/{versionId}/exportVorzeichnete Download-URLs abrufen
GET/v2/datasets/catalog/cleaning-pipelinesVerfügbare Bereinigungs-Pipelines auflisten

Datensatz erstellen

POST /v2/datasets

Anfrage-Body

FeldTypErforderlichBeschreibung
namestringJaLesbarer Anzeigename
internalIdstringJaSlug für S3-Pfade; nur Buchstaben, Zahlen, Bindestriche und Unterstriche; eindeutig pro Organisation
modalitystringJaEines von image, audio, video, text, document, multimodal
descriptionstringNeinOptionale Beschreibung
curl -X POST https://api.crowdee.ai/v2/datasets \
  -H "X-API-Key: crw_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Interview-Audio 2024-Q4",
    "internalId": "interview-audio-q4-2024",
    "modality": "audio",
    "description": "Rohe Interview-Aufnahmen für die Sprecherverifizierung"
  }'

Antwort (201): Das erstellte Datensatz-Objekt. Eine raw-Version wird automatisch angelegt und ist über GET /v2/datasets/{datasetId} (Feld versions) abrufbar.


Dateien hochladen

POST /v2/datasets/{datasetId}/files

Fügt Dateien der Roh-Version des Datensatzes hinzu. Senden Sie eine multipart/form-data-Anfrage mit einer oder mehreren Dateien unter dem Schlüssel file[].

curl -X POST https://api.crowdee.ai/v2/datasets/ds_abc123/files \
  -H "X-API-Key: crw_YOUR_API_KEY" \
  -F "file[]=@aufnahme1.mp3" \
  -F "file[]=@aufnahme2.wav"

Gibt ein Array der erstellten Datei-Objekte zurück. Anreicherung wird nicht automatisch gestartet — rufen Sie den Anreicherungs-Endpunkt separat auf, wenn Sie bereit sind.

Dateien werden in S3 unter datasets/{organizationId}/{internalId}/raw/ gespeichert. Die bei der Erstellung festgelegte internalId ist unveränderlich und wird Teil jedes Dateipfads in diesem Datensatz.


Versionen auflisten

GET /v2/datasets/{datasetId}/versions

Gibt alle Versionen in Erstellungsreihenfolge zurück. Verwenden Sie das state-Feld, um zu bestimmen, welche Versionen für weitere Verarbeitung bereit sind.

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

Version mit Dateien abrufen

GET /v2/datasets/{datasetId}/versions/{versionId}

Query-Parameter

ParameterTypStandardMaxBeschreibung
pageinteger1Seitennummer (1-basiert)
limitinteger50200Dateien pro Seite
curl "https://api.crowdee.ai/v2/datasets/ds_abc123/versions/ver_clean001?page=1&limit=50" \
  -H "X-API-Key: crw_YOUR_API_KEY"

sourceFileId ist nur bei Dateien befüllt, die von einer Bereinigungs-Pipeline verändert wurden — er verweist auf die ursprüngliche Rohdatei. Dateien, die unverändert übernommen wurden, haben sourceFileId: null.


Version bereinigen

POST /v2/datasets/{datasetId}/versions/{versionId}/clean

Startet einen Bereinigungs-Pipeline-Job auf der angegebenen Version. Die Quell-Version muss den Zustand raw oder cleaned haben. Eine neue Version mit Zustand cleaning wird erstellt und wechselt bei Erfolg zu cleaned oder bei einem Fehler zu failed.

Anfrage-Body

FeldTypErforderlichBeschreibung
pipelineSlugstringJaAnzuwendende Bereinigungs-Pipeline (z. B. clean-audio-silence)
labelstringNeinLesbares Label für die neue Version
curl -X POST https://api.crowdee.ai/v2/datasets/ds_abc123/versions/ver_raw001/clean \
  -H "X-API-Key: crw_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pipelineSlug": "clean-audio-silence",
    "label": "Stille entfernt Nov 2024"
  }'

Antwort (200): die neue abgeleitete Version im Zustand cleaning.

Fragen Sie GET /v2/datasets/{datasetId}/versions/{versionId} ab, bis state cleaned oder failed ist.

Pro Datensatz kann immer nur ein Bereinigungsjob gleichzeitig laufen. Wenn bereits eine Version im Zustand cleaning existiert, gibt die Anfrage 400 zurück.


Version anreichern

POST /v2/datasets/{datasetId}/versions/{versionId}/enrich

Stellt für jede Datei in der Version einen Anreicherungsjob in die Warteschlange. Die Version muss den Zustand raw oder cleaned haben. Eine neue abgeleitete Version im Zustand enriching wird erstellt und wechselt zu cleaned_and_enriched, sobald alle Dateien verarbeitet sind.

curl -X POST https://api.crowdee.ai/v2/datasets/ds_abc123/versions/ver_clean001/enrich \
  -H "X-API-Key: crw_YOUR_API_KEY"

Antwort (200): das neu erstellte Versions-Objekt im Zustand enriching.

Die Anreicherung verwendet dieselben MIME-typ-spezifischen Worker wie Projektdateien (enrich-audio, enrich-video, enrich-image, enrich-text). Fragen Sie die neue Version ab, bis ihr Zustand cleaned_and_enriched oder failed ist.


Version exportieren

GET /v2/datasets/{datasetId}/versions/{versionId}/export

Gibt vorzeichnete S3-Download-URLs (24-Stunden-Ablauf) für alle Dateien in der Version zurück.

curl https://api.crowdee.ai/v2/datasets/ds_abc123/versions/ver_clean001/export \
  -H "X-API-Key: crw_YOUR_API_KEY"

Antwort:

{
  "files": [
    {
      "fileId": "file_cleaned_001",
      "name": "aufnahme1_bereinigt.mp3",
      "url": "https://s3.example.com/datasets/.../aufnahme1_bereinigt.mp3?X-Amz-Expires=86400&..."
    }
  ],
  "expiresInSeconds": 86400
}

Katalog der Bereinigungs-Pipelines

GET /v2/datasets/catalog/cleaning-pipelines

Listet alle verfügbaren Bereinigungs-Pipelines mit den unterstützten Modalitäten auf.

curl https://api.crowdee.ai/v2/datasets/catalog/cleaning-pipelines \
  -H "X-API-Key: crw_YOUR_API_KEY"

Antwort:

[
  {
    "slug": "clean-audio-silence",
    "name": "Stille-Trimmer",
    "description": "Entfernt führende und abschließende Stille aus Audiodateien",
    "supportedModalities": ["audio"]
  }
]

Verwenden Sie das Array supportedModalities, um Bereinigungsoptionen basierend auf der Modalität Ihres Datensatzes zu filtern, bevor Sie sie Benutzern anzeigen.

Wie hilfreich ist diese Seite?

© 2026 Crowdee GmbH. Alle Rechte vorbehalten.

On this page