Token Pricing#

Every authenticated API request consumes tokens. Token usage is tracked per identity and aggregated monthly. Only successful responses (2xx status codes) consume tokens — failed requests (4xx/5xx) are free.

Each response includes an X-Tokens-Consumed header indicating how many tokens were charged for that request.

HTTP/1.1 200 OK
X-Tokens-Consumed: 10
Content-Type: application/json
Token costs per endpoint are also displayed in the [API Reference](/docs/api/reference/) as badges next to each operation.

API Request Token Costs#

Case Management#

EndpointMethodTokens
/v1/casesPOST10
/v1/casesGET10
/v1/cases/{id}GET10
/v1/cases/{id}PUT10
/v1/cases/{id}DELETE5

SOAP Notes#

EndpointMethodTokens
/v1/cases/{id}/soap-notesGET10
/v1/cases/{id}/soap-notesPOST10
/v1/cases/{id}/soap-notes/{noteId}GET10
/v1/cases/{id}/soap-notes/{noteId}PUT10
/v1/cases/{id}/soap-notes/{noteId}DELETE5

Attachments#

EndpointMethodTokens
/v1/cases/attachmentsPOST10
/v1/cases/attachmentsGET5
/v1/cases/attachments/{attachmentId}GET5
/v1/cases/attachments/{attachmentId}PUT5
/v1/cases/attachments/{attachmentId}DELETE5

Reference Data#

EndpointMethodTokens
/v1/animal-typesGET5
/v1/breedsGET5
/v1/breeds/{breedId}GET5
/v1/diseasesGET5
/v1/diseases/{diseaseId}GET5
/v1/diseases/{diseaseId}/treatment-protocolsGET10
/v1/diseases/{diseaseId}/treatment-protocols/{id}/treatmentsGET10
/v1/drug-substancesGET5
/v1/drug-substances/{drugSubstanceId}GET5
/v1/drug-substances/{drugSubstanceId}/dosesGET5
/v1/symptomsGET5
/v1/symptom-type-categoriesGET5
/v1/geographical-areasGET5
/v1/sourcesGET5
/v1/sources/{sourceId}GET5

Background Processing Tokens#

In addition to per-request tokens, certain operations trigger background AI processing that consumes additional tokens. These are charged automatically and accumulated on the resource.

OperationTokensNotes
AI Extraction1,000Triggered automatically when a case is created or notes are updated. Includes sanitization and diagnosis calculation.
Attachment Processing1,000Per attachment. Triggered when an attachment is uploaded.
SOAP Note Generation500Per generation. Triggered by POST /cases/{id}/soap-notes.

Resource-Level Token Tracking#

Background processing tokens are tracked directly on the resource, making it easy for integrators to monitor per-case and per-attachment AI costs. Case and attachment response objects include a tokens_consumed field showing the total tokens consumed by background processing for that resource:

  • Case: Accumulates tokens from AI extraction (1,000 per extraction), re-extractions on edit, and SOAP note generation (500 each).
  • Attachment: Shows tokens consumed by attachment processing (1,000 per attachment).
{
  "id": "case-123",
  "status": "COMPLETED",
  "tokens_consumed": 1500,
  ...
}

Typical Session Estimate#

The following example shows a typical case session with one edit and a SOAP note generation:

  1. POST /v1/cases (create) — 10 tokens
  2. AI Extraction (automatic) — 1,000 tokens
  3. User edits freetext — PUT /v1/cases/{id}10 tokens
  4. AI Re-extraction (automatic) — 1,000 tokens
  5. SOAP note generation — POST /v1/cases/{id}/soap-notes10 tokens (API) + 500 tokens (generation)
  6. Reference data lookups (~30 requests) — ~175 tokens
CategoryTokens
Case CRUD~30
AI Processing (x2)~2,000
SOAP Note Generation~500
Reference Data (~30 requests)~175
Total~2,705

Purchasing Tokens#

Tokens can be purchased in packages. Contact us to discuss your needs and arrange a token package.