## 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"
}
```