Slack

Slack Canvases API

The Canvases API from Slack — 6 operation(s) for canvases.

Documentation GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /canvases.create Create a canvas · Create Canvas #

Ask an LLM

“How do I create a new standalone canvas in Slack?”

“Can a canvas be created with starting content already in it?”

Tell an agent

Create a canvas titled {title}.

Create canvas {title} with the content {document_content}.

POST /canvases.delete Delete a canvas · Delete Canvas #

Ask an LLM

“Can I permanently delete a canvas I no longer need?”

“What ID do I pass to remove a canvas?”

Tell an agent destructive · confirm first

Delete canvas {canvas_id}.

Remove the canvas {canvas_id} for good.

POST /canvases.edit Edit a canvas's content · Edit Canvas #

Ask an LLM

“How can I insert, replace or delete sections in an existing canvas?”

“Is it possible to apply several edits to a canvas in one call?”

Tell an agent

Apply changes {changes} to canvas {canvas_id}.

Edit canvas {canvas_id} by replacing sections with {changes}.

POST /canvases.access.delete Remove people's access to a canvas · Delete Canvas Access #

Ask an LLM

“How do I take away someone's access to a canvas?”

“Can I revoke canvas access for several users at once?”

Tell an agent

Remove access to canvas {canvas_id} for users {user_ids}.

Revoke canvas {canvas_id} access from {user_ids}.

POST /canvases.access.set Grant view or edit access to a canvas · Set Canvas Access #

Ask an LLM

“Can I give a channel read-only access to a canvas?”

“Which access levels can be granted on a canvas?”

Tell an agent

Give users {user_ids} {access_level} access to canvas {canvas_id}.

Set channels {channel_ids} to {access_level} on canvas {canvas_id}.

POST /canvases.sections.lookup Find sections in a canvas · Lookup Canvas Sections #

Ask an LLM

“How do I locate a specific section of a canvas before editing it?”

“Can I look up canvas sections by type, like headers?”

Tell an agent

Look up sections in canvas {canvas_id} matching {criteria}.

Find the header sections of canvas {canvas_id} using criteria {criteria}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/slack-canvases-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Slack Canvases API
  description: The Slack Canvases API lets apps programmatically create, edit, delete, and manage access to Slack Canvases, which are rich document surfaces embedded within Slack. Key methods include canvases.create for creating standalone canvases, canvases.edit for modifying content with operations like insert, replace, and delete, canvases.delete for removing canvases, and canvases.access.set and canvases.access.delete for managing who can view or edit a canvas.
  version: 1.0.0
  contact:
    name: Slack Developer Relations
    url: https://docs.slack.dev
servers:
- url: https://slack.com/api
tags:
- name: Canvases
paths:
  /canvases.create:
    post:
      tags:
      - Canvases
      summary: Create Canvas
      description: Creates a Slack Canvas.
      operationId: postCanvasesCreate
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `canvases:write`'
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: Title of the canvas.
                document_content:
                  type: object
                  description: Initial content for the canvas.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  canvas_id:
                    type: string
              example:
                ok: true
                canvas_id: F123ABC
        default:
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  error:
                    type: string
              example:
                ok: false
                error: invalid_auth
      security:
      - slackAuth:
        - canvases:write
  /canvases.delete:
    post:
      tags:
      - Canvases
      summary: Delete Canvas
      description: Deletes a Slack Canvas.
      operationId: postCanvasesDelete
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `canvases:write`'
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - canvas_id
              type: object
              properties:
                canvas_id:
                  type: string
                  description: ID of the canvas to delete.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
              example:
                ok: true
        default:
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  error:
                    type: string
              example:
                ok: false
                error: canvas_not_found
      security:
      - slackAuth:
        - canvases:write
  /canvases.edit:
    post:
      tags:
      - Canvases
      summary: Edit Canvas
      description: Edits a Slack Canvas by inserting, replacing, or deleting content sections.
      operationId: postCanvasesEdit
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `canvases:write`'
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - canvas_id
              - changes
              type: object
              properties:
                canvas_id:
                  type: string
                  description: ID of the canvas to edit.
                changes:
                  type: array
                  description: Array of change operations (insert_at_start, insert_at_end, insert_after, insert_before, replace, delete).
                  items:
                    type: object
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
              example:
                ok: true
        default:
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  error:
                    type: string
              example:
                ok: false
                error: canvas_not_found
      security:
      - slackAuth:
        - canvases:write
  /canvases.access.delete:
    post:
      tags:
      - Canvases
      summary: Delete Canvas Access
      description: Removes access to a canvas for specified users or groups.
      operationId: postCanvasesAccessDelete
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `canvases:write`'
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - canvas_id
              type: object
              properties:
                canvas_id:
                  type: string
                  description: ID of the canvas.
                user_ids:
                  type: array
                  description: User IDs to remove access for.
                  items:
                    type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
              example:
                ok: true
        default:
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  error:
                    type: string
              example:
                ok: false
                error: canvas_not_found
      security:
      - slackAuth:
        - canvases:write
  /canvases.access.set:
    post:
      tags:
      - Canvases
      summary: Set Canvas Access
      description: Sets access controls for a canvas, granting view or edit access to users or groups.
      operationId: postCanvasesAccessSet
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `canvases:write`'
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - canvas_id
              - access_level
              type: object
              properties:
                canvas_id:
                  type: string
                  description: ID of the canvas.
                access_level:
                  type: string
                  description: Access level to grant (read, write).
                  enum:
                  - read
                  - write
                user_ids:
                  type: array
                  description: User IDs to grant access to.
                  items:
                    type: string
                channel_ids:
                  type: array
                  description: Channel IDs to grant access to.
                  items:
                    type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
              example:
                ok: true
        default:
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  error:
                    type: string
              example:
                ok: false
                error: canvas_not_found
      security:
      - slackAuth:
        - canvases:write
  /canvases.sections.lookup:
    post:
      tags:
      - Canvases
      summary: Lookup Canvas Sections
      description: Looks up sections in a canvas by type or criteria.
      operationId: postCanvasesSectionsLookup
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `canvases:read`'
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - canvas_id
              - criteria
              type: object
              properties:
                canvas_id:
                  type: string
                  description: ID of the canvas to search in.
                criteria:
                  type: object
                  description: Search criteria for finding sections.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  sections:
                    type: array
                    items:
                      type: object
              example:
                ok: true
                sections: []
        default:
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  error:
                    type: string
              example:
                ok: false
                error: canvas_not_found
      security:
      - slackAuth:
        - canvases:read
components:
  securitySchemes:
    slackAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://slack.com/oauth/v2/authorize
          tokenUrl: https://slack.com/api/oauth.v2.access
          scopes:
            canvases:read: Read canvases
            canvases:write: Write canvases

Slack Canvases API

Operations 6

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification