Browse the API reference

Materialize Graph

post/v1/graphs/{graph_id}/operations/materialize

Part of Graph Operations.

Rebuilds LadybugDB from staging tables (file uploads) or extensions OLTP data. Set dry_run=true to preview without changes.

Idempotency: supply an Idempotency-Key header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
graph_idrequiredstringGraph Id

Header parameters

NameTypeDescription
Idempotency-KeyoptionalstringIdempotency-Key

Request body

Required, application/json.

FieldTypeDescription
forceoptionalboolean

Force materialization even if already up to date

Default: false

rebuildoptionalboolean

Rebuild the graph from scratch, dropping existing data. Required (staged source) when materializing new uploads into a graph that already contains materialized data — staging replays all uploaded files, so a non-rebuild pass would re-copy ingested rows (409).

Default: false

dry_runoptionalboolean

Validate tables without writing to the graph

Default: false

sourceoptionalstring

Materialization source: 'extensions' for OLTP, omit for DuckDB staging tables

materialize_embeddingsoptionalboolean

Generate vector embeddings during materialization

Default: false

Example request

curl
curl -X POST "https://api.robosystems.ai/v1/graphs/{graph_id}/operations/materialize" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "force": false,
  "rebuild": false,
  "dry_run": false,
  "source": "string",
  "materialize_embeddings": false
}'

Responses

202 Successful Response

FieldTypeDescription
operationrequiredstring

Kebab-case operation name

operationIdrequiredstring

op_-prefixed ULID for audit and SSE correlation

statusrequiredstring

Operation lifecycle state

One of: completed, pending, failed

resultoptionalany

Command-specific result payload

atrequiredstring

ISO-8601 UTC timestamp

createdByoptionalstring

User ID that initiated the operation (null for legacy callers)

idempotentReplayoptionalboolean

True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

Default: false

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
409Idempotency-Key conflict — key reused with different body
422Validation error
429Rate limit exceeded
500Internal server error