Docs menu

Reference

Headers

Every request and response header the Seldon gateway reads or sets.

Request headers

HeaderPurpose
AuthorizationBearer sk-seldon-.... Required on every API call.
Idempotency-KeySafe retries for non-streaming requests: 1–255 characters, replayed for 120 seconds. Function calls require a UUID. See Retries and idempotency.
X-TitleApplication label shown in the App column of Calls & usage.
RefererFallback application label when X-Title is absent.
X-Seldon-End-UserEnd-user identifier, if you don't use the user field.
X-Seldon-Session-Id, X-Seldon-Conversation-IdSession grouping.
X-Seldon-Run-Id, X-Seldon-Turn-IdRun and turn within a session.
X-Seldon-Span-Id, X-Seldon-Parent-Span-Id, X-Seldon-Parent-Trace-IdCall hierarchy.
X-Seldon-Span-Name, X-Seldon-Session-Name, X-Seldon-Session-Path, X-Seldon-Session-MetadataLabels and metadata.
traceparent, baggageW3C trace context.
x-byok-keyA provider key for this request only. Bring your own key is coming soon.

Formats and limits for the session headers are in Attribution and sessions.

Response headers

HeaderPurpose
X-Seldon-Trace-IdSeldon's ID for the call. Present on every accepted JSON and streaming response.
X-Seldon-Span-IdThe span ID used for the call, when it belongs to a session.
Retry-AfterSeconds to wait before retrying, on 429 and some 503 responses.
Headers | Seldon