canvases

Call one declared connector tool as the viewer.

The canvas must declare the provider and tool in capabilities.connectors (the reviewed permission boundary); the call runs with the viewer's own connection, so two viewers of the same canvas see their own data.

post/api/projects/{project_id}/canvases/{id}/connectors/call/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/canvases/{id}/connectors/call/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this canvas.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

approval_tokenstring

Single-use token from a needs_approval response. Submit only after the viewer approves this exact call. Expires after 15 minutes.

providerstring required

Declared provider id, e.g. 'github'.

toolstring required

Declared tool name, e.g. 'list_pull_requests'.

argumentsobject

Tool arguments, validated against the tool's input schema.

Response

approval_tokenstring nullable required

Host-only, single-use approval token bound to this viewer, connection, canvas version, tool, and arguments. Never forward it to the canvas iframe.

status'ok' | 'not_connected' | 'needs_reauth' | 'needs_approval' | 'blocked' | 'tool_missing' | 'write_blocked' | 'upstream_error' required
  • ok - Ok
  • not_connected - Not Connected
  • needs_reauth - Needs Reauth
  • needs_approval - Needs Approval
  • blocked - Blocked
  • tool_missing - Tool Missing
  • write_blocked - Write Blocked
  • upstream_error - Upstream Error
resultobject nullable required

Tool output. Native tools return their documented shape; MCP tools return {content, structured_content, is_error}.

detailstring required

Human-readable explanation for a non-ok status.

truncatedboolean required

True when the result exceeded the size cap and was cut to a preview.

connect_pathstring nullable required

In-app path where the viewer can connect the provider, when that would help.

Changes

No recorded changes to this operation across all 1 revision of this API.