Skip to content
nexdoc.design Docs

Auth API

Create and manage API keys, inspect the current identity, and authenticate every NexDoc Design REST request.

Create keys in the dashboard. Default scopes: files:rw, jobs:rw, runs:rw.

GET/v1/auth/me

code
{
  "user_id": "user_...",
  "org_id": "org_...",
  "email": "you@company.com",
  "name": "You",
  "scopes": ["files:rw", "jobs:rw", "runs:rw"]
}

GET/v1/auth/keys

code
{
  "data": [
    {
      "key_id": "key_...",
      "name": "Default Key",
      "secret_prefix": "nxd_live_abcd",
      "created_at": "..."
    }
  ]
}

POST/v1/auth/keys

Body: { "name": "CI" }

code
{ "key_id": "key_...", "secret_key": "nxd_live_..." }

The secret_key is shown once. Do not create or revoke keys unless you intend to.

DELETE/v1/auth/keys/{key_id}

code
{ "key_id": "key_...", "revoked": true }