canvas-actions
Read Canvas Instructions
Read the canvas’s agent instructions (authoring guidance the agent lane injects).
agent_instructions is null when none are authored. Id-authenticated
(team) reads only — instructions never surface on share-token paths.
GET
Read Canvas Instructions
Authorizations
API key from Settings > Developer > REST API
Headers
Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.
Available options:
2026-04-12, 2026-05-01 Example:
"2026-05-01"
Path Parameters
Response
Successful Response
The response is of type Response Canvasactionsreadinstructions · object.