Skip to main content

SDKs & APIs

Arcane provides official SDKs and a REST API for programmatic access. Use them to integrate Arcane into your pipelines, automation, and custom tooling.

SDKs​

SDKPackageDescription
Pythonarcane-sdk (PyPI)For Python applications. Sync and async clients.
Node.jsarcane-sdk (npm)For Node.js and TypeScript. ESM and CommonJS.

Both SDKs wrap the Arcane public API and support:

  • Prompts — List, get, list versions
  • Datasources — List configured datasources
  • Traces — Search, get trace, attribute names/values
  • Datasets — List, get, paginated rows, add row
  • Entities — List, get
  • Evaluations — List, get, create, experiment scores
  • Experiments — List, get, create, results (paginated)

Public API​

The Arcane backend exposes a REST API. Authenticate with a project-scoped API key (create one under Project → API Keys in the UI).

  • Base path — /v1/organisations/:organisationId/projects/:projectId/...
  • Authentication — HTTP Basic Auth with username api-key and the API key as password, or ApiKey <key> in the Authorization header

See Public API reference for details.