Metadaten

Derzeit verfügbar für Batches. Unterstützung für Scrapes, Crawls, Maps und Answers kommt bald.

Metadaten ermöglichen es dir, benutzerdefinierte Schlüssel-Wert-Paare zu Olostep-Ressourcen hinzuzufügen. Dies ist nützlich für das Tracking, Filtern, Organisieren und Speichern von Kontext zusammen mit deinen API-Anfragen. Metadaten folgen Stripes Ansatz — einfach, flexibel und konsistent über alle Endpunkte hinweg.

Anwendungsfälle

Tracking & Organisation

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

Filtern & Suche

Markiere Ressourcen für einfache Abrufbarkeit und Filterung in deiner Anwendung.

Workflow-Kontext

Speichere Pipeline-Status, Prioritätsstufen oder Verarbeitungsanweisungen.

Audit-Trail

Zeichne auf, wer eine Anfrage initiiert hat, Zeitstempel oder Versionsinformationen.

Hinzufügen von Metadaten bei der Erstellung

Füge den metadata-Parameter hinzu, wenn du eine Ressource erstellst:

{
  "url": "https://example.com",
  "metadata": {
    "order_id": "12345",
    "customer_name": "John Doe",
    "priority": "high",
    "internal_ref": "proj-2024-001"
  }
}

import requests

response = requests.post(
    "https://api.olostep.com/v1/batches",
    headers={"Authorization": "Bearer <your_token>"},
    json={
        "items": [{"custom_id": "1", "url": "https://example.com"}],
        "metadata": {
            "project": "q4-analysis",
            "team": "data-ops",
            "priority": "high"
        }
    }
)

const response = await fetch("https://api.olostep.com/v1/batches", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <your_token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    items: [{ custom_id: "1", url: "https://example.com" }],
    metadata: {
      project: "q4-analysis",
      team: "data-ops",
      priority: "high"
    }
  })
});

Metadaten werden in allen nachfolgenden GET-Antworten für diese Ressource zurückgegeben.

Validierungsregeln

Einschränkung	Limit	Fehlerbeispiel
Maximale Schlüsselanzahl	50	`"Metadaten können maximal 50 Schlüssel haben. Du hast 51 Schlüssel bereitgestellt."`
Schlüssellänge	40 Zeichen	`"Metadatenschlüssel \"my_very_long_key_name...\" überschreitet das 40-Zeichen-Limit."`
Schlüsselformat	Keine eckigen Klammern	`"Metadatenschlüssel \"items[0]\" darf keine eckigen Klammern ([ oder ]) enthalten."`
Wertlänge	500 Zeichen	`"Metadatenwert für Schlüssel \"description\" überschreitet das 500-Zeichen-Limit."`
Werttyp	Nur Zeichenketten	`"Metadatenwert für Schlüssel \"count\" muss eine Zeichenkette sein. Objekt erhalten."`

Typumwandlung: Zahlen und Booleans werden automatisch in Zeichenketten 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.

Du kannst Metadaten bei bestehenden Batches mit dem PATCH-Endpunkt aktualisieren. Updates verwenden ein Merge-Verhalten.

Update-Operationen

Neue Schlüssel hinzufügen

Neue Schlüssel werden hinzugefügt, während bestehende beibehalten werden.

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 aktualisieren

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"}

Bestimmte Schlüssel löschen

Setze einen Schlüssel auf null oder "" (leere Zeichenkette), 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"}

Alle Metadaten löschen

Setze 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: {}

Gemischte Operationen

Füge hinzu, aktualisiere und lösche Schlüssel 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

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

Allgemein

Abschürfungen

Chargen

Durchläufe

Karten

Antworten

Suche

Monitore

Dateien

Zeitpläne

Abrufen

Kontostand & Abrechnung

Anwendungsfälle

Tracking & Organisation

Filtern & Suche

Workflow-Kontext

Audit-Trail

Hinzufügen von Metadaten bei der Erstellung

Validierungsregeln

Aktualisieren von Metadaten (PATCH)

Update-Operationen

Zusammenfassung des PATCH-Verhaltens

​Anwendungsfälle

Tracking & Organisation

Filtern & Suche

Workflow-Kontext

Audit-Trail

​Hinzufügen von Metadaten bei der Erstellung

​Validierungsregeln

​Aktualisieren von Metadaten (PATCH)

​Update-Operationen

​Zusammenfassung des PATCH-Verhaltens

Anwendungsfälle

Hinzufügen von Metadaten bei der Erstellung

Validierungsregeln

Aktualisieren von Metadaten (PATCH)

Update-Operationen

Zusammenfassung des PATCH-Verhaltens