Dashboard

API Reference

The Tracore API is a RESTful JSON API for document parsing and structured data extraction.

API version: 0.5.0

Base URL

https://api.tracore.io

Authentication

All requests require an API key passed in the x-api-key header:

curl https://api.tracore.io/workspaces \
  -H "x-api-key: dsk_your_api_key_here"

See Authentication for details on creating and managing API keys.

OpenAPI specification

This reference is generated from the Tracore OpenAPI 3.1 spec (version 0.5.0). Download it to generate your own client or import it into tooling:

Spec releases are published per version at tracore-io/openapi.

Compatibility

Use the latest SDK; it tracks the current API. The API evolves additively — new fields and endpoints are added rather than removed or renamed. SDK minor and patch upgrades are always safe; a major version bump signals a breaking API change, so check the SDK’s migration guide before upgrading across a major. Endpoints scheduled for removal are marked @deprecated in the generated SDKs ahead of time.

Response format

All responses return JSON. Successful single-resource responses return the resource object directly. List endpoints return a paginated envelope:

{
  "total": 42,
  "page": 1,
  "pageSize": 20,
  "data": [
    // array of resources
  ]
}

Environment scoping

Documents, runs, and webhooks are scoped to an environment. Pass the env query parameter to target a specific environment:

GET /workspaces/my-workspace/schemas/invoice/documents?env=staging

Valid values are production, staging, and development. If omitted, the environment defaults to production.

Schemas are workspace-scoped and shared across all environments — they do not use the env parameter.

Content types

  • Request bodies: application/json for most endpoints, multipart/form-data for file uploads.
  • Response bodies: application/json for all endpoints except document downloads.