Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get an agent — response body — data data — sdk__Agent Response
next_pageModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
resource_subtypestringOptionalThe subtype of the agent. `asana_teammate` is an Asana-built teammate.
Known values: asana_teammate
Read only: true
namestringOptionalThe display name of the agent.
Read only: true

Get an agent — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootA map of the agent's avatar image in various sizes, or null if no photo is set.
Read only: true
image_21x21stringOptionalPNG image at 21x21 pixels.
Format: uri
image_27x27stringOptionalPNG image at 27x27 pixels.
Format: uri
image_36x36stringOptionalPNG image at 36x36 pixels.
Format: uri
image_60x60stringOptionalPNG image at 60x60 pixels.
Format: uri
image_128x128stringOptionalPNG image at 128x128 pixels.
Format: uri
image_1024x1024stringOptionalJPEG image at 1024x1024 pixels.
Format: uri

Get an agent — response body — data data — Agent Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a list of agents in a workspace — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).descriptionJSONOptional
$ (allOf 2).description (anyOf 1)stringAlternativeA brief description of what the agent does.
Read only: true
$ (allOf 2).description (anyOf 2)nullAlternative
$ (allOf 2).behavior_guidanceJSONOptional
$ (allOf 2).behavior_guidance (anyOf 1)stringAlternativeA description of the agent's behavior.
Read only: true
$ (allOf 2).behavior_guidance (anyOf 2)nullAlternative
$ (allOf 2).workspaceJSONOptionalThe workspace this agent is instantiated within.
Read only: true
$ (allOf 2).workspace (allOf 1)ModelAll variants applyExpand Update a workspace — request body — body data
$ (allOf 2).workspace (allOf 2)objectAll variants apply
$ (allOf 2).photoJSONOptional
$ (allOf 2).photo (anyOf 1)ModelAlternativeExpand 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)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
resource_subtypestringOptionalThe subtype of the agent. `asana_teammate` is an Asana-built teammate.
Known values: asana_teammate
Read only: true
namestringOptionalThe display name of the agent.
Read only: true
descriptionJSONOptional
description (anyOf 1)stringAlternativeA brief description of what the agent does.
Read only: true
description (anyOf 2)nullAlternative
behavior_guidanceJSONOptional
behavior_guidance (anyOf 1)stringAlternativeA description of the agent's behavior.
Read only: true
behavior_guidance (anyOf 2)nullAlternative
workspaceJSONOptionalThe workspace this agent is instantiated within.
Read only: true
workspace (allOf 1)ModelAll variants applyExpand Get a tag — response body — data data workspace
workspace (allOf 2)objectAll variants apply
photoJSONOptional
photo (anyOf 1)ModelAlternativeExpand Get an agent — response body — data data photo image 1024x1024, image 128x128, image 21x21, image 27x27, image 36x36, image 60x60
photo (anyOf 2)nullAlternative

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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.