Guides
Ingest external content
Push documents from your own systems into Orcha's retrieval index.
When no connector exists for a system, push its content through the ingestion API. Ingested documents are indexed for search_context with your own citations and provenance, like documents from a connected source.
Submit a document
Build the idempotencyKey from the source system, object, and revision so replays are recognized. Content is limited to 5 MB and metadata to 16 KB. Requires write permission.
Replay behavior
The endpoint is safe to call from sync jobs that retry:
- New work returns
202 Accepted. - An identical replay returns
200 OKwithdeduplicated: true. - Reusing a key with different content returns
409 Conflict; use a new key (typically a new revision) instead.
Poll for status
Status is pending, indexing, indexed, or failed, with content hash, indexing time, citation, and any available error. Once indexed, the document is returned by search_context with the citation you supplied.