Content Operations

Index a 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.

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

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/v1/graphs/{graph_id}/operations/index-document
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Headers

Idempotency-Keystring nullable

Request body

document_idstring nullable

Present → update that document; absent → create a new one

titlestring nullable

Required when creating

contentstring nullable

Required when creating

tagsstring[] nullable

Optional labels

folderstring nullable

Optional folder

external_idstring nullable

Upsert key (create): re-indexing the same id replaces

Response

Successful Response

operationstring required

Kebab-case operation name

operationIdstring required

op_-prefixed ULID for audit and SSE correlation

status'completed' | 'pending' | 'failed' required

Operation lifecycle state

resultunknown
atstring required

ISO-8601 UTC timestamp

createdBystring nullable

User ID that initiated the operation

idempotentReplayboolean

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

Changes

No recorded changes to this operation across all 1 revision of this API.