Naar hoofdinhoud gaan
Momenteel beschikbaar voor Batches. Ondersteuning voor scrapes, crawls, maps en antwoorden komt binnenkort.
Metadata stelt je in staat om aangepaste sleutel-waarde paren toe te voegen aan Olostep resources. Dit is nuttig voor het volgen, filteren, organiseren en opslaan van context naast je API-verzoeken. Metadata volgt Stripe’s aanpak — eenvoudig, flexibel en consistent over alle eindpunten.

​
Gebruiksscenario’s

Volgen & Organisatie

Koppel resources aan interne systemen met order-ID’s, klant-ID’s of projectnamen.

Filteren & Zoeken

Tag resources voor eenvoudige opvraging en filtering in je applicatie.

Workflow Context

Sla pijplijnfase, prioriteitsniveau of verwerkingsinstructies op.

Audit Trail

Registreer wie een verzoek heeft geïnitieerd, tijdstempels of versie-informatie.

​
Metadata toevoegen bij creatie

Voeg de metadata parameter toe bij het creëren van een resource: 
{
  "url": "https://example.com",
  "metadata": {
    "order_id": "12345",
    "customer_name": "John Doe",
    "priority": "high",
    "internal_ref": "proj-2024-001"
  }
}
Metadata wordt geretourneerd in alle volgende GET-antwoorden voor die resource.

​
Validatieregels

BeperkingLimietFoutvoorbeeld
Maximum aantal sleutels50"Metadata kan maximaal 50 sleutels hebben. Je hebt 51 sleutels opgegeven."
Sleutellengte40 tekens"Metadata sleutel \"my_very_long_key_name...\" overschrijdt de limiet van 40 tekens."
SleutelformaatGeen vierkante haken"Metadata sleutel \"items[0]\" mag geen vierkante haken ([ of ]) bevatten."
Waardelengte500 tekens"Metadata waarde voor sleutel \"description\" overschrijdt de limiet van 500 tekens."
WaardetypeAlleen strings"Metadata waarde voor sleutel \"count\" moet een string zijn. Object ontvangen."
Type Coercion: Nummers en booleans worden automatisch omgezet naar strings.
  • 42 → "42"
  • true → "true"
  • 3.14 → "3.14"
Objecten en arrays worden afgewezen.

​
Metadata bijwerken (PATCH)

Momenteel beschikbaar voor: Alleen Batches.Crawls, Scrapes, Maps en Antwoorden ondersteunen nog niet het bijwerken van metadata na creatie.
Je kunt metadata bijwerken op bestaande batches met behulp van het PATCH eindpunt. Updates gebruiken merge-gedrag.

​
Update Operaties

Nieuwe sleutels worden toegevoegd terwijl bestaande behouden blijven.
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"}}'
Voor: {"project": "alpha"}
Na: {"project": "alpha", "new_key": "new_value"}
Bestaande sleutels worden overschreven met nieuwe waarden.
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"}}'
Voor: {"project": "alpha", "priority": "high"}
Na: {"project": "beta", "priority": "high"}
Stel een sleutel in op null of "" (lege string) om deze te verwijderen.
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}}'
Voor: {"project": "alpha", "priority": "high"}
Na: {"project": "alpha"}
Stel het gehele metadata veld in op null of "" om alle sleutels te verwijderen.
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": null}'
Voor: {"project": "alpha", "priority": "high"}
Na: {}
Voeg toe, werk bij en verwijder sleutels in één verzoek.
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}}'
Voor: {"project": "alpha", "old_field": "remove_me"}
Na: {"project": "gamma", "new_field": "value"}

​
PATCH Gedragsoverzicht

OperatieVerzoekResultaat
Sleutel toevoegen{"metadata": {"new": "value"}}Sleutel toegevoegd, anderen behouden
Sleutel bijwerken{"metadata": {"existing": "new_value"}}Sleutel bijgewerkt, anderen behouden
Sleutel verwijderen{"metadata": {"key": null}}Sleutel verwijderd, anderen behouden
Sleutel verwijderen{"metadata": {"key": ""}}Sleutel verwijderd, anderen behouden
Alles wissen{"metadata": null}Alle sleutels verwijderd
Alles wissen{"metadata": ""}Alle sleutels verwijderd
Geen actie{"metadata": {}}Geen wijzigingen