Skip to content

API referenceEndpoints

Knowledge

Packages and articles the receptionist quotes and answers from.

On this page

List packages and articles

GET/v1/knowledge

Scopeknowledge: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

  • limitinteger

    How many items to return, 1 to 100.

    Default 251 to 100

  • cursorstring

    The next_cursor of the previous page.

    Up to 300 characters

  • kindstring

    Only 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 KnowledgeItemRequired

      This page of results.

      KnowledgeItem fields
      • idstring (uuid)Required

        Item id.

      • kindstringRequired

        A package (quoted exactly) or an article (answered from).

        One of: package, article

      • titlestringRequired

        Package name or question.

      • bodystringRequired

        What's included, or the answer.

      • pricestringRequired

        Packages: e.g. "$299" or "from $300".

      • unitstringRequired

        Packages: e.g. "per visit".

      • enabledbooleanRequired

        Whether the receptionist uses it.

      • sortintegerRequired

        Order within its kind.

      • created_bystringRequired

        owner, ava (added on a call) or staff.

      • created_atstring (date-time)Required

        Created.

      • updated_atstring (date-time)Required

        Last changed.

    • has_morebooleanRequired

      Whether there are more results after this page.

    • next_cursorstring or nullRequired

      Pass as cursor to get the next page; null on the last page.

    • 400invalid_requestA parameter or body field is missing or invalid; the message names it.
    • 401authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials).
    • 403permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write.
    • 404not_foundNo such object in this account (ids from other accounts are “not found” too).
    • 429rate_limitToo many requests: wait Retry-After seconds.
    • 500serverSomething went wrong on our side. Retry with backoff.

    Errors share one shape. See Errors.

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

POST/v1/knowledge

Scopeknowledge: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

  • kindstringRequired

    Package or article.

    One of: package, article

  • titlestringRequired

    Package name or question.

    Up to 160 characters

  • bodystring

    What's included, or the answer.

    Up to 20000 characters

  • pricestring

    Packages only.

    Up to 80 characters

  • unitstring

    Packages only.

    Up to 60 characters

  • enabledboolean

    Whether the receptionist uses it.

    Default true

Responses

  • 201The item.
    • idstring (uuid)Required

      Item id.

    • kindstringRequired

      A package (quoted exactly) or an article (answered from).

      One of: package, article

    • titlestringRequired

      Package name or question.

    • bodystringRequired

      What's included, or the answer.

    • pricestringRequired

      Packages: e.g. "$299" or "from $300".

    • unitstringRequired

      Packages: e.g. "per visit".

    • enabledbooleanRequired

      Whether the receptionist uses it.

    • sortintegerRequired

      Order within its kind.

    • created_bystringRequired

      owner, ava (added on a call) or staff.

    • created_atstring (date-time)Required

      Created.

    • updated_atstring (date-time)Required

      Last changed.

    • 400invalid_requestA parameter or body field is missing or invalid; the message names it.
    • 401authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials).
    • 403permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write.
    • 404not_foundNo such object in this account (ids from other accounts are “not found” too).
    • 429rate_limitToo many requests: wait Retry-After seconds.
    • 500serverSomething went wrong on our side. Retry with backoff.

    Errors share one shape. See Errors.

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

PATCH/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)Required

    The 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

  • titlestring

    Package name or question.

    Up to 160 characters

  • bodystring

    What's included, or the answer.

    Up to 20000 characters

  • pricestring

    Packages only.

    Up to 80 characters

  • unitstring

    Packages only.

    Up to 60 characters

  • enabledboolean

    Whether the receptionist uses it.

  • sortinteger

    Order within its kind.

    0 to 10000

Responses

  • 200The item.
    • idstring (uuid)Required

      Item id.

    • kindstringRequired

      A package (quoted exactly) or an article (answered from).

      One of: package, article

    • titlestringRequired

      Package name or question.

    • bodystringRequired

      What's included, or the answer.

    • pricestringRequired

      Packages: e.g. "$299" or "from $300".

    • unitstringRequired

      Packages: e.g. "per visit".

    • enabledbooleanRequired

      Whether the receptionist uses it.

    • sortintegerRequired

      Order within its kind.

    • created_bystringRequired

      owner, ava (added on a call) or staff.

    • created_atstring (date-time)Required

      Created.

    • updated_atstring (date-time)Required

      Last changed.

    • 400invalid_requestA parameter or body field is missing or invalid; the message names it.
    • 401authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials).
    • 403permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write.
    • 404not_foundNo such object in this account (ids from other accounts are “not found” too).
    • 429rate_limitToo many requests: wait Retry-After seconds.
    • 500serverSomething went wrong on our side. Retry with backoff.

    Errors share one shape. See Errors.

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

DELETE/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)Required

    The 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)Required

      The id of what was removed.

    • deletedbooleanRequired

      Always true.

    • 400invalid_requestA parameter or body field is missing or invalid; the message names it.
    • 401authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials).
    • 403permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write.
    • 404not_foundNo such object in this account (ids from other accounts are “not found” too).
    • 429rate_limitToo many requests: wait Retry-After seconds.
    • 500serverSomething went wrong on our side. Retry with backoff.

    Errors share one shape. See Errors.

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
}

Try "token", "webhook signature", "rate limit" or "custom domain".