GraphQL

GraphQL explorer (development only)

Serves the in-browser GraphiQL explorer on deployments that enable it, which is development only — it is not mounted on the hosted API. Run queries with POST to the same URL.

Queries are scoped by the URL: graph_id is a path parameter and never a query argument, so a document cannot name a graph that disagrees with the path it was sent to. Reads hit the operational (OLTP) extensions database, so they reflect the books as they stand now; the analytical projection is Cypher at POST /v1/graphs/{graph_id}/query/cypher.

The schema is composed per deployment: ledger fields require RoboLedger and investor fields require RoboInvestor, and a disabled domain is absent from introspection rather than failing at runtime. Every field carries a description, so introspection is the authoritative, deployment-specific reference.

Auth: pass X-API-Key (or a JWT Authorization: Bearer header). Unauthenticated introspection queries are deliberately allowed for SDK codegen; data queries require credentials and raise UNAUTHENTICATED.

Error codes: LEDGER_NOT_INITIALIZED, INVESTOR_NOT_INITIALIZED, and UNAUTHENTICATED surface in the GraphQL errors[].extensions.code field. GraphQL reports errors with HTTP 200 and a populated errors[], so check that array rather than the status code.

get/extensions/{graph_id}/graphql

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/extensions/{graph_id}/graphql
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Response

The GraphiQL integrated development environment.

unknown required

Changes

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