Zum Hauptinhalt springen
Derzeit verfügbar für Batches. Unterstützung für Scrapes, Crawls, Maps und Answers kommt bald.
Metadaten ermöglichen es Ihnen, benutzerdefinierte Schlüssel-Wert-Paare zu Olostep-Ressourcen hinzuzufügen. Dies ist nützlich für das Tracking, Filtern, Organisieren und Speichern von Kontexten zusammen mit Ihren API-Anfragen. Metadaten folgen dem Ansatz von Stripe — einfach, flexibel und konsistent über alle Endpunkte hinweg.

​
Anwendungsfälle

Tracking & Organisation

Verknüpfen Sie Ressourcen mit internen Systemen über Bestell-IDs, Kunden-IDs oder Projektnamen.

Filtern & Suche

Taggen Sie Ressourcen für eine einfache Wiederauffindbarkeit und Filterung in Ihrer Anwendung.

Workflow-Kontext

Speichern Sie Pipeline-Status, Prioritätsstufen oder Verarbeitungsanweisungen.

Audit-Trail

Zeichnen Sie auf, wer eine Anfrage initiiert hat, Zeitstempel oder Versionsinformationen.

​
Hinzufügen von Metadaten beim Erstellen

Fügen Sie den metadata-Parameter hinzu, wenn Sie eine Ressource erstellen: 
{
  "url": "https://example.com",
  "metadata": {
    "order_id": "12345",
    "customer_name": "John Doe",
    "priority": "high",
    "internal_ref": "proj-2024-001"
  }
}
Metadaten werden in allen nachfolgenden GET-Antworten für diese Ressource zurückgegeben.

​
Validierungsregeln

EinschränkungLimitFehlerbeispiel
Maximale Schlüsselanzahl50"Metadaten können maximal 50 Schlüssel haben. Sie haben 51 Schlüssel angegeben."
Schlüssellänge40 Zeichen"Metadatenschlüssel \"my_very_long_key_name...\" überschreitet das Limit von 40 Zeichen."
SchlüsselformatKeine eckigen Klammern"Metadatenschlüssel \"items[0]\" darf keine eckigen Klammern ([ oder ]) enthalten."
Wertlänge500 Zeichen"Metadatenwert für Schlüssel \"description\" überschreitet das Limit von 500 Zeichen."
WerttypNur Strings"Metadatenwert für Schlüssel \"count\" muss ein String sein. Objekt erhalten."
Typumwandlung: Zahlen und Booleans werden automatisch in Strings umgewandelt.
  • 42 → "42"
  • true → "true"
  • 3.14 → "3.14"
Objekte und Arrays werden abgelehnt.

​
Aktualisieren von Metadaten (PATCH)

Derzeit verfügbar für: Nur Batches.Crawls, Scrapes, Maps und Answers unterstützen noch nicht das Aktualisieren von Metadaten nach der Erstellung.
Sie können Metadaten für bestehende Batches mit dem PATCH-Endpunkt aktualisieren. Updates verwenden ein Merge-Verhalten.

​
Update-Operationen

Neue Schlüssel werden hinzugefügt, während bestehende erhalten bleiben.
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"new_key": "new_value"}}'
Vorher: {"project": "alpha"}
Nachher: {"project": "alpha", "new_key": "new_value"}
Bestehende Schlüssel werden mit neuen Werten überschrieben.
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"project": "beta"}}'
Vorher: {"project": "alpha", "priority": "high"}
Nachher: {"project": "beta", "priority": "high"}
Setzen Sie einen Schlüssel auf null oder "" (leerer String), um ihn zu löschen.
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"priority": null}}'
Vorher: {"project": "alpha", "priority": "high"}
Nachher: {"project": "alpha"}
Setzen Sie das gesamte Metadatenfeld auf null oder "", um alle Schlüssel zu entfernen.
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": null}'
Vorher: {"project": "alpha", "priority": "high"}
Nachher: {}
Fügen Sie Schlüssel hinzu, aktualisieren und löschen Sie sie in einer einzigen Anfrage.
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"project": "gamma", "new_field": "value", "old_field": null}}'
Vorher: {"project": "alpha", "old_field": "remove_me"}
Nachher: {"project": "gamma", "new_field": "value"}

​
Zusammenfassung des PATCH-Verhaltens

OperationAnfrageErgebnis
Schlüssel hinzufügen{"metadata": {"new": "value"}}Schlüssel hinzugefügt, andere erhalten
Schlüssel aktualisieren{"metadata": {"existing": "new_value"}}Schlüssel aktualisiert, andere erhalten
Schlüssel löschen{"metadata": {"key": null}}Schlüssel entfernt, andere erhalten
Schlüssel löschen{"metadata": {"key": ""}}Schlüssel entfernt, andere erhalten
Alle löschen{"metadata": null}Alle Schlüssel entfernt
Alle löschen{"metadata": ""}Alle Schlüssel entfernt
Keine Änderung{"metadata": {}}Keine Änderungen