tasks
tasks

Run task

Create a new task run and kick off the workflow. The response is the refreshed task with the created run under the top-level run key: read run.id for anything run-scoped, such as the run's stream and command endpoints. The top-level id is the task's, and latest_run mirrors run only as long as nothing newer starts — reading either of those as the created run is deprecated.

post/api/projects/{project_id}/tasks/{id}/run/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/tasks/{id}/run/
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required
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/.

Headers

X-PostHog-Warm-Retrystring

Retry token from a warm_run_activation_unavailable response; prevents creating a replacement run.

Request body

OR
OR

Response

The refreshed task, plus the created run under the top-level run key

idstring uuid required
task_numberinteger nullable required
slugstring required
titlestring required
title_manually_setboolean required
descriptionstring required
origin_productstring required
runtime'acp' | 'pi' required
  • acp - ACP
  • pi - Pi
repositorystring nullable required
repositoriesstring[] required
github_integrationinteger nullable required
github_user_integrationstring uuid nullable required
signal_reportstring uuid nullable required
json_schemaobject nullable required
internalboolean required
archivedboolean required
archived_atstring date-time nullable required
created_atstring date-time nullable
updated_atstring date-time nullable
last_activity_atstring date-time nullable
ci_promptstring nullable required
channelstring uuid nullable
origin_keystring nullable

Stable key of the server-side flow that created this task, e.g. desktop_onboarding_session:<user_id>. Null for tasks people create themselves.

run_errorstring

Error returned when the run could not start.

Changes

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