CAI APIAPI Reference

Quickstart

This guide creates a project, uploads a file, and retrieves results.

Before you start 

export CAI_BASE_URL="https://your-api-host"
export CAI_TOKEN="your-token"

To request an API token, email [email protected].

1. Create a project 

curl -X POST "$CAI_BASE_URL/api/v1/projects/" \
  -H "Authorization: Bearer $CAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Carbon Accounting",
    "description": "Demo project"
  }'

Set the project_id from the response:

export CAI_PROJECT_ID="your-project-uuid"

2. Upload files

Upload one or more files with multipart form data.

curl -X POST "$CAI_BASE_URL/api/v1/documents/upload?project_id=$CAI_PROJECT_ID" \
  -H "Authorization: Bearer $CAI_TOKEN" \
  -F "files=@/path/to/invoice.pdf" \
  -F "files=@/path/to/data.xlsx"

The response includes file_key values and may include a task_id for each file.

3. Check processing status (optional)

If a task_id is returned, use it to check job status.

curl -H "Authorization: Bearer $CAI_TOKEN" \
  "$CAI_BASE_URL/api/v1/job/$TASK_ID/status"

4. Fetch results

List classifications and measurements once processing completes.

curl -H "Authorization: Bearer $CAI_TOKEN" \
  "$CAI_BASE_URL/api/v1/classifications/?project_id=$CAI_PROJECT_ID"

curl -H "Authorization: Bearer $CAI_TOKEN" \
  "$CAI_BASE_URL/api/v2/measurements/?project_id=$CAI_PROJECT_ID"

Use the API Reference tab for full request and response schemas.