Qwrki

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.

Version 1 endpoints and key scopes
EndpointVerbsKey scope
/api/v1/ai-employees
/api/v1/ai-employees/{id}
GETai-employee:read
/api/v1/assets
/api/v1/assets/{id}
GETasset:read
/api/v1/calls
/api/v1/calls/{id}
GETcall:read
/api/v1/cases
/api/v1/cases/{id}
GET, POST, PATCHcase:create, case:read, case:assign, case:update
/api/v1/contracts
/api/v1/contracts/{id}
GETcontract:read
/api/v1/credit-notes
/api/v1/credit-notes/{id}
GETcredit-note:read
/api/v1/customers
/api/v1/customers/{id}
GET, POST, PATCHcustomer:read, customer:create, customer:update
/api/v1/deals
/api/v1/deals/{id}
GET, POST, PATCHdeal:read, deal:create, deal:update
/api/v1/estimates
/api/v1/estimates/{id}
GETestimate:read
/api/v1/expenses
/api/v1/expenses/{id}
GETexpense:read
/api/v1/forms/{id}/submissions
/api/v1/forms/{id}/submissions/{submissionId}
GETform-submission:read
/api/v1/forms
/api/v1/forms/{id}
GETform:read
/api/v1/invoices
/api/v1/invoices/{id}
GET, POSTinvoice:read, invoice:create
/api/v1/items
/api/v1/items/{id}
GETitem:read
/api/v1/leads
/api/v1/leads/{id}
GET, POST, PATCHlead:read, lead:create, lead:update
/api/v1/meetings
/api/v1/meetings/{id}
GETmeeting:read
/api/v1/missions
/api/v1/missions/{id}
GET, POSTmission:read, mission:assign
/api/v1/people
/api/v1/people/{id}
GETmember:read
/api/v1/projects
/api/v1/projects/{id}
GETproject:read
/api/v1/proposals
/api/v1/proposals/{id}
GETproposal:read
/api/v1/recurring-invoices
/api/v1/recurring-invoices/{id}
GETrecurring-invoice:read
/api/v1/tasks
/api/v1/tasks/{id}
GET, POST, PATCHtask:create, task:read, task:update
/api/v1/time-entries
/api/v1/time-entries/{id}
GETtime:read
/api/v1/chat/widgetsGETchat-widget:read
/api/v1/chat/widgets/{id}GET, PATCHchat-widget:read, chat-widget:manage
/api/v1/chat/widgets/{id}/sourcesPOSTchat-widget:manage
/api/v1/chat/widgets/{id}/sources/{sourceId}DELETEchat-widget:manage
/api/v1/chat/widgets/{id}/conversationsGETchat-conversation:read
/api/v1/chat/conversations/{id}GETchat-conversation:read
/api/v1/chat/conversations/{id}/actionsPOSTcase:create
/api/v1/usageGETbilling:read
/api/v1/webhooksGET, POSTwebhook:read, webhook:manage
/api/v1/webhooks/{id}DELETEwebhook:manage
/api/v1/automations/{id}/runsPOSTautomation:run

AI assistant tools

Assistants reach Qwrki through one door: POST /api/v1/mcp.

The door reads 24 record kinds.

AI assistant tools
ToolTitleWhat it does
list_recordsList recordsReads 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_recordGet recordReads 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_taskCreate taskCreates a task inside a project, with an optional due date.
open_caseOpen caseOpens a case with a subject and purpose, optionally linked to a customer or project.
start_missionStart missionStarts a mission for an AI employee with a brief, optionally about one record (subjectKind and subjectId).
update_taskUpdate taskUpdates a task's title, status, priority or due date. Done follows the task completion path.
assign_caseAssign caseAssigns a case to a member; a null assignee leaves it unassigned.
resolve_caseResolve caseResolves, 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.