REST API

Access your Connic project programmatically with API keys: query runs, manage retrieval, pull cost data, and manage deployments. To run agents in response to events, use a connector.

Overview

Connic exposes a REST API that lets you interact with your project outside of the dashboard. Use it to pull run results into external monitoring, manage your retrieval programmatically, and query cost data for billing dashboards.

All API requests are authenticated with project-scoped API keys and rate-limited per project. The full endpoint reference includes request and response schemas plus example requests. Open API endpoints.

Authentication

API requests are authenticated using API keys. Each key is scoped to a single project and can only access endpoints within that project. Pass the key as a Bearer token in the Authorization header:

Authorization: Bearer cnc_your_api_key

Create and manage API keys in Project Settings → API Keys & MCP Auth. Keys start with the cnc_ prefix and are shown only once when created. Store them securely.

API Key Permissions

Each API key uses the same action-level project permissions shown in Team & Permissions. Keep all available permissions selected or choose individual permissions, then edit that selection at any time.

Rate Limiting

API requests are rate-limited per project. All API keys belonging to the same project share the limit. When the limit is exceeded, the API responds with:

If you need higher limits, contact the Connic team.

Quick Examples

curl https://api.connic.co/v1/projects/{project_id}/runs/{run_id} \
  -H "Authorization: Bearer cnc_your_api_key"

curl -X POST "https://api.connic.co/v1/projects/{project_id}/retrieval/text?environment_id={env_id}" \
  -H "Authorization: Bearer cnc_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Your document text here...",
    "namespace": "docs.api",
    "entry_id": "my-custom-id"
  }'

Error Responses

The API uses standard HTTP status codes. Error responses include a JSON body with a detail field describing the issue.