Export Model Usage

API endpoint to export AI model usage data including request counts and BYOK token consumption

POST /export/models

Export model usage data

cURL

curl --request POST \
  --url https://api.langdock.com/export/models \
  --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"
  }
}
'

import requests

url = "https://api.langdock.com/export/models"

payload = {
    "from": {
        "date": "2024-01-01T00:00:00.000Z",
        "timezone": "UTC"
    },
    "to": {
        "date": "2024-01-31T23:59:59.999Z",
        "timezone": "UTC"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from: {date: '2024-01-01T00:00:00.000Z', timezone: 'UTC'},
    to: {date: '2024-01-31T23:59:59.999Z', timezone: 'UTC'}
  })
};

fetch('https://api.langdock.com/export/models', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.langdock.com/export/models",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'from' => [
        'date' => '2024-01-01T00:00:00.000Z',
        'timezone' => 'UTC'
    ],
    'to' => [
        'date' => '2024-01-31T23:59:59.999Z',
        'timezone' => 'UTC'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.langdock.com/export/models"

	payload := strings.NewReader("{\n  \"from\": {\n    \"date\": \"2024-01-01T00:00:00.000Z\",\n    \"timezone\": \"UTC\"\n  },\n  \"to\": {\n    \"date\": \"2024-01-31T23:59:59.999Z\",\n    \"timezone\": \"UTC\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.langdock.com/export/models")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": {\n    \"date\": \"2024-01-01T00:00:00.000Z\",\n    \"timezone\": \"UTC\"\n  },\n  \"to\": {\n    \"date\": \"2024-01-31T23:59:59.999Z\",\n    \"timezone\": \"UTC\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.langdock.com/export/models")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from\": {\n    \"date\": \"2024-01-01T00:00:00.000Z\",\n    \"timezone\": \"UTC\"\n  },\n  \"to\": {\n    \"date\": \"2024-01-31T23:59:59.999Z\",\n    \"timezone\": \"UTC\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "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"
    }
  }
}

{
  "error": "No data found",
  "message": "No usage data found for the selected period"
}

{
  "error": "No data found",
  "message": "No usage data found for the selected period"
}

{
  "error": "No data found",
  "message": "No usage data found 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.

This endpoint exports AI model usage data, including request counts per model.

Data Included

By default, the model export returns one row per normalized model name, provider, and BYOK state.

Column	Description
period_start	Start date of the report
period_end	End date of the report
org_id	ID of the workspace
name	Normalized model name
provider	Model provider
bring_your_keys	Whether usage came from a BYOK model
requests	Number of requests

Additional Columns for BYOK Workspaces

Column	Description
sum_prompt_tokens	Total input tokens
sum_completion_tokens	Total output tokens
sum_cached_prompt_tokens	Cache-read input tokens
sum_cache_creation_tokens	Cache-write input tokens
no_cache_tokens	Input tokens that were not served from cache
total_cost_usd	Estimated provider cost in USD

Because BYOK workspaces supply their own model keys, Langdock can provide you with an export of your token consumption data.

Grouped Export

Use group_by=source to return one row per model and source, such as WEB or MOBILE.

BYOK workspaces can also use group_by=deployment to return one row per model and deployment.

Usage Analysis

With this export you can:

• Calculate costs using your provider’s pricing
• Identify which models receive the most requests
• Track usage trends over time
• Optimize model selection for different use cases

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

Show child attributes

to · object · required

End date and timezone for the export

Show child attributes

group_by · enum<string>

Optional aggregation dimension. deployment is only available for BYOK workspaces.

Available options: source, deployment

Response

200

application/json

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

Show child attributes