Skip to main content

REST API Overview

Introduction​

Arcanna provides a comprehensive REST API that enables programmatic access to both input operations and management capabilities. The API is organized into two main categories:

  • Input Operations (/api/v1): Endpoints for sending data to Arcanna, retrieving decisions, and providing feedback to improve AI models
  • Management Operations (/api/v2): Endpoints for managing Arcanna resources such as integrations, use cases, and API tokens

Swagger UI​

The complete API documentation with interactive endpoints can be found at:

https://<your-arcanna.ai-url>/docs/exposer

API Organization​

Input Operations (/api/v1)​

These endpoints handle the core data processing flow:

  • Event ingestion and retrieval
  • Decision retrieval
  • Feedback submission
  • Use case information queries

Management Operations (/api/v2)​

These endpoints allow you to manage Arcanna resources:

  • Resource management (integrations, use cases, API tokens)
  • Metrics retrieval (job metrics, model metrics, platform health)

Authentication​

Both API categories use token-based authentication via the x-arcanna-api-key header.

To obtain an API token:

  • From the Arcanna UI: Navigate to Profile (top right) → API Keys
  • From Swagger UI: Use the /api/v2/token endpoint

For detailed authentication instructions, see the Authentication section.

Quick Start​

Input Operations Example​

# Send an event for decision
curl -X POST "https://api.arcanna.ai/api/v1/events/" \
  -H "Content-Type: application/json" \
  -H "x-arcanna-api-key: your-api-key-here" \
  -d '{
    "job_id": 123,
    "raw_body": {
      "example_field": "example_value"
    }
  }'

Management Operations Example​

# List all integrations
curl -X GET "https://api.arcanna.ai/api/v2/integrations" \
  -H "x-arcanna-api-key: your-api-key-here"

Next Steps​