Authentication

How tokens are sent, where they come from, and what happens when one is missing.

Bearer tokens#

Every request authenticates with an API key in the standard OpenAI-style header:

httpPOST /v1/tasks HTTP/1.1
Host: api.example.com
Authorization: Bearer sk-xxxxxxxxxxxxxxxx
Content-Type: application/json

In the clients#

Each generated client takes the token once, at construction, instead of on every call.

tsconst client = new DexaAiSdkClient({ baseUrl, token });

pythonclient = DexaAiSdk(base_url=base_url, token=token)

rubyclient = DexaAiSdk.new(base_url: base_url, token: token)

rustlet client = DexaAiSdk::builder().token(token).build()?;

javavar client = DexaAiSdkClient.builder().token(token).build();

csharpvar client = new DexaAiSdkClient(new DexaAiSdkClientOptions { Token = token });

Keep the token in an environment variable or your platform's secret store. Never commit it, and never put it in a URL, since URLs end up in logs.

bashexport DEXA_TOKEN="sk-..."

Failures#

A missing or invalid key is rejected before any model runs, so a bad key costs nothing.

json{
  "error": {
    "type": "authentication_error",
    "message": "Invalid API key provided",
    "code": "invalid_api_key"
  }
}

The body always has the same shape, whatever went wrong. See errors.