| Field | Type | Required | Description |
|---|---|---|---|
on_behalf_of |
models.OnBehalfOf | ✔️ | Identifies the user on whose behalf the agent task is created. Exactly one of user_id or identifier must be provided. |
permissions |
models.CreateAgentTaskPermissions | ✔️ | The permissions granted to the agent task. Must be "*" (all permissions). |
agent_name |
str | ✔️ | A name identifying the agent. Used to derive a stable agent_id per instance. Logged for audit purposes. |
task_description |
str | ✔️ | A description of the task being performed. Logged for audit purposes. |
redirect_url |
str | ✔️ | The URL the user is redirected to after the agent task is accepted. Must be a valid absolute URL with an https scheme in production instances.In development instances, http is also permitted.The URL's domain must belong to one of the instance's associated domains (primary or satellite); otherwise the redirect will be rejected when the task ticket is consumed. |
session_max_duration_in_seconds |
Optional[int] | ➖ | The maximum duration that the session which will be created by the generated agent task should last. By default, the duration of a session created via an agent task lasts 30 minutes. |