AsyncAPI channel · Replicate
· Replicate Streaming and Webhooks API
webhooks.prediction
Outbound webhook callbacks for a prediction. Which of the four event
types fire is controlled by the prediction's `webhook_events_filter`
array (`start`, `output`, `logs`, `completed`). Default behavior
(without filters) fires whenever there are new outputs or the
prediction has finished. `output` and `logs` are throttled to at most
once per 500ms; `start` and `completed` always send.
Provider:ReplicateAsyncAPI: v2.6.0Spec: Replicate Streaming and Webhooks APIOperations: 1Messages: 4
Channel address
webhooks.prediction
Operations
publish
receivePredictionWebhook
Receive prediction webhook callbacks
Messages
prediction.start
Sent immediately on prediction start. Corresponds to the `start`
value of `webhook_events_filter`. Not throttled.
Content-Type: application/json
prediction.output
Sent each time a prediction generates an output (predictions can
generate multiple outputs). Corresponds to the `output` value of
`webhook_events_filter`. Throttled to at most once per 500ms.
Content-Type: application/json
prediction.logs
Sent each time log output is generated by a prediction.
Corresponds to the `logs` value of `webhook_events_filter`.
Throttled to at most once per 500ms.
Content-Type: application/json
prediction.completed
Sent when the prediction reaches a terminal state. The `status`
field will be one of `succeeded`, `failed`, or `canceled`.
Corresponds to the `completed` value of `webhook_events_filter`.
Not throttle
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.