Browse the API reference

Delete Graph

post/v1/graphs/{graph_id}/operations/delete-graph

Part of Graph Operations.

Permanently destroys a user graph and cancels its subscription. Two modes via the at_period_end body flag: omit it (or pass false) to tear down immediately (~10 min); pass true to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. Requires confirm to equal the URL graph_id. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.

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
confirmrequiredstring

Must equal the graph_id in the URL — confirms the caller intends to destroy this specific graph.

at_period_endoptionalboolean

If true, defer cancellation and teardown to the end of the current billing period (graph stays usable until then). If false (default), cancel and tear down immediately.

Default: false

Example request

curl
curl -X POST "https://api.robosystems.ai/v1/graphs/{graph_id}/operations/delete-graph" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "confirm": "string"
}'

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