Ingestion API: your systems feed the assistant

Security: what you need to know

• You do the sending: QuickAsk never connects to your network and holds no credentials of yours.
• No firewall opening or installation is needed: a simple outbound HTTPS call is enough.
• A key is valid for a single assistant only. There is no account-wide key.
• The key is shown only once, when it is created. QuickAsk only keeps a fingerprint of it, like a password: nobody, including us, can read it back.
• The key can only add, update, remove and list the content it has sent. It cannot read the text of the knowledge base or the conversations.
• Content sent goes through the same checks as a file added by hand: real format verification, processing in an isolated environment, blocking of text that tries to give instructions to the assistant.
• The assistant’s owner can revoke a key at any time; they see when each key was last used and a log of recent activity (kept for 30 days, with no IP address or content).

Get started in 3 steps

1. In QuickAsk, the assistant’s owner opens the assistant, “Knowledge” tab, “Automatic sending from your software” section, and clicks “Create a key”.
2. They pass you the key (which starts with qak_) and the assistant ID shown next to it. Store the key in your secrets vault.
3. Your system sends its content with the “Authorization: Bearer” header followed by the key, as in the examples below.

Endpoints

Base URL: https://www.quick-ask.app/api/v1

The external ID is the one from your system (“product-123”, “faq:delivery”…): 1 to 128 characters, letters, digits and . _ - : ~ @, starting with a letter or a digit.

Sending content

curl -X PUT "https://www.quick-ask.app/api/v1/bots/$BOT_ID/knowledge/faq-delivery" \
  -H "Authorization: Bearer $QUICKASK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Delivery times",
    "format": "markdown",
    "content": "## Delivery\nOrders placed before 2 pm ship the same day.",
    "source_url": "https://intranet.example.com/faq/delivery",
    "updated_at": "2026-10-13T09:30:00Z"
  }'

curl -X PUT "https://www.quick-ask.app/api/v1/bots/$BOT_ID/knowledge/hr-handbook" \
  -H "Authorization: Bearer $QUICKASK_API_KEY" \
  -F "[email protected]" \
  -F "title=Employee handbook" \
  -F "updated_at=2026-09-01"

Responses

• created — 201: the content did not exist, it has been added.
• updated — 200: the content has changed; only the modified parts are reprocessed.
• unchanged — 200: content identical to the last one sent, nothing is reprocessed. You can therefore resend everything at each sync.

HTTP/1.1 201 Created
{
  "external_id": "faq-delivery",
  "status": "created",          // "updated" or "unchanged" on the next calls
  "title": "Delivery times",
  "document_name": "[API] Delivery times",
  "chunks": 1,
  "indexed_bytes": 58,          // 0 when nothing changed
  "source_url": "https://intranet.example.com/faq/delivery",
  "updated_at": "2026-10-13T09:30:00.000Z"
}

Removing and listing

curl -X DELETE "https://www.quick-ask.app/api/v1/bots/$BOT_ID/knowledge/faq-delivery" \
  -H "Authorization: Bearer $QUICKASK_API_KEY"

curl "https://www.quick-ask.app/api/v1/bots/$BOT_ID/knowledge?limit=100" \
  -H "Authorization: Bearer $QUICKASK_API_KEY"
# → { "items": [ { "external_id": "faq-delivery", "title": "...", "updated_at": "...",
#                  "indexed_at": "...", "size_bytes": 58, "chunks": 1, ... } ],
#     "next_cursor": null }   // pass ?cursor=<next_cursor> to get the next page

Limits

• Size: 2 MB of text at most per item of content, 4 MB per file.
• Accepted files: pdf, docx, xlsx, pptx, csv, txt, md. Images, audio, video and scanned PDFs (with no text) are not read by the API.
• Rate: 60 calls per minute per key.
• Volume of new or changed content per assistant per 24 h: 10 MB (Business), 25 MB (Pro), 50 MB (Agency and custom). Unchanged content does not count.
• The plan’s storage space applies, just as for a file added by hand.
• The API is available from the Business plan.
• Content sent through the API is not deducted from the plan’s requests.

Errors

An error returns an HTTP status code and a JSON body whose error field contains a code and a message. The code is stable: rely on it, not on the message. When retrying makes sense, the Retry-After header gives the delay in seconds.

HTTP/1.1 429 Too Many Requests
Retry-After: 60
{ "error": { "code": "rate_limited", "message": "Too many requests: at most 60 per minute per key." } }

Example with n8n (or Make)

1. Create a “Bearer Auth” credential containing the QuickAsk key.
2. After the node that reads your data (database, spreadsheet, ERP…), add an “HTTP Request” node using the PUT method, with the URL below and each item’s ID at the end.
3. Send a JSON body with the item’s title, text and, if possible, URL and update date.
4. Leave about one second between two calls (“Batching” option) to stay under the rate limit. With Make, the “HTTP — Make a request” module is configured the same way.

{
  "method": "PUT",
  "url": "https://www.quick-ask.app/api/v1/bots/<BOT_ID>/knowledge/{{ $json.id }}",
  "authentication": "genericCredentialType",
  "genericAuthType": "httpBearerAuth",
  "sendBody": true,
  "contentType": "json",
  "specifyBody": "json",
  "jsonBody": "={{ { title: $json.name, content: $json.description, format: 'text', source_url: $json.url, updated_at: $json.updatedAt } }}",
  "options": { "batching": { "batch": { "batchSize": 1, "batchInterval": 1100 } } }
}

Best practices

• Use a stable ID (your database’s primary key): it is what allows an update rather than a duplicate.
• Send the update date: it helps the assistant prefer the most recent information.
• You can resend your whole catalogue at each sync: unchanged content costs nothing.
• To remove what no longer exists on your side, compare the list (GET) with your data and delete the IDs that have disappeared.
• Keep the key on the server side (never in a web page or a mobile app) and revoke it as soon as it is no longer used.