Skip to main content

agents.conversations.getCanvas method

Facts​

DescriptionFetch a canvas attached to a code channel.
Method Access
POST https://slack.com/api/agents.conversations.getCanvas
Scopes
Content types
application/x-www-form-urlencoded
application/json

Arguments​

Required arguments

tokenstringRequired

Authentication token bearing the code_channels:manage scope. Must be a granular bot token.

Example: xxxx-xxxxxxxxx-xxxx
channelstringRequired

ID of the agent session channel the canvas belongs to.

canvas_idRequired

Encoded ID of the canvas to fetch.

Optional arguments

content_formatstringOptional

Format to render the canvas content in. Defaults to markdown.

Default: markdown
Acceptable values: markdown
include_resolvedbooleanOptional

Whether to include resolved comment threads in the response. Defaults to false.

Usage info​

Returns the canvas content (as markdown) and its open comment threads. Each thread includes the quoted (highlighted) canvas text the comment is anchored to and its threaded replies.

The response is capped at the 100 most recent comment threads, and within each thread the 100 most recent replies (the top-level comment is always included). Threads and replies are ordered oldest first. The has_more_comments and has_more_replies properties indicate when older items were dropped.

A common pattern for a comment-only plan canvas: attach the canvas as a view with the agents.conversations.setView API method using type: "canvas" and access_level: "comment", call this method at each turn to read the unresolved comments and fold them into your agent's context, then write the revised document back with the agents.conversations.setCanvasContent API method, which preserves the comment anchors on the sections you didn't change.

Example request​

POST /api/agents.conversations.getCanvas
{
"channel": "C9876543210",
"canvas_id": "F1234567890",
"include_resolved": false
}

Response​

Typical success response

{
"ok": true,
"canvas_id": "F1234567890",
"title": "Migration plan",
"content": "# Migration plan\n\n1. Inventory cron jobs…",
"comments": [
{
"id": "An12345",
"ts": "1717180000.000100",
"user_id": "U2345678901",
"text": "Can we do the billing jobs last?",
"quoted_text": "1. Inventory cron jobs",
"is_resolved": false,
"replies": [
{
"ts": "1717180100.000200",
"user_id": "U3456789012",
"text": "+1, those are the riskiest"
}
],
"has_more_replies": false
}
],
"has_more_comments": false
}

Typical error response

{
"ok": false,
"error": "canvas_not_found"
}

Errors​

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok parameter in the response.

Error
Description
access_denied

Access to a resource specified in the request is denied.

accesslimited

Access to this method is limited on the current network

account_inactive

Authentication token is for a deleted user or workspace when using a bot token.

canvas_content_fetch_failed

The canvas content could not be fetched or rendered.

canvas_not_found

The specified canvas_id does not correspond to a canvas you can access.

channel_not_found

The specified channel does not correspond to a valid channel.

comments_fetch_failed

The canvas comment threads could not be fetched.

deprecated_endpoint

The endpoint has been deprecated.

ekm_access_denied

Administrators have suspended the ability to post a message.

enterprise_is_restricted

The method cannot be called from an Enterprise.

fatal_error

The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.

internal_error

The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.

invalid_arg_name

The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.

invalid_arguments

The method was called with invalid arguments.

invalid_array_arg

The method was passed an array as an argument. Please only input valid strings.

invalid_auth

Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.

invalid_charset

The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

invalid_form_data

The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

invalid_post_type

The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.

method_deprecated

The method has been deprecated.

missing_argument

A required argument was not provided. The response's arg field names the missing argument. Arguments sent in a JSON body are ignored by methods that don't list application/json as a content type.

missing_post_type

The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

missing_scope

The token used is not granted the specific scope permissions required to complete this request.

no_permission

The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.

not_agent_channel

The specified channel is not an agent session channel.

not_allowed_token_type

The token type used in this request is not allowed.

not_authed

No authentication token provided.

not_authorized

The caller is not an authorized agent bot for this channel.

org_login_required

The workspace is undergoing an enterprise migration and will not be available until migration is complete.

ratelimited

The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

request_timeout

The method was called via a POST request, but the POST data was either missing or truncated.

service_unavailable

The service is temporarily unavailable

team_access_not_granted

The token used is not granted the specific workspace access required to complete this request.

team_added_to_org

The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

token_expired

Authentication token has expired

token_revoked

Authentication token is for a deleted user or workspace or the app has been removed when using a user token.

two_factor_setup_required

Two factor setup is required.