Deprecated

API v1 is deprecated. It keeps working for existing integrations but gets no new features. New integrations should use API v2: start with the v2 quickstart or browse the v2 reference.

API key

View as Markdown

Check that an API key works and which account it belongs to.

Endpoints

The API key status object

Attributes

  • server_runningboolean

    Always true when you receive a 200 - confirms the server is reachable.

  • api_keyvalue

    Identity and activation status of the key used to authenticate this request.

  • rate_limitvalue

    Current rate-limit counters for this key. Use remaining and reset_at to throttle your integration proactively.

The API key status object
{
  ,
  ,
  
}

API key health check

GET/v1/me

Credentials
Any active API key.
For
Designers
Operation id
v1_getMe

Returns server status, API key identity, and current rate-limit counters for the authenticated key. Call this to confirm connectivity and check how many requests remain before the limit resets.

Returns200 OK

API key is valid and the server is reachable. Returns the API key status object.

Responses

  • 200

    API key is valid and the server is reachable.

  • 401

    API key is missing, invalid, or inactive.

  • 429

    Rate limit exceeded - wait until the window resets before retrying.

Errors use the v1 error body.

GET/v1/me
curl "https://public-api.dapi.digital/v1/me" \
  -H "x-api-key: $DAPI_API_KEY"
Response
{
  "server_running": true,
  "api_key": null,
  "rate_limit": null
}