Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.esheria.ai/llms.txt

Use this file to discover all available pages before exploring further.

Protected endpoints require an API key in the x-api-key header. 
x-api-key: YOUR_ESHERIA_API_KEY
GET /healthz and GET /readyz are operational endpoints. Regulatory pack endpoints under /api/v1 require authentication.

​
Mutating Requests

All mutating requests require an idempotency key. This applies to POST workflows such as claim verification, applicability checks, and graph applicability checks. 
idempotency-key: unique-request-intent
Use a stable key for a single request intent. Reusing the same key with the same payload allows replay protection; reusing it with a different payload returns a conflict.

​
Trace IDs

Every response includes a trace_id. 
{
  "status": "ok",
  "data": {},
  "errors": [],
  "trace_id": "bdf7825f-..."
}
Store trace_id with user-visible decisions, support tickets, and agent outputs. It is the fastest way to connect a downstream answer to the API request that produced it.

​
Example

curl --compressed -sS -X POST \
  "$ESHERIA_API_BASE_URL/api/v1/domain-packs/KE-DATA-PROTECTION/applicability-check" \
  -H "content-type: application/json" \
  -H "x-api-key: $ESHERIA_API_KEY" \
  -H "idempotency-key: applicability-$(date +%s)" \
  -d '{
    "entity_roles": ["data_controller"],
    "activities": ["personal_data_processing"],
    "sector_tags": ["financial_services"],
    "limit": 5
  }' | jq

​
Failure Modes

CodeMeaningAction
unauthorizedThe API key is missing or invalidCheck the header and rotate any exposed key
idempotency_key_requiredA mutating request was sent without idempotency-keyGenerate a unique key for the request intent
idempotency_key_conflictThe same key was reused with a different payloadUse a new key or replay the original payload
validation_errorRequest fields did not match the API schemaCompare the payload with the API Reference
Do not put API keys in docs, repositories, browser screenshots, support tickets, or agent transcripts.