REST API
Access your Connic project programmatically with API keys. Trigger agents, query runs, manage knowledge, and pull cost data from your own applications or CI/CD pipelines.
Overview
Connic exposes a REST API that lets you interact with your project outside of the dashboard. Use it to trigger agent runs from your backend, pull run results into external monitoring, manage your knowledge base programmatically, or query cost data for billing dashboards.
All API requests are authenticated with project-scoped API keys and rate-limited per project. The full interactive reference with request/response schemas and a built-in client is available at the API Reference .
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_keyCreate and manage API keys in Project Settings → CLI / API Keys. Keys start with the cnc_ prefix and are shown only once when created. Store them securely.
Security
Never commit API keys to version control or expose them in client-side code. For CI/CD, store them as encrypted secrets (e.g. CONNIC_API_KEY).
API Key Permissions
Each API key can be configured with granular permissions that control which API sections it can access and whether it can read, write, or both. Permissions are set when creating a key and displayed in the key list.
Permission Model
When creating a key, disable the Full Access toggle to reveal the permission picker. For each API section, you can grant read access, write access, or both.
| Concept | Details |
|---|---|
| Sections | Each section maps to a group of endpoints: agents, runs, knowledge, judges, budgets, audit-logs, deployments. |
| Read | Allows GET requests within the section. |
| Write | Allows POST PUT PATCH DELETE requests within the section. |
| All sections (*) | Check the All sections row in the permission picker to grant access across all current and future endpoint groups. |
| Full Access | Keys created with the Full Access toggle have no permission restrictions. This is the default. |
API key permissions are separate from team roles. Team roles control what members can do in the dashboard, while API key permissions control what programmatic requests are allowed.
Rate Limiting
API requests are rate-limited to 60 requests per minute per project. All API keys belonging to the same project share a single rate limit bucket. When the limit is exceeded, the API responds with:
| Response | Details |
|---|---|
| Status Code | 429 Too Many Requests |
| Retry-After Header | Number of seconds to wait before retrying |
If you need higher limits, contact the Connic team.
Quick Examples
Trigger an Agent
curl -X POST https://api.connic.co/v1/projects/{project_id}/agents/{agent_name}/trigger \
-H "Authorization: Bearer cnc_your_api_key" \
-H "Content-Type: application/json" \
-d '{"message": "Summarize the latest sales report"}'Get Run Details
curl https://api.connic.co/v1/projects/{project_id}/runs/{run_id} \
-H "Authorization: Bearer cnc_your_api_key"Upload Text to Knowledge Base
Knowledge endpoints require an environment_id query parameter to scope the request to a specific environment.
curl -X POST "https://api.connic.co/v1/projects/{project_id}/knowledge/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.
| Code | Meaning |
|---|---|
| 401 | Missing or invalid API key |
| 403 | Key lacks permission for this endpoint, or the endpoint is not part of the public API |
| 404 | Resource not found |
| 429 | Rate limit exceeded. Check the Retry-After header. |
| 500 | Internal server error |
Interactive API Reference
Explore all endpoints with full request/response schemas and example code snippets.
Open API Reference