Skip to content

API Reference

https://api.opentusk.ai

For local development:

http://localhost:8000

All authenticated endpoints require a Bearer token in the Authorization header:

Terminal window
Authorization: Bearer tdp_your_api_key

See Authentication for details on API keys and other auth methods.

  • Request bodies use JSON (Content-Type: application/json)
  • File uploads use presigned URLs (not multipart form data)

All errors return a JSON object with an error field:

{
"error": "Vault not found"
}
CodeMeaning
200Success
201Created
400Bad request — invalid input or validation error
401Unauthorized — missing or invalid auth
403Forbidden — valid auth but insufficient permissions
404Not found
409Conflict — duplicate resource
429Rate limited
500Internal server error

List endpoints support cursor-based pagination:

ParameterTypeDescription
limitnumberItems per page (default: 50, max: 100)
cursorstringCursor from previous response for next page
sortBystringField to sort by (e.g., createdAt, name)
orderstringasc or desc

Response includes a nextCursor field when more results are available:

{
"files": [],
"nextCursor": "eyJpZCI6Ij..."
}

Rate limits vary by plan tier:

PlanUploads/minDownloads/min
Free520
Developer30100
Scale100500
Enterprise3002,000

When rate limited, the API returns 429 Too Many Requests.