Skip to content

Latest commit

 

History

History
13 lines (10 loc) · 11.6 KB

File metadata and controls

13 lines (10 loc) · 11.6 KB

CreateAgentTaskRequestBody

Fields

Field Type Required Description
onBehalfOf Operations\OnBehalfOf ✔️ Identifies the user on whose behalf the agent task is created.
Exactly one of user_id or identifier must be provided.
permissions Operations\Permissions ✔️ The permissions granted to the agent task. Must be "*" (all permissions).
agentName string ✔️ A name identifying the agent. Used to derive a stable agent_id per instance.
Logged for audit purposes.
taskDescription string ✔️ A description of the task being performed. Logged for audit purposes.
redirectUrl string ✔️ 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.
sessionMaxDurationInSeconds ?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.