API referenceEndpoints

Replace a source document

Requires an authenticated tenant principal. Generated from the production route registered in `internal/features/sources/inbound/http.go`.

PUT/v1/sources/{id}/documents/{document}

Requires an authenticated tenant principal. Generated from the production route registered in internal/features/sources/inbound/http.go.

Authorization

bearerAuth
AuthorizationBearer <token>

Engine-issued API key or tenant-signed JWT.

In: header

Path Parameters

id*string
Formatuuid
document*string

Header Parameters

Idempotency-Key*string

Required, at most 200 bytes. A replay with the same key, the same {document}, file and plan returns the version the key claimed; the same key with a different document, file or plan is 409 {"error":{"type":"conflict","code":"idempotency_key_reuse","message":"this key was used for different input"}}.

Lengthlength <= 200

Request Body

multipart/form-data

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 PUT "https://example.com/v1/sources/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents/string" \  -H "Idempotency-Key: string" \  -F file="string"
{}

Remove a source document

Requires an authenticated tenant principal. Generated from the production route registered in `internal/features/sources/inbound/http.go`.

List a document's versions

Requires an authenticated tenant principal. Generated from the production route registered in `internal/features/sources/inbound/http.go`.