Skip to main content
POST
/
export
/
api-keys
Export API key usage data
curl --request POST \
  --url https://api.langdock.com/export/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": {
    "date": "2024-01-01T00:00:00.000Z",
    "timezone": "UTC"
  },
  "to": {
    "date": "2024-01-31T23:59:59.999Z",
    "timezone": "UTC"
  },
  "group_by": "model"
}
'
{
  "success": true,
  "data": {
    "filePath": "agents-usage/workspace-id/agents-usage-2024-01-01-2024-01-31-abc12345.csv",
    "downloadUrl": "https://storage.example.com/signed-url",
    "dataType": "assistants",
    "recordCount": 1250,
    "dateRange": {
      "from": "2024-01-01T00:00:00.000Z",
      "to": "2024-01-31T23:59:59.999Z"
    }
  }
}
This endpoint exports API usage grouped by API key for the selected period.
Using a dedicated deployment?Replace api.langdock.com with <your-deployment>/api/public in all requests.
For details on prerequisites and rate limits, please refer to the main Usage Export API documentation.
Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on API Key Best Practices.

Data Included

By default, the API key export returns one row per API key.
ColumnDescription
period_startStart date of the report
period_endEnd date of the report
org_idID of the workspace
api_key_idID of the API key
api_key_nameName of the API key
requestsNumber of API requests
total_cost_usdAPI usage cost in USD

Additional Columns for BYOK Workspaces

ColumnDescription
sum_prompt_tokensTotal input tokens
sum_completion_tokensTotal output tokens
cached_prompt_tokensCache-read input tokens
cache_creation_tokensCache-write input tokens
no_cache_tokensInput tokens that were not served from cache

Grouped Export

Use group_by=model to return one row per API key and model.

Authorizations

Authorization
string
header
required

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Body

application/json

Request body for usage export endpoints

from
object
required

Start date and timezone for the export

to
object
required

End date and timezone for the export

group_by
enum<string>

Optional aggregation dimension.

Available options:
model

Response

Export successful

Successful response from usage export endpoints

success
boolean
required

Indicates if the export was successful

Example:

true

data
object
required

Export data information