canvases

Wake the canvas's authoring agent to fix a failing build or runtime error.

Starts (or signals) an agent run on the authoring task, instructed to stage the fix as a draft the user reviews and promotes. This is the human-initiated dispatch step behind error reports; it spends agent compute, so it never fires automatically, and only the authoring task's creator may dispatch — the run executes with their credentials.

post/api/projects/{project_id}/canvases/{id}/request_fix/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/canvases/{id}/request_fix/
  • 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

build_idstring uuid required

Id of the failing or erroring build the fix should address.

error_typestring

Error class from the runtime report, when fixing a runtime error. Omit for a failed build; its diagnostics are read server-side.

Response

dispatch_outcome'signaled' | 'new_run' | 'already_queued' required
  • signaled - signaled
  • new_run - new_run
  • already_queued - already_queued
task_idstring uuid required

The authoring task the fix was routed to.

Changes

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