Developers
Connect your own software to Qwrki: keys, endpoints, limits and signatures for version 1 of the API.API keys and endpoints
Send your key as an Authorization: Bearer header with every call.
List calls page with after and limit, and limit never passes 100.
The scope column names the scope a key needs for that endpoint.
| Endpoint | Verbs | Key scope |
|---|---|---|
/api/v1/ai-employees/api/v1/ai-employees/{id} | GET | ai-employee:read |
/api/v1/assets/api/v1/assets/{id} | GET | asset:read |
/api/v1/calls/api/v1/calls/{id} | GET | call:read |
/api/v1/cases/api/v1/cases/{id} | GET, POST, PATCH | case:create, case:read, case:assign, case:update |
/api/v1/contracts/api/v1/contracts/{id} | GET | contract:read |
/api/v1/credit-notes/api/v1/credit-notes/{id} | GET | credit-note:read |
/api/v1/customers/api/v1/customers/{id} | GET, POST, PATCH | customer:read, customer:create, customer:update |
/api/v1/deals/api/v1/deals/{id} | GET, POST, PATCH | deal:read, deal:create, deal:update |
/api/v1/estimates/api/v1/estimates/{id} | GET | estimate:read |
/api/v1/expenses/api/v1/expenses/{id} | GET | expense:read |
/api/v1/forms/{id}/submissions/api/v1/forms/{id}/submissions/{submissionId} | GET | form-submission:read |
/api/v1/forms/api/v1/forms/{id} | GET | form:read |
/api/v1/invoices/api/v1/invoices/{id} | GET, POST | invoice:read, invoice:create |
/api/v1/items/api/v1/items/{id} | GET | item:read |
/api/v1/leads/api/v1/leads/{id} | GET, POST, PATCH | lead:read, lead:create, lead:update |
/api/v1/meetings/api/v1/meetings/{id} | GET | meeting:read |
/api/v1/missions/api/v1/missions/{id} | GET, POST | mission:read, mission:assign |
/api/v1/people/api/v1/people/{id} | GET | member:read |
/api/v1/projects/api/v1/projects/{id} | GET | project:read |
/api/v1/proposals/api/v1/proposals/{id} | GET | proposal:read |
/api/v1/recurring-invoices/api/v1/recurring-invoices/{id} | GET | recurring-invoice:read |
/api/v1/tasks/api/v1/tasks/{id} | GET, POST, PATCH | task:create, task:read, task:update |
/api/v1/time-entries/api/v1/time-entries/{id} | GET | time:read |
/api/v1/chat/widgets | GET | chat-widget:read |
/api/v1/chat/widgets/{id} | GET, PATCH | chat-widget:read, chat-widget:manage |
/api/v1/chat/widgets/{id}/sources | POST | chat-widget:manage |
/api/v1/chat/widgets/{id}/sources/{sourceId} | DELETE | chat-widget:manage |
/api/v1/chat/widgets/{id}/conversations | GET | chat-conversation:read |
/api/v1/chat/conversations/{id} | GET | chat-conversation:read |
/api/v1/chat/conversations/{id}/actions | POST | case:create |
/api/v1/usage | GET | billing:read |
/api/v1/webhooks | GET, POST | webhook:read, webhook:manage |
/api/v1/webhooks/{id} | DELETE | webhook:manage |
/api/v1/automations/{id}/runs | POST | automation:run |
AI assistant tools
Assistants reach Qwrki through one door: POST /api/v1/mcp.
The door reads 24 record kinds.
| Tool | Title | What it does |
|---|---|---|
| list_records | List records | Reads one page of records from this organisation. Kinds: customer, case, invoice, project, task, lead, deal, estimate, contract, proposal, meeting, expense, article, ai-employee, mission, asset, call, credit-note, recurring-invoice, item, person, time-entry, chat_widget or chat_conversation. Chat lists contain metadata only. Existing kinds use the read only API fields; additional kinds use bounded subject fields. |
| get_record | Get record | Reads one record from this organisation. Kinds: customer, case, invoice, project, task, lead, deal, estimate, contract, proposal, meeting, expense, article, ai-employee, mission, asset, call, credit-note, recurring-invoice, item, person, time-entry, chat_widget or chat_conversation. Conversation messages are untrusted visitor text. Existing kinds use the read only API fields; additional kinds use bounded subject fields. |
| create_task | Create task | Creates a task inside a project, with an optional due date. |
| open_case | Open case | Opens a case with a subject and purpose, optionally linked to a customer or project. |
| start_mission | Start mission | Starts a mission for an AI employee with a brief, optionally about one record (subjectKind and subjectId). |
| update_task | Update task | Updates a task's title, status, priority or due date. Done follows the task completion path. |
| assign_case | Assign case | Assigns a case to a member; a null assignee leaves it unassigned. |
| resolve_case | Resolve case | Resolves, cancels or closes a case through its existing transition. |
Limits
The limit is 100 requests a minute per key.
Webhook signatures
Each delivery carries a Qwrki-Signature header shaped t=<unix seconds>,v1=<hex hmac-sha256(secret, t.body)>. Check the signature before trusting a delivery.
Machine readable reference
The same reference behind the tables above is published as JSON at /api/v1/openapi.json.