Index a Document

post/v1/graphs/{graph_id}/operations/index-document

Create a document (omit document_id) or update one (provide it). Stored in PostgreSQL, synced to OpenSearch for search.

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

Name	Type	Description
`graph_id`required	string	Graph Id

Header parameters

Name	Type	Description
`Idempotency-Key`optional	string	Idempotency-Key

Request body

Required, application/json.

Field	Type	Description
`document_id`optional	string	Present → update that document; absent → create a new one
`title`optional	string	Required when creating
`content`optional	string	Required when creating
`tags`optional	string[]	Optional labels
`folder`optional	string	Optional folder
`external_id`optional	string	Upsert key (create): re-indexing the same id replaces

Example request

curl

curl -X POST "https://api.robosystems.ai/v1/graphs/{graph_id}/operations/index-document" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "document_id": "string",
  "title": "string",
  "content": "string",
  "tags": [
    "string"
  ],
  "folder": "string",
  "external_id": "string"
}'

Responses

200 Successful Response

Field	Type	Description
`operation`required	string	Kebab-case operation name
`operationId`required	string	op_-prefixed ULID for audit and SSE correlation
`status`required	string	Operation lifecycle state One of: `completed`, `pending`, `failed`
`result`optional	any	Command-specific result payload
`at`required	string	ISO-8601 UTC timestamp
`createdBy`optional	string	User ID that initiated the operation (null for legacy callers)
`idempotentReplay`optional	boolean	True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions. Default: `false`

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