API reference · Knowledge base

Download document

A short-lived signed link to the file the customer originally uploaded.

gethttps://api.integrable.cloud/api/bots/{bot_id}/knowledge/{document_id}/download

Authentication: Bearer token
Retries: Safe to repeat
Body: None
Version: 2026-09-03

Returns the URL rather than the bytes. Proxying a download through the API holds a worker for as long as somebody's connection lasts, which is a poor use of a small container when the object store does this natively - and the signature is what enforces the tenant boundary, not the redirect.

404 rather than 204 when no original exists, because "this document has no stored source" and "no such document" are the same answer to a caller: there is nothing here to download. Documents added as pasted text or crawled URLs never had a source file, and documents uploaded before this shipped were not kept.

Path parameters

bot_idstringrequired
document_idstringrequired

Responses

200OKapplication/json
DocumentDownload
- expires_inintegerrequired
- filenamestringrequired
- urlstringrequired
- mime_typestring | null
5 response headers
RateLimit-Limit
Requests permitted in the current window.
RateLimit-Remaining
Requests left in the current window. Back off before it reaches 0.
RateLimit-Reset
Seconds until the current window resets.
X-API-Version
The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.
X-Request-ID
Quote this in a support request to identify the call.
422Validation error
The shared error envelope, served as application/problem+json with error.code set to validation_error. Its details name each field that failed and why.

Example request

curl

curl "https://api.integrable.cloud/api/bots/$BOT_ID/knowledge/$DOCUMENT_ID/download" \
  -H "Authorization: Bearer $INTEGRABLE_API_KEY"

Set INTEGRABLE_API_KEY and the path variables first. The same call from the TypeScript or Python SDK takes the same fields.

Example response

200 OK · application/json

{
  "expires_in": 0,
  "filename": "string",
  "mime_type": "string",
  "url": "https://example.com"
}

Generated from the schema above — the shape is exact, the values are placeholders.

Errors

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

validation_error · 422 — The payload was well-formed JSON but failed schema validation.
unauthenticated · 401 — The request carried no API key, or one the API could not verify.
forbidden · 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.
rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-bot limit on top.

More Knowledge base endpoints

Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.