Agents

AgentCompact

PropertyTypeDescription
gidstringGlobally unique identifier of the resource, as a string.
resource_typestringThe base type of this resource.
resource_subtypestringThe subtype of the agent. asana_teammate is an Asana-built teammate.
Click to show all enum values
  • asana_teammate
namestringThe display name of the agent.

Example JSON for AgentCompact:

{
  "gid": "12345",
  "resource_type": "agent",
  "resource_subtype": "asana_teammate",
  "name": "Developer Blog Writer"
}

Agent

PropertyTypeDescription
gidstringGlobally unique identifier of the resource, as a string.
resource_typestringThe base type of this resource.
resource_subtypestringThe subtype of the agent. asana_teammate is an Asana-built teammate.
Click to show all enum values
  • asana_teammate
namestringThe display name of the agent.
descriptionstringA brief description of what the agent does.
behavior_guidancestringA description of the agent's behavior.
workspaceobjectThe workspace this agent is instantiated within.
workspace.gidstringGlobally unique identifier of the resource, as a string.
workspace.resource_typestringThe base type of this resource.
workspace.namestringThe name of the workspace.
photoobjectA map of the agent's avatar image in various sizes, or null if no photo is set.
photo.image_21x21string (uri)PNG image at 21x21 pixels.
photo.image_27x27string (uri)PNG image at 27x27 pixels.
photo.image_36x36string (uri)PNG image at 36x36 pixels.
photo.image_60x60string (uri)PNG image at 60x60 pixels.
photo.image_128x128string (uri)PNG image at 128x128 pixels.
photo.image_1024x1024string (uri)JPEG image at 1024x1024 pixels.

Example JSON for Agent:

{
  "gid": "12345",
  "resource_type": "agent",
  "resource_subtype": "asana_teammate",
  "name": "Developer Blog Writer",
  "description": "example string",
  "behavior_guidance": "example string",
  "workspace": {
    "gid": "12345",
    "resource_type": "workspace",
    "name": "My Company Workspace"
  },
  "photo": {
    "image_21x21": "https://...",
    "image_27x27": "https://...",
    "image_36x36": "https://...",
    "image_60x60": "https://...",
    "image_128x128": "https://...",
    "image_1024x1024": "https://..."
  }
}