API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webhooks

ModelsExpand Collapse

class BatchCancelledWebhookEvent:

Sent when a batch API request has been cancelled.

class BatchCompletedWebhookEvent:

Sent when a batch API request has been completed.

class BatchExpiredWebhookEvent:

Sent when a batch API request has expired.

class BatchFailedWebhookEvent:

Sent when a batch API request has failed.

class EvalRunCanceledWebhookEvent:

Sent when an eval run has been canceled.

class EvalRunFailedWebhookEvent:

Sent when an eval run has failed.

class EvalRunSucceededWebhookEvent:

Sent when an eval run has succeeded.

class FineTuningJobCancelledWebhookEvent:

Sent when a fine-tuning job has been cancelled.

class FineTuningJobFailedWebhookEvent:

Sent when a fine-tuning job has failed.

class FineTuningJobSucceededWebhookEvent:

Sent when a fine-tuning job has succeeded.

class LiveCallIncomingWebhookEvent:

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.

class RealtimeCallIncomingWebhookEvent:

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.

class ResponseCancelledWebhookEvent:

Sent when a background response has been cancelled.

class ResponseCompletedWebhookEvent:

Sent when a background response has been completed.

class ResponseFailedWebhookEvent:

Sent when a background response has failed.

class ResponseIncompleteWebhookEvent:

Sent when a background response has been interrupted.