# Tasks

## Get Task by ID

**get** `/tasks/{task_id}`

Get a task by its unique ID.

### Path Parameters

- `task_id: string`

### Query Parameters

- `relationships: optional array of "agents"`

  - `"agents"`

### Returns

- `id: string`

- `agents: optional array of Agent`

  - `id: string`

    The unique identifier of the agent.

  - `acp_type: AcpType`

    The type of the ACP Server (Either sync or async)

    - `"sync"`

    - `"async"`

    - `"agentic"`

  - `created_at: string`

    The timestamp when the agent was created

  - `description: string`

    The description of the action.

  - `name: string`

    The unique name of the agent.

  - `updated_at: string`

    The timestamp when the agent was last updated

  - `agent_input_type: optional "text" or "json"`

    The type of input the agent expects.

    - `"text"`

    - `"json"`

  - `production_deployment_id: optional string`

    ID of the current production deployment.

  - `registered_at: optional string`

    The timestamp when the agent was last registered

  - `registration_metadata: optional map[unknown]`

    The metadata for the agent's registration.

  - `status: optional "Ready" or "Failed" or "Unknown" or 3 more`

    The status of the action, indicating if it's building, ready, failed, etc.

    - `"Ready"`

    - `"Failed"`

    - `"Unknown"`

    - `"Deleted"`

    - `"Unhealthy"`

    - `"BuildOnly"`

  - `status_reason: optional string`

    The reason for the status of the action.

- `cleaned_at: optional string`

- `created_at: optional string`

- `name: optional string`

- `params: optional map[unknown]`

- `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

  - `"CANCELED"`

  - `"COMPLETED"`

  - `"FAILED"`

  - `"RUNNING"`

  - `"INTERRUPTED"`

  - `"TERMINATED"`

  - `"TIMED_OUT"`

  - `"DELETED"`

- `status_reason: optional string`

- `task_metadata: optional map[unknown]`

- `updated_at: optional string`

### Example

```http
curl http://localhost:5003/tasks/$TASK_ID \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "agents": [
    {
      "id": "id",
      "acp_type": "sync",
      "created_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "name": "name",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "agent_input_type": "text",
      "production_deployment_id": "production_deployment_id",
      "registered_at": "2019-12-27T18:11:19.117Z",
      "registration_metadata": {
        "foo": "bar"
      },
      "status": "Ready",
      "status_reason": "status_reason"
    }
  ],
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

## Delete Task by ID

**delete** `/tasks/{task_id}`

Delete a task by its unique ID.

### Path Parameters

- `task_id: string`

### Returns

- `DeleteResponse object { id, message }`

  - `id: string`

  - `message: string`

### Example

```http
curl http://localhost:5003/tasks/$TASK_ID \
    -X DELETE \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "message": "message"
}
```

## List Tasks

**get** `/tasks`

List tasks. Returns a lean summary per task and omits `params`; fetch GET /tasks/{task_id} for the full record including `params`.

### Query Parameters

- `agent_id: optional string`

- `agent_name: optional string`

- `limit: optional number`

- `order_by: optional string`

- `order_direction: optional string`

- `page_number: optional number`

- `relationships: optional array of "agents"`

  - `"agents"`

- `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

  Filter tasks by status (e.g. RUNNING, COMPLETED).

  - `"CANCELED"`

  - `"COMPLETED"`

  - `"FAILED"`

  - `"RUNNING"`

  - `"INTERRUPTED"`

  - `"TERMINATED"`

  - `"TIMED_OUT"`

  - `"DELETED"`

- `task_metadata: optional string`

  JSON-encoded object used to filter tasks via JSONB containment. Example: {"created_by_user_id": "abc-123"}.

### Returns

- `id: string`

- `agents: optional array of Agent`

  - `id: string`

    The unique identifier of the agent.

  - `acp_type: AcpType`

    The type of the ACP Server (Either sync or async)

    - `"sync"`

    - `"async"`

    - `"agentic"`

  - `created_at: string`

    The timestamp when the agent was created

  - `description: string`

    The description of the action.

  - `name: string`

    The unique name of the agent.

  - `updated_at: string`

    The timestamp when the agent was last updated

  - `agent_input_type: optional "text" or "json"`

    The type of input the agent expects.

    - `"text"`

    - `"json"`

  - `production_deployment_id: optional string`

    ID of the current production deployment.

  - `registered_at: optional string`

    The timestamp when the agent was last registered

  - `registration_metadata: optional map[unknown]`

    The metadata for the agent's registration.

  - `status: optional "Ready" or "Failed" or "Unknown" or 3 more`

    The status of the action, indicating if it's building, ready, failed, etc.

    - `"Ready"`

    - `"Failed"`

    - `"Unknown"`

    - `"Deleted"`

    - `"Unhealthy"`

    - `"BuildOnly"`

  - `status_reason: optional string`

    The reason for the status of the action.

- `cleaned_at: optional string`

- `created_at: optional string`

- `name: optional string`

- `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

  - `"CANCELED"`

  - `"COMPLETED"`

  - `"FAILED"`

  - `"RUNNING"`

  - `"INTERRUPTED"`

  - `"TERMINATED"`

  - `"TIMED_OUT"`

  - `"DELETED"`

- `status_reason: optional string`

- `task_metadata: optional map[unknown]`

- `updated_at: optional string`

### Example

```http
curl http://localhost:5003/tasks \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
[
  {
    "id": "id",
    "agents": [
      {
        "id": "id",
        "acp_type": "sync",
        "created_at": "2019-12-27T18:11:19.117Z",
        "description": "description",
        "name": "name",
        "updated_at": "2019-12-27T18:11:19.117Z",
        "agent_input_type": "text",
        "production_deployment_id": "production_deployment_id",
        "registered_at": "2019-12-27T18:11:19.117Z",
        "registration_metadata": {
          "foo": "bar"
        },
        "status": "Ready",
        "status_reason": "status_reason"
      }
    ],
    "cleaned_at": "2019-12-27T18:11:19.117Z",
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "status": "CANCELED",
    "status_reason": "status_reason",
    "task_metadata": {
      "foo": "bar"
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]
```

## Stream Task Events by ID

**get** `/tasks/{task_id}/stream`

Stream events for a task by its unique ID.

### Path Parameters

- `task_id: string`

### Example

```http
curl http://localhost:5003/tasks/$TASK_ID/stream \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{}
```

## Get Task by Name

**get** `/tasks/name/{task_name}`

Get a task by its unique name.

### Path Parameters

- `task_name: string`

### Query Parameters

- `relationships: optional array of "agents"`

  - `"agents"`

### Returns

- `id: string`

- `agents: optional array of Agent`

  - `id: string`

    The unique identifier of the agent.

  - `acp_type: AcpType`

    The type of the ACP Server (Either sync or async)

    - `"sync"`

    - `"async"`

    - `"agentic"`

  - `created_at: string`

    The timestamp when the agent was created

  - `description: string`

    The description of the action.

  - `name: string`

    The unique name of the agent.

  - `updated_at: string`

    The timestamp when the agent was last updated

  - `agent_input_type: optional "text" or "json"`

    The type of input the agent expects.

    - `"text"`

    - `"json"`

  - `production_deployment_id: optional string`

    ID of the current production deployment.

  - `registered_at: optional string`

    The timestamp when the agent was last registered

  - `registration_metadata: optional map[unknown]`

    The metadata for the agent's registration.

  - `status: optional "Ready" or "Failed" or "Unknown" or 3 more`

    The status of the action, indicating if it's building, ready, failed, etc.

    - `"Ready"`

    - `"Failed"`

    - `"Unknown"`

    - `"Deleted"`

    - `"Unhealthy"`

    - `"BuildOnly"`

  - `status_reason: optional string`

    The reason for the status of the action.

- `cleaned_at: optional string`

- `created_at: optional string`

- `name: optional string`

- `params: optional map[unknown]`

- `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

  - `"CANCELED"`

  - `"COMPLETED"`

  - `"FAILED"`

  - `"RUNNING"`

  - `"INTERRUPTED"`

  - `"TERMINATED"`

  - `"TIMED_OUT"`

  - `"DELETED"`

- `status_reason: optional string`

- `task_metadata: optional map[unknown]`

- `updated_at: optional string`

### Example

```http
curl http://localhost:5003/tasks/name/$TASK_NAME \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "agents": [
    {
      "id": "id",
      "acp_type": "sync",
      "created_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "name": "name",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "agent_input_type": "text",
      "production_deployment_id": "production_deployment_id",
      "registered_at": "2019-12-27T18:11:19.117Z",
      "registration_metadata": {
        "foo": "bar"
      },
      "status": "Ready",
      "status_reason": "status_reason"
    }
  ],
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

## Delete Task by Name

**delete** `/tasks/name/{task_name}`

Delete a task by its unique name.

### Path Parameters

- `task_name: string`

### Returns

- `DeleteResponse object { id, message }`

  - `id: string`

  - `message: string`

### Example

```http
curl http://localhost:5003/tasks/name/$TASK_NAME \
    -X DELETE \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "message": "message"
}
```

## Stream Task Events by Name

**get** `/tasks/name/{task_name}/stream`

Stream events for a task by its unique name.

### Path Parameters

- `task_name: string`

### Example

```http
curl http://localhost:5003/tasks/name/$TASK_NAME/stream \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{}
```

## Update Task by ID

**put** `/tasks/{task_id}`

Update mutable fields for a task by its unique ID.

### Path Parameters

- `task_id: string`

### Body Parameters

- `merge_params: optional map[unknown]`

- `task_metadata: optional map[unknown]`

### Returns

- `Task object { id, cleaned_at, created_at, 6 more }`

  - `id: string`

  - `cleaned_at: optional string`

  - `created_at: optional string`

  - `name: optional string`

  - `params: optional map[unknown]`

  - `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

    - `"CANCELED"`

    - `"COMPLETED"`

    - `"FAILED"`

    - `"RUNNING"`

    - `"INTERRUPTED"`

    - `"TERMINATED"`

    - `"TIMED_OUT"`

    - `"DELETED"`

  - `status_reason: optional string`

  - `task_metadata: optional map[unknown]`

  - `updated_at: optional string`

### Example

```http
curl http://localhost:5003/tasks/$TASK_ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY" \
    -d '{}'
```

#### Response

```json
{
  "id": "id",
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

## Update Task by Name

**put** `/tasks/name/{task_name}`

Update mutable fields for a task by its unique Name.

### Path Parameters

- `task_name: string`

### Body Parameters

- `merge_params: optional map[unknown]`

- `task_metadata: optional map[unknown]`

### Returns

- `Task object { id, cleaned_at, created_at, 6 more }`

  - `id: string`

  - `cleaned_at: optional string`

  - `created_at: optional string`

  - `name: optional string`

  - `params: optional map[unknown]`

  - `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

    - `"CANCELED"`

    - `"COMPLETED"`

    - `"FAILED"`

    - `"RUNNING"`

    - `"INTERRUPTED"`

    - `"TERMINATED"`

    - `"TIMED_OUT"`

    - `"DELETED"`

  - `status_reason: optional string`

  - `task_metadata: optional map[unknown]`

  - `updated_at: optional string`

### Example

```http
curl http://localhost:5003/tasks/name/$TASK_NAME \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY" \
    -d '{}'
```

#### Response

```json
{
  "id": "id",
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

## Complete Task

**post** `/tasks/{task_id}/complete`

Mark a running task as completed.

### Path Parameters

- `task_id: string`

### Body Parameters

- `reason: optional string`

### Returns

- `Task object { id, cleaned_at, created_at, 6 more }`

  - `id: string`

  - `cleaned_at: optional string`

  - `created_at: optional string`

  - `name: optional string`

  - `params: optional map[unknown]`

  - `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

    - `"CANCELED"`

    - `"COMPLETED"`

    - `"FAILED"`

    - `"RUNNING"`

    - `"INTERRUPTED"`

    - `"TERMINATED"`

    - `"TIMED_OUT"`

    - `"DELETED"`

  - `status_reason: optional string`

  - `task_metadata: optional map[unknown]`

  - `updated_at: optional string`

### Example

```http
curl http://localhost:5003/tasks/$TASK_ID/complete \
    -X POST \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

## Fail Task

**post** `/tasks/{task_id}/fail`

Mark a running task as failed.

### Path Parameters

- `task_id: string`

### Body Parameters

- `reason: optional string`

### Returns

- `Task object { id, cleaned_at, created_at, 6 more }`

  - `id: string`

  - `cleaned_at: optional string`

  - `created_at: optional string`

  - `name: optional string`

  - `params: optional map[unknown]`

  - `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

    - `"CANCELED"`

    - `"COMPLETED"`

    - `"FAILED"`

    - `"RUNNING"`

    - `"INTERRUPTED"`

    - `"TERMINATED"`

    - `"TIMED_OUT"`

    - `"DELETED"`

  - `status_reason: optional string`

  - `task_metadata: optional map[unknown]`

  - `updated_at: optional string`

### Example

```http
curl http://localhost:5003/tasks/$TASK_ID/fail \
    -X POST \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

## Cancel Task

**post** `/tasks/{task_id}/cancel`

Mark a running task as canceled.

### Path Parameters

- `task_id: string`

### Body Parameters

- `reason: optional string`

### Returns

- `Task object { id, cleaned_at, created_at, 6 more }`

  - `id: string`

  - `cleaned_at: optional string`

  - `created_at: optional string`

  - `name: optional string`

  - `params: optional map[unknown]`

  - `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

    - `"CANCELED"`

    - `"COMPLETED"`

    - `"FAILED"`

    - `"RUNNING"`

    - `"INTERRUPTED"`

    - `"TERMINATED"`

    - `"TIMED_OUT"`

    - `"DELETED"`

  - `status_reason: optional string`

  - `task_metadata: optional map[unknown]`

  - `updated_at: optional string`

### Example

```http
curl http://localhost:5003/tasks/$TASK_ID/cancel \
    -X POST \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

## Terminate Task

**post** `/tasks/{task_id}/terminate`

Mark a running task as terminated.

### Path Parameters

- `task_id: string`

### Body Parameters

- `reason: optional string`

### Returns

- `Task object { id, cleaned_at, created_at, 6 more }`

  - `id: string`

  - `cleaned_at: optional string`

  - `created_at: optional string`

  - `name: optional string`

  - `params: optional map[unknown]`

  - `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

    - `"CANCELED"`

    - `"COMPLETED"`

    - `"FAILED"`

    - `"RUNNING"`

    - `"INTERRUPTED"`

    - `"TERMINATED"`

    - `"TIMED_OUT"`

    - `"DELETED"`

  - `status_reason: optional string`

  - `task_metadata: optional map[unknown]`

  - `updated_at: optional string`

### Example

```http
curl http://localhost:5003/tasks/$TASK_ID/terminate \
    -X POST \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

## Timeout Task

**post** `/tasks/{task_id}/timeout`

Mark a running task as timed out.

### Path Parameters

- `task_id: string`

### Body Parameters

- `reason: optional string`

### Returns

- `Task object { id, cleaned_at, created_at, 6 more }`

  - `id: string`

  - `cleaned_at: optional string`

  - `created_at: optional string`

  - `name: optional string`

  - `params: optional map[unknown]`

  - `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

    - `"CANCELED"`

    - `"COMPLETED"`

    - `"FAILED"`

    - `"RUNNING"`

    - `"INTERRUPTED"`

    - `"TERMINATED"`

    - `"TIMED_OUT"`

    - `"DELETED"`

  - `status_reason: optional string`

  - `task_metadata: optional map[unknown]`

  - `updated_at: optional string`

### Example

```http
curl http://localhost:5003/tasks/$TASK_ID/timeout \
    -X POST \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

## Query Task Workflow

**get** `/tasks/{task_id}/query/{query_name}`

Query a Temporal workflow associated with a task for its current state.

### Path Parameters

- `task_id: string`

- `query_name: string`

### Example

```http
curl http://localhost:5003/tasks/$TASK_ID/query/$QUERY_NAME \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "foo": "bar"
}
```

## Interrupt Task

**post** `/tasks/{task_id}/interrupt`

Stop the in-flight turn without terminating the task. Transitions a running task to the non-terminal INTERRUPTED status; the task stays continuable and the next message or event resumes it.

### Path Parameters

- `task_id: string`

### Body Parameters

- `reason: optional string`

### Returns

- `Task object { id, cleaned_at, created_at, 6 more }`

  - `id: string`

  - `cleaned_at: optional string`

  - `created_at: optional string`

  - `name: optional string`

  - `params: optional map[unknown]`

  - `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

    - `"CANCELED"`

    - `"COMPLETED"`

    - `"FAILED"`

    - `"RUNNING"`

    - `"INTERRUPTED"`

    - `"TERMINATED"`

    - `"TIMED_OUT"`

    - `"DELETED"`

  - `status_reason: optional string`

  - `task_metadata: optional map[unknown]`

  - `updated_at: optional string`

### Example

```http
curl http://localhost:5003/tasks/$TASK_ID/interrupt \
    -X POST \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

## Domain Types

### Task

- `Task object { id, cleaned_at, created_at, 6 more }`

  - `id: string`

  - `cleaned_at: optional string`

  - `created_at: optional string`

  - `name: optional string`

  - `params: optional map[unknown]`

  - `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

    - `"CANCELED"`

    - `"COMPLETED"`

    - `"FAILED"`

    - `"RUNNING"`

    - `"INTERRUPTED"`

    - `"TERMINATED"`

    - `"TIMED_OUT"`

    - `"DELETED"`

  - `status_reason: optional string`

  - `task_metadata: optional map[unknown]`

  - `updated_at: optional string`

### Task Retrieve Response

- `TaskRetrieveResponse object { id, agents, cleaned_at, 7 more }`

  Task response model with optional related data based on relationships

  - `id: string`

  - `agents: optional array of Agent`

    - `id: string`

      The unique identifier of the agent.

    - `acp_type: AcpType`

      The type of the ACP Server (Either sync or async)

      - `"sync"`

      - `"async"`

      - `"agentic"`

    - `created_at: string`

      The timestamp when the agent was created

    - `description: string`

      The description of the action.

    - `name: string`

      The unique name of the agent.

    - `updated_at: string`

      The timestamp when the agent was last updated

    - `agent_input_type: optional "text" or "json"`

      The type of input the agent expects.

      - `"text"`

      - `"json"`

    - `production_deployment_id: optional string`

      ID of the current production deployment.

    - `registered_at: optional string`

      The timestamp when the agent was last registered

    - `registration_metadata: optional map[unknown]`

      The metadata for the agent's registration.

    - `status: optional "Ready" or "Failed" or "Unknown" or 3 more`

      The status of the action, indicating if it's building, ready, failed, etc.

      - `"Ready"`

      - `"Failed"`

      - `"Unknown"`

      - `"Deleted"`

      - `"Unhealthy"`

      - `"BuildOnly"`

    - `status_reason: optional string`

      The reason for the status of the action.

  - `cleaned_at: optional string`

  - `created_at: optional string`

  - `name: optional string`

  - `params: optional map[unknown]`

  - `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

    - `"CANCELED"`

    - `"COMPLETED"`

    - `"FAILED"`

    - `"RUNNING"`

    - `"INTERRUPTED"`

    - `"TERMINATED"`

    - `"TIMED_OUT"`

    - `"DELETED"`

  - `status_reason: optional string`

  - `task_metadata: optional map[unknown]`

  - `updated_at: optional string`

### Task List Response

- `TaskListResponse = array of object { id, agents, cleaned_at, 6 more }`

  - `id: string`

  - `agents: optional array of Agent`

    - `id: string`

      The unique identifier of the agent.

    - `acp_type: AcpType`

      The type of the ACP Server (Either sync or async)

      - `"sync"`

      - `"async"`

      - `"agentic"`

    - `created_at: string`

      The timestamp when the agent was created

    - `description: string`

      The description of the action.

    - `name: string`

      The unique name of the agent.

    - `updated_at: string`

      The timestamp when the agent was last updated

    - `agent_input_type: optional "text" or "json"`

      The type of input the agent expects.

      - `"text"`

      - `"json"`

    - `production_deployment_id: optional string`

      ID of the current production deployment.

    - `registered_at: optional string`

      The timestamp when the agent was last registered

    - `registration_metadata: optional map[unknown]`

      The metadata for the agent's registration.

    - `status: optional "Ready" or "Failed" or "Unknown" or 3 more`

      The status of the action, indicating if it's building, ready, failed, etc.

      - `"Ready"`

      - `"Failed"`

      - `"Unknown"`

      - `"Deleted"`

      - `"Unhealthy"`

      - `"BuildOnly"`

    - `status_reason: optional string`

      The reason for the status of the action.

  - `cleaned_at: optional string`

  - `created_at: optional string`

  - `name: optional string`

  - `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

    - `"CANCELED"`

    - `"COMPLETED"`

    - `"FAILED"`

    - `"RUNNING"`

    - `"INTERRUPTED"`

    - `"TERMINATED"`

    - `"TIMED_OUT"`

    - `"DELETED"`

  - `status_reason: optional string`

  - `task_metadata: optional map[unknown]`

  - `updated_at: optional string`

### Task Stream Events Response

- `TaskStreamEventsResponse = unknown`

### Task Retrieve By Name Response

- `TaskRetrieveByNameResponse object { id, agents, cleaned_at, 7 more }`

  Task response model with optional related data based on relationships

  - `id: string`

  - `agents: optional array of Agent`

    - `id: string`

      The unique identifier of the agent.

    - `acp_type: AcpType`

      The type of the ACP Server (Either sync or async)

      - `"sync"`

      - `"async"`

      - `"agentic"`

    - `created_at: string`

      The timestamp when the agent was created

    - `description: string`

      The description of the action.

    - `name: string`

      The unique name of the agent.

    - `updated_at: string`

      The timestamp when the agent was last updated

    - `agent_input_type: optional "text" or "json"`

      The type of input the agent expects.

      - `"text"`

      - `"json"`

    - `production_deployment_id: optional string`

      ID of the current production deployment.

    - `registered_at: optional string`

      The timestamp when the agent was last registered

    - `registration_metadata: optional map[unknown]`

      The metadata for the agent's registration.

    - `status: optional "Ready" or "Failed" or "Unknown" or 3 more`

      The status of the action, indicating if it's building, ready, failed, etc.

      - `"Ready"`

      - `"Failed"`

      - `"Unknown"`

      - `"Deleted"`

      - `"Unhealthy"`

      - `"BuildOnly"`

    - `status_reason: optional string`

      The reason for the status of the action.

  - `cleaned_at: optional string`

  - `created_at: optional string`

  - `name: optional string`

  - `params: optional map[unknown]`

  - `status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more`

    - `"CANCELED"`

    - `"COMPLETED"`

    - `"FAILED"`

    - `"RUNNING"`

    - `"INTERRUPTED"`

    - `"TERMINATED"`

    - `"TIMED_OUT"`

    - `"DELETED"`

  - `status_reason: optional string`

  - `task_metadata: optional map[unknown]`

  - `updated_at: optional string`

### Task Stream Events By Name Response

- `TaskStreamEventsByNameResponse = unknown`

### Task Query Workflow Response

- `TaskQueryWorkflowResponse = map[unknown]`