API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webhooks

Unwrap

client.webhooks.unwrap(RequestOptionsoptions?): void

Function

ModelsExpand Collapse

BatchCancelledWebhookEvent { id, created_at, data, 2 more }

Sent when a batch API request has been cancelled.

BatchCompletedWebhookEvent { id, created_at, data, 2 more }

Sent when a batch API request has been completed.

BatchExpiredWebhookEvent { id, created_at, data, 2 more }

Sent when a batch API request has expired.

BatchFailedWebhookEvent { id, created_at, data, 2 more }

Sent when a batch API request has failed.

EvalRunCanceledWebhookEvent { id, created_at, data, 2 more }

Sent when an eval run has been canceled.

EvalRunFailedWebhookEvent { id, created_at, data, 2 more }

Sent when an eval run has failed.

EvalRunSucceededWebhookEvent { id, created_at, data, 2 more }

Sent when an eval run has succeeded.

FineTuningJobCancelledWebhookEvent { id, created_at, data, 2 more }

Sent when a fine-tuning job has been cancelled.

FineTuningJobFailedWebhookEvent { id, created_at, data, 2 more }

Sent when a fine-tuning job has failed.

FineTuningJobSucceededWebhookEvent { id, created_at, data, 2 more }

Sent when a fine-tuning job has succeeded.

LiveCallIncomingWebhookEvent { id, created_at, data, 2 more }

Sent when an incoming API SIP session is available for Live acceptance. The same pending session can also emit realtime.call.incoming; the first successful Realtime or Live accept endpoint selects the runtime surface.

RealtimeCallIncomingWebhookEvent { id, created_at, data, 2 more }

Sent when an incoming API SIP session is available for Realtime acceptance. The same pending session can also emit live.call.incoming; the first successful Realtime or Live accept endpoint selects the runtime surface.

ResponseCancelledWebhookEvent { id, created_at, data, 2 more }

Sent when a background response has been cancelled.

ResponseCompletedWebhookEvent { id, created_at, data, 2 more }

Sent when a background response has been completed.

ResponseFailedWebhookEvent { id, created_at, data, 2 more }

Sent when a background response has failed.

ResponseIncompleteWebhookEvent { id, created_at, data, 2 more }

Sent when a background response has been interrupted.