Query

Execute Cypher Statement

Cypher over the graph (LadybugDB). Main graphs are read-only — use the staging pipeline to ingest data. Subgraphs support full writes. Always use parameterized queries (parameters: {"key": "val"}) to prevent injection. Response modes: auto (default), sync, async, stream. Under load, queries are queued and emit an operation_id for SSE monitoring at /v1/operations/{id}/stream.

post/v1/graphs/{graph_id}/query/cypher

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}/query/cypher
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Query parameters

mode'auto' | 'sync' | 'async' | 'stream'

Response modes for execution.

Response mode override

chunk_sizeinteger nullable

Rows per chunk for streaming

test_modeboolean

Enable test mode for better debugging

Request body

querystring required

The Cypher query to execute. Use parameters ($param_name) for all dynamic values to prevent injection attacks.

parametersobject nullable

Query parameters for safe value substitution. ALWAYS use parameters instead of string interpolation.

timeoutinteger nullable

Query timeout in seconds (1-300)

Example request

{
  "parameters": {
    "entity_type": "Company",
    "limit": 100
  },
  "query": "MATCH (n:Entity {type: $entity_type}) RETURN n LIMIT $limit",
  "timeout": 60
}

Response

Successful Response

unknown required

Changes

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