API
Upload and search a knowledge document
Find a knowledge database, upload a safe document, monitor ingestion, and search it.
Before you start
Choose an isolated knowledge database and a fictitious supported document. Confirm View, Create, Update, and Search separately where the journey needs them.
Follow the journey
- List knowledge databases and select the intended name.
- Read its current configuration.
- Upload the smallest supported document using
multipart/form-data. - Keep the document and ingestion job identifiers.
- Read the ingestion job until it reaches a terminal state.
- Read the document metadata and table of contents.
- Search using a fictitious query.
- Check that each result points to the intended source.
Handle failure
Correct unsupported, empty, encrypted, damaged, or oversized files before a new upload. If a provider or worker is unavailable, keep the request and job IDs, read current job state, and use bounded retry only when the operation says it is safe.
Clean up
Delete only the test document or database that the integration created. Check dependencies first. A delete request is not a reversible disable action.
Reference
Use the Knowledge and documents API reference and document format guide.
Processing destination and evidence
Use the customer contract for address availability and eligible processing servers. The job response includes target and processing information.
Recorded attempt evidence differs from a current configuration preview. Do not infer GPU execution from a saved accelerator setting.
Was this page helpful?
Your answer helps us improve the documentation.
Do not include personal information, customer information, passwords, or keys.