v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
AI Agent Tasks

Get an AI Agent Task

Returns the details of a specific AI agent task including its current status and pending decisions.

get/v1/ai/agents/tasks/{taskId}

Path parameters

taskIdstring uuid required

Response

Agent task retrieved successfully

createdAtstring date-time

The date and time the task was created

descriptionstring

A short description of what the agent was asked to do

modifiedAtstring date-time

The date and time the task was last modified

status'RUNNING' | 'STOPPED' | 'STOPPING' | 'ERRORED'

The current status of the task

taskIdstring uuid

The unique identifier of the task

Example response

{
  "agentConfig": {
    "name": "data_engineer_agent",
    "environmentName": "development",
    "generateBranch": true,
    "graphId": "my-pipeline",
    "mode": "ACT",
    "projectId": "550e8400-e29b-41d4-a716-446655440001",
    "sourceBranchName": "main",
    "targetBranchName": "feature/my-pipeline",
    "workingDirectory": "/pipelines"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "description": "Build a pipeline to load sales data from S3 into Snowflake",
  "grantedPermissions": [
    {
      "toolName": "execute_sql"
    }
  ],
  "modifiedAt": "2024-01-15T10:45:00.000Z",
  "pendingDecisions": [
    {
      "permissionMessage": {
        "body": "The agent wants to run: SELECT * FROM sales",
        "title": "Execute SQL query"
      },
      "toolId": "call_abc123",
      "toolName": "execute_sql",
      "type": "tool"
    }
  ],
  "status": "STOPPED",
  "taskId": "550e8400-e29b-41d4-a716-446655440000"
}