Update Graph Metadata

post/v1/graphs/{graph_id}/operations/update-graph-metadata

Edit the graph's platform-level label: display name, description, and tags. Partial — only supplied (non-null) fields change; pass "" to clear the description and [] to clear the tags. Requires admin on the graph. This is not the entity name that appears on financial statements — change that through the roboledger update-entity operation.

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
`graph_name`optional	string	New display name. Omit to leave unchanged; cannot be cleared.
`description`optional	string	New description. Omit to leave unchanged; pass '' to clear.
`tags`optional	string[]	Replaces the full tag list (not a merge). Omit to leave unchanged; pass [] to clear. Tags are trimmed, de-duplicated, and capped at 50 characters each.

Example request

curl

curl -X POST "https://api.robosystems.ai/v1/graphs/{graph_id}/operations/update-graph-metadata" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "graph_name": "Acme Consulting LLC"
}'

Responses

200 Successful Response

Field Type Description

operationrequired

string

Kebab-case operation name

operationIdrequired

string

op_-prefixed ULID for audit and SSE correlation

statusrequired

string

Operation lifecycle state

One of: completed, pending, failed

resultoptional

GraphMetadataResult

Command-specific result payload

GraphMetadataResult fields

Field	Type	Description
`graph_id`required	string	Graph the metadata belongs to
`graph_name`required	string	Display name after the update
`description`optional	string	Description after the update ('' when unset) Default:
`tags`optional	string[]	Tags after the update (empty when unset)
`updated_fields`optional	string[]	Fields this call actually changed. Empty when the submitted values already matched what was stored.

atrequired

string

ISO-8601 UTC timestamp

createdByoptional

string

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

idempotentReplayoptional

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