wizard

Create a local or cloud Wizard run for a project workspace.

post/api/projects/{project_id}/wizard/runs/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/wizard/runs/
  • Auth: HTTP bearer

Path parameters

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

program_idstring required

Registry program to run.

environment'local' | 'cloud' required
  • local - local
  • cloud - cloud
idempotency_keystring

Unique key that makes cloud run creation safe to retry.

wizard_versionstring

Wizard package version to run. Defaults to the backend pin and accepts latest explicitly.

Response

idstring uuid required

Unique ID of the Wizard run.

team_idinteger required

Project that owns the Wizard run.

created_by_idinteger nullable required

User who created the Wizard run, or null if that user no longer exists.

environment'local' | 'cloud' required
  • local - local
  • cloud - cloud
status'created' | 'running' | 'completed' | 'failed' | 'cancelled' required
  • created - created
  • running - running
  • completed - completed
  • failed - failed
  • cancelled - cancelled
error_codestring nullable required

Machine-readable failure reason, or null if the run has not failed.

error_messagestring nullable required

Safe failure explanation, or null if the run has not failed.

created_atstring date-time required

When the Wizard run was created.

updated_atstring date-time nullable required

When the run last changed.

started_atstring date-time nullable required

When execution started, or null while queued.

finished_atstring date-time nullable required

When execution reached a terminal status, or null while active.

deadline_atstring date-time nullable required

Cloud execution deadline, or null for local runs.

Changes

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