List AI Agent Tasks

Returns a list of AI agent tasks for the account, optionally filtered by project, branch, status, or creation time.

GET /v1/ai/agents/tasks

List AI Agent Tasks

cURL

curl --request GET \
  --url https://eu1.api.matillion.com/dpc/v1/ai/agents/tasks \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://eu1.api.matillion.com/dpc/v1/ai/agents/tasks"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://eu1.api.matillion.com/dpc/v1/ai/agents/tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu1.api.matillion.com/dpc/v1/ai/agents/tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eu1.api.matillion.com/dpc/v1/ai/agents/tasks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://eu1.api.matillion.com/dpc/v1/ai/agents/tasks")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu1.api.matillion.com/dpc/v1/ai/agents/tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "tasks": [
    {
      "taskId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "RUNNING",
      "agentName": "data_engineer_agent",
      "mode": "ACT",
      "description": "Build a pipeline to load sales data",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "modifiedAt": "2024-01-15T10:35:00.000Z",
      "projectId": "550e8400-e29b-41d4-a716-446655440001",
      "branchId": "main"
    }
  ],
  "page": 0,
  "size": 20,
  "total": 1
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

a valid bearer token

Query Parameters

projectId · string

Filter results to tasks belonging to this project.

branchId · string

Filter results to tasks belonging to this branch.

status · enum<string>

Filter results to tasks with the given status.

Available options: RUNNING, STOPPED, STOPPING, ERRORED

createdAfter · string<date-time>

Return only tasks created at or after this ISO-8601 timestamp (inclusive).

createdBefore · string<date-time>

Return only tasks created at or before this ISO-8601 timestamp (inclusive).

page · integer<int32> · default: 0

Required range: x >= 0

size · integer<int32> · default: 20

Required range: 1 <= x <= 100

Response

200

application/json

Agent tasks listed successfully

page · integer<int32>

The current page number (0-indexed)

size · integer<int32>

The number of tasks per page

tasks · object[]

The list of agent tasks for the account

Show child attributes

total · integer<int64>

The total number of matching tasks