Skip to main content

Public API reference

The Arcane backend exposes a REST API for programmatic access. Use the official Python or Node.js SDK for the simplest integration, or call the API directly.

Base URL and paths​

All public API endpoints are scoped to an organisation and project:

https://your-arcane-instance.example.com/v1/organisations/{organisationId}/projects/{projectId}/...

Replace organisationId and projectId with the IDs from your Arcane instance (visible in the UI URL when viewing a project).

Authentication​

Use a project-scoped API key. Create one in the Arcane UI under Project → API Keys.

HTTP Basic Auth​

Username: api-key
Password: your API key

curl -u "api-key:YOUR_API_KEY" \
  "https://your-instance.example.com/v1/organisations/org-123/projects/proj-456/prompts"

Authorization header​

Authorization: ApiKey YOUR_API_KEY

OpenAPI spec​

A pre-saved OpenAPI specification is available for the public API:

  • openapi.yaml — Download or reference in Swagger Editor, Postman, OpenAPI Generator, etc.

API areas​

The public API covers:

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