Create prepare
Requires an authenticated tenant principal. Generated from the production route registered in `internal/features/sources/inbound/http.go`.
/v1/sources/{id}/document-preparation-candidates/{candidate}/prepareRequires an authenticated tenant principal. Generated from the production route registered in internal/features/sources/inbound/http.go.
Authorization
bearerAuth Engine-issued API key or tenant-signed JWT.
In: header
Path Parameters
uuidHeader Parameters
Required, at most 200 bytes. Gated (SOURCE_PREPARATION_ENABLED). A replay with the same key and the same collection candidate, recipe, expected_source_revision and expected_active_version_id returns the version the key claimed, in whatever state it has reached; the same key with any of them different is 409 {"error":{"type":"conflict","code":"idempotency_key_reuse","message":"this key was used for different input"}}.
length <= 200Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/sources/497f6eca-6276-4993-bfeb-53cbbbba6f08/document-preparation-candidates/string/prepare" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{}'{}Get preview
Requires an authenticated tenant principal. Generated from the production route registered in `internal/features/sources/inbound/http.go`.
List source documents
Requires an authenticated tenant principal. Generated from the production route registered in `internal/features/sources/inbound/http.go`.