Automation tasks, callbacks, and task templates

Create and run automation tasks, maintain callback rules, and manage reusable agent task templates. This page does not observe runtime tasks; use the adjacent task page for runtime observation.

Prerequisites

Prepare credentials that can access the target workspace and IDs for source resources required by automation tasks, callback rules, or templates. For service endpoints, authentication, and general request formats, see Make your first AI Studio API call.

Confirm a target task before starting it. To receive callbacks, manage the corresponding callback rule first.

Call sequence

  1. Create a task template or query existing templates to determine a reusable task definition.

  2. Retain the task ID after creating an automation task. To adjust it, get task details first, then update the task.

  3. After starting a task run, use the run-detail, event, and result actions to view distinct observable run information.

  4. To manage callback rules, query the target rule first, then create, update, or delete it. Confirm impact before archiving a task.

API operations

Manage automation tasks and runs

Task

Use it when

Create an automation task

Create a new automation task.

Query automation tasks

Select or confirm a target task.

Query automation-task details

Confirm a target task before updating, starting, or archiving.

Update an automation task

You have the task ID and need to modify it.

Start an automation-task run

You confirmed a task and need to submit one run.

Query automation-task run details

You have a run ID and need run information.

Query automation-task run events

View events for a target run.

Query automation-task run results

View the result for a target run.

Archive an automation task

Confirm impact and conditions on the action page before archiving.

Manage callback rules

Task

Use it when

Create a callback rule

Configure a callback rule for a task.

Query callback rules

Select or confirm a target rule.

Query callback-rule details

Confirm a target rule before updating or deleting it.

Update a callback rule

You have the rule ID and need to modify it.

Delete a callback rule

Confirm impact and conditions on the action page before deletion.

Manage agent task templates

Task

Use it when

Create an agent task template

Create a reusable template.

Query agent task templates

Select or confirm a template.

Query agent task-template details

Confirm a target template before updating.

Update an agent task template

You have the template ID and need to modify it.

Confirm the result

After starting a run, use Get an automation-task run, List automation-task run events, and Get an automation-task run result to confirm it. Confirm task, callback-rule, and template changes with their respective detail or list actions.

Limitations and notes

Archiving a task and deleting a callback rule affect the target object. Confirm conditions and results on the corresponding action page before proceeding.

Next steps

Last updated on