API Reference

Every endpoint in the Adeli REST API has its own page here: what it does, the parameters it takes, a request you can copy in cURL, JavaScript, or Python, and the responses it returns. For how the API fits together, start with the Overview.

Base URL

All endpoints live under /api/v1, and every response is JSON.

https://app.tryadeli.com/api/v1

Authentication

Every request carries your API key as a bearer token. Keys are created in the dashboard and belong to your organization; see Authentication.

Authorization: Bearer rk_live_...

The examples on these pages read the key from an environment variable:

export ADELI_API_KEY='rk_live_...'

Errors

Every failure returns the same envelope, with a stable code to branch on and a message for humans. Errors lists every status and code.

{
  "error": {
    "code": "profile_not_found",
    "message": "Profile not found"
  }
}

OpenAPI

The whole API is described as an OpenAPI 3.1 document at /docs/openapi.json. Import it into Postman or Insomnia, or generate a client from it.

Resources