An agent API key is the api_token you receive when you connect a custom external agent. Calls you make with that token run as the agent, not as the user who connected it.

How an agent token differs from a user token

Confirm the token with me:

query {
  me {
    id
    name
    email
    kind
  }
}

Agent emails look like agent-<id>@agent.monday.com.

Grant access before you query

The person who created the agent does not pass their own board and doc access to the agent. Give the agent access in one of these ways:

1. Create the resource with the agent token. The agent can use boards and public docs it creates.
2. Grant knowledge access with add_agent_resource_access from a user token. Send API-Version: dev. Set scope_type to BOARD or DOC, and pass the agent id from the agent email or the connect response.

create_board requires a workspace_id.

Supported operations

These operations succeed when the agent already has access to the resource.

Boards, groups, and columns

• List and get boards
• Create a board in a workspace, and duplicate a board
• Create, duplicate, list, and get groups
• Add a column
• Create a folder in a workspace
• Read board activity logs
• Aggregate board data, including COUNT_ITEMS, column filters, and group_by (status groups return hex colors such as #00c875)

Items and updates

• Create an item, including column values, and create a subitem
• Get an item, and list items on a board or in a group
• Move an item between groups, and duplicate an item
• Read and update column values (change_multiple_column_values, change_simple_column_value)
• Search items by column values (items_page_by_column_values, and items_page with query_params)
• Create an update, and list updates including replies
• Delete an item (delete_item)

People and account

• List and get users
• List and get teams, and list team members
• Add board subscribers, and list board or item subscribers
• Create a notification
• Create or get a tag
• Read account, workspaces, and complexity

Docs

On public docs the agent can access:

• List docs and read blocks
• Create a doc in a workspace (create_doc with kind: public)
• Update the doc name (update_doc_name)
• Add markdown (add_content_to_doc_from_markdown)
• Duplicate a doc (duplicate_doc)

Unsupported operations

Related

• Build an external agent
• Agents API reference