Skip to main content
POST
Paste your dgql_ key into Authorization, choose an example in the request panel, and press Send. Every query goes to the same endpoint; the body’s query says what to read.
  • Your key goes only to the API. Your browser sends the request straight to the API host; developers.drpn.ai never receives the key. The browser remembers it for this site, so on a shared computer clear the Authorization field when you finish.
  • Pick the host. Hosted Darpan is https://api.drpn.ai. For your own instance, choose Self-hosted Darpan and enter its backend host; it must list https://developers.drpn.ai in webapp_public_api_origins.
  • Start with Check your key. It works on every tenant. The other examples name an audit (month-close), a date and a finding id (F-20790): replace them with ones from your tenant, or the answer is … was not found.
  • Write your own. Switch the body to JSON and edit query. Field names and types are in the reference; the full schema is at GET /rest/s1/graphql/sdl.
Something refused? See When it does not work.

Authorizations

Authorization
string
header
required

Your dgql_ API key. Your browser sends it straight to the host above; developers.drpn.ai never receives it. See Authentication.

Body

application/json
query
string
required

A GraphQL query document. Queries only: a mutation is rejected.

variables
object

Values for the variables the query declares, e.g. {"id": "F-20790"}.

operationName
string

Which operation to run when the document names more than one.

Response

200 - application/json

Every response is HTTP 200, a refused one too: read errors.

data
object | null

The fields you asked for. Absent when the query was refused before it ran.

errors
object[]

Present when something failed. Each has a message and, where Darpan sets one, extensions.code; see Errors.

extensions
object

cost: what the query cost and what is left in the key's bucket; see Cost and throttling.