Agents

Invoke an automation

Changed on

Queues a manual delivery without changing the saved schedule.

post/agents/automations/{automation_id}/invocations

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/agents/automations/{automation_id}/invocations
  • Auth
    HTTP bearer

Path parameters

automation_idstring required

Response

The queued invocation.

idstring required

The invocation ID.

object'agent.automation.invocation' required

Always agent.automation.invocation.

automation_idstring required

The automation that owns the invocation.

created_atinteger required

The creation time as a Unix timestamp in seconds.

scheduled_atinteger nullable required

The intended occurrence as a Unix timestamp in seconds, or null for manual runs.

session_idstring nullable required

The target or newly created session ID, or null before one is available.

status'queued' | 'completed' | 'failed' | 'skipped' required
skip_reason'pending_delivery' | 'null' nullable required

Why an occurrence was skipped, or null when it was not skipped.

Changes