Guide / API & AI Agents
API Keys and Swagger Documentation
Creating personal access tokens and exploring interactive API documentation.
Corexar offers a comprehensive REST API to query, create, and update collections, cards, and relations.
Interactive Swagger UI
Visit /api-docs/swagger to inspect all API routes and execute test requests live from your browser.
API Key Management
Generate personal access tokens prefixed with cxk_ in user profile or admin panels. Keys inherit your user role permissions.
| Access Scope | Capabilities | Recommended For |
|---|---|---|
| Full Access | Read, create, edit, and delete items | CI/CD pipelines and trusted autonomous agents |
| Read Only | Search and retrieve items without mutation rights | Audit and reporting scripts |
| Selective | Constrained to specific designated collections | External webhooks and third-party integrations |
Tip. Never commit API keys to public repositories. Revoke compromised keys immediately in the security panel.