Asana: Agents schemas
6 Asana schemas with complete fields and constraints.
← Agents operations · All schemas
Get a list of agents in a workspace — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get an agent — response body — data data — sdk__Agent Response |
next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
Referenced models: Get goals — response body — data, next page next page, Get an agent — response body — data data — sdk__Agent Response
Get a list of agents in a workspace — response body — data, next page data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
resource_subtype | string | Optional | The subtype of the agent. `asana_teammate` is an Asana-built teammate. Known values: asana_teammate Read only: true |
name | string | Optional | The display name of the agent. Read only: true |
Get an agent — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get an agent — response body — data data — sdk__Agent Response |
Referenced models: Get an agent — response body — data data — sdk__Agent Response
Get an agent — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A map of the agent's avatar image in various sizes, or null if no photo is set. Read only: true |
image_21x21 | string | Optional | PNG image at 21x21 pixels. Format: uri |
image_27x27 | string | Optional | PNG image at 27x27 pixels. Format: uri |
image_36x36 | string | Optional | PNG image at 36x36 pixels. Format: uri |
image_60x60 | string | Optional | PNG image at 60x60 pixels. Format: uri |
image_128x128 | string | Optional | PNG image at 128x128 pixels. Format: uri |
image_1024x1024 | string | Optional | JPEG image at 1024x1024 pixels. Format: uri |
Get an agent — response body — data data — Agent Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a list of agents in a workspace — response body — data, next page data item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).description | JSON | Optional | |
$ (allOf 2).description (anyOf 1) | string | Alternative | A brief description of what the agent does. Read only: true |
$ (allOf 2).description (anyOf 2) | null | Alternative | |
$ (allOf 2).behavior_guidance | JSON | Optional | |
$ (allOf 2).behavior_guidance (anyOf 1) | string | Alternative | A description of the agent's behavior. Read only: true |
$ (allOf 2).behavior_guidance (anyOf 2) | null | Alternative | |
$ (allOf 2).workspace | JSON | Optional | The workspace this agent is instantiated within. Read only: true |
$ (allOf 2).workspace (allOf 1) | Model | All variants apply | Expand Update a workspace — request body — body data |
$ (allOf 2).workspace (allOf 2) | object | All variants apply | |
$ (allOf 2).photo | JSON | Optional | |
$ (allOf 2).photo (anyOf 1) | Model | Alternative | Expand Get an agent — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60 |
$ (allOf 2).photo (anyOf 2) | null | Alternative |
Referenced models: Get a list of agents in a workspace — response body — data, next page data item, Update a workspace — request body — body data, Get an agent — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60
Get an agent — response body — data data — sdk__Agent Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
resource_subtype | string | Optional | The subtype of the agent. `asana_teammate` is an Asana-built teammate. Known values: asana_teammate Read only: true |
name | string | Optional | The display name of the agent. Read only: true |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | A brief description of what the agent does. Read only: true |
description (anyOf 2) | null | Alternative | |
behavior_guidance | JSON | Optional | |
behavior_guidance (anyOf 1) | string | Alternative | A description of the agent's behavior. Read only: true |
behavior_guidance (anyOf 2) | null | Alternative | |
workspace | JSON | Optional | The workspace this agent is instantiated within. Read only: true |
workspace (allOf 1) | Model | All variants apply | Expand Get a tag — response body — data data workspace |
workspace (allOf 2) | object | All variants apply | |
photo | JSON | Optional | |
photo (anyOf 1) | Model | Alternative | Expand Get an agent — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60 |
photo (anyOf 2) | null | Alternative |
Referenced models: Get an agent — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60, Get a tag — response body — data data workspace