API referenceEndpoints
Knowledge
Packages and articles the receptionist quotes and answers from.
On this page
List packages and articles
/v1/knowledgeScopeknowledge:read
What the receptionist quotes (packages) and answers from (articles), newest first.
Partner keys send the client's account id in AssistCall-Account.
Query parameters
limitintegerHow many items to return, 1 to 100.
Default
251 to 100cursorstringThe
next_cursorof the previous page.Up to 300 characters
kindstringOnly packages, or only articles.
One of:
package,article
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Responses
200A page of items.
dataarray of KnowledgeItemRequiredThis page of results.
KnowledgeItem fields
idstring (uuid)RequiredItem id.
kindstringRequiredA package (quoted exactly) or an article (answered from).
One of:
package,articletitlestringRequiredPackage name or question.
bodystringRequiredWhat's included, or the answer.
pricestringRequiredPackages: e.g. "$299" or "from $300".
unitstringRequiredPackages: e.g. "per visit".
enabledbooleanRequiredWhether the receptionist uses it.
sortintegerRequiredOrder within its kind.
created_bystringRequiredowner,ava(added on a call) orstaff.created_atstring (date-time)RequiredCreated.
updated_atstring (date-time)RequiredLast changed.
has_morebooleanRequiredWhether there are more results after this page.
next_cursorstring or nullRequiredPass as
cursorto get the next page; null on the last page.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl https://api.assistcall.ai/v1/knowledge \
-H "Authorization: Bearer $ASSISTCALL_TOKEN"Example response (200)
{
"data": [
{
"id": "5d9f3b7e-1a6c-4c8e-b0d2-4f6a8c0e2b02",
"kind": "package",
"title": "In-office whitening",
"body": "About an hour, results the same day.",
"price": "$299",
"unit": "one time",
"enabled": true,
"sort": 1,
"created_by": "owner",
"created_at": "2026-09-02T17:20:00.000Z",
"updated_at": "2026-09-02T17:20:00.000Z"
}
],
"has_more": false,
"next_cursor": null
}Add a package or article
/v1/knowledgeScopeknowledge:write
An account can keep up to 200 items. The receptionist uses the change on its next call.
Partner keys send the client's account id in AssistCall-Account.
Sandbox keys get 403 sandbox_read_only.
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Request body
kindstringRequiredPackage or article.
One of:
package,articletitlestringRequiredPackage name or question.
Up to 160 characters
bodystringWhat's included, or the answer.
Up to 20000 characters
pricestringPackages only.
Up to 80 characters
unitstringPackages only.
Up to 60 characters
enabledbooleanWhether the receptionist uses it.
Default
true
Responses
201The item.
idstring (uuid)RequiredItem id.
kindstringRequiredA package (quoted exactly) or an article (answered from).
One of:
package,articletitlestringRequiredPackage name or question.
bodystringRequiredWhat's included, or the answer.
pricestringRequiredPackages: e.g. "$299" or "from $300".
unitstringRequiredPackages: e.g. "per visit".
enabledbooleanRequiredWhether the receptionist uses it.
sortintegerRequiredOrder within its kind.
created_bystringRequiredowner,ava(added on a call) orstaff.created_atstring (date-time)RequiredCreated.
updated_atstring (date-time)RequiredLast changed.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl -X POST https://api.assistcall.ai/v1/knowledge \
-H "Authorization: Bearer $ASSISTCALL_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"kind": "article",
"title": "Do you see children?",
"body": "Yes, from age 3. Parents stay in the room."
}'Example response (201)
{
"id": "5d9f3b7e-1a6c-4c8e-b0d2-4f6a8c0e2b02",
"kind": "article",
"title": "Do you see children?",
"body": "Yes, from age 3. Parents stay in the room.",
"price": "",
"unit": "",
"enabled": true,
"sort": 4,
"created_by": "owner",
"created_at": "2026-09-02T17:20:00.000Z",
"updated_at": "2026-09-02T17:20:00.000Z"
}Edit a package or article
/v1/knowledge/{id}Scopeknowledge:write
Only the fields you send change. price and unit only apply to packages.
Partner keys send the client's account id in AssistCall-Account.
Sandbox keys get 403 sandbox_read_only.
Path parameters
idstring (uuid)RequiredThe knowledge item's id.
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Request body
titlestringPackage name or question.
Up to 160 characters
bodystringWhat's included, or the answer.
Up to 20000 characters
pricestringPackages only.
Up to 80 characters
unitstringPackages only.
Up to 60 characters
enabledbooleanWhether the receptionist uses it.
sortintegerOrder within its kind.
0 to 10000
Responses
200The item.
idstring (uuid)RequiredItem id.
kindstringRequiredA package (quoted exactly) or an article (answered from).
One of:
package,articletitlestringRequiredPackage name or question.
bodystringRequiredWhat's included, or the answer.
pricestringRequiredPackages: e.g. "$299" or "from $300".
unitstringRequiredPackages: e.g. "per visit".
enabledbooleanRequiredWhether the receptionist uses it.
sortintegerRequiredOrder within its kind.
created_bystringRequiredowner,ava(added on a call) orstaff.created_atstring (date-time)RequiredCreated.
updated_atstring (date-time)RequiredLast changed.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl -X PATCH https://api.assistcall.ai/v1/knowledge/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e \
-H "Authorization: Bearer $ASSISTCALL_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"price": "$279",
"enabled": true
}'Example response (200)
{
"id": "5d9f3b7e-1a6c-4c8e-b0d2-4f6a8c0e2b02",
"kind": "package",
"title": "In-office whitening",
"body": "About an hour, results the same day.",
"price": "$279",
"unit": "one time",
"enabled": true,
"sort": 1,
"created_by": "owner",
"created_at": "2026-09-02T17:20:00.000Z",
"updated_at": "2026-09-02T17:20:00.000Z"
}Remove a package or article
/v1/knowledge/{id}Scopeknowledge:write
Partner keys send the client's account id in AssistCall-Account.
Sandbox keys get 403 sandbox_read_only.
Path parameters
idstring (uuid)RequiredThe knowledge item's id.
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Responses
200Removed.
idstring (uuid)RequiredThe id of what was removed.
deletedbooleanRequiredAlways true.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl -X DELETE https://api.assistcall.ai/v1/knowledge/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e \
-H "Authorization: Bearer $ASSISTCALL_TOKEN"Example response (200)
{
"id": "5d9f3b7e-1a6c-4c8e-b0d2-4f6a8c0e2b02",
"deleted": true
}