Complete Knowledge Upload
Confirms the file was uploaded to the presigned URL. The stored object is verified — it must exist, be within the size limit, and carry the content type the URL was issued for — and only then does the document become usable on calls. Safe to retry: completing an already-completed document returns it unchanged.
Overview
This is the third step of the upload flow. Until it succeeds the document staysPENDING and no call will consult it.
What Gets Verified
The stored object is checked before the document is accepted:- it exists — a completion call for a file that was never uploaded is rejected
- it is within the 20 MiB (20,971,520 bytes) size limit
- it carries the content type the upload URL was issued for
Idempotency
Completing a document that is alreadyREADY returns it unchanged, with no error. A completion call that times out on your side is safe to retry.
After Completion
The document isREADY and isActive: true. It is attached to the agent’s next call automatically — there is no publish step, and no need to update the agent itself.
To park a document without deleting it, deactivate it.
Error Scenarios
- 400 Bad Request: Nothing was uploaded to the URL, or the stored file failed verification
- 404 Not Found: No such document on that agent
- 429 Too Many Requests: Rate limit exceeded — wait for
Retry-Afterseconds
Related Resources
Authorizations
API key for authentication using Bearer scheme
Path Parameters
Agent the knowledge base belongs to.
Knowledge document id.
Query Parameters
Required for ATS API keys to specify which company to access. Ignored for standard company API keys.
Response
Upload verified; the document is now READY
Document ID
"123e4567-e89b-12d3-a456-426614174000"
Human-readable label for the document
"Benefits and perks"
PENDING while waiting for the file to be uploaded to the presigned URL and the upload to be completed; READY once the file is confirmed stored. Only READY documents are attached to calls.
PENDING, READY "READY"
Whether the agent may consult this document during a call. Always false while the upload is PENDING.
true
When the document was created
"2026-08-08T10:15:00.000Z"
Original file name as uploaded
"benefits-and-perks.pdf"
MIME type of the stored file
"application/pdf"
Size of the stored file in bytes, as verified against storage. Absent until the upload is READY.
482133