Task-runs API Reference

Task-runs

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

`GET`
`POST`
`GET`
`PATCH`
`POST`
`POST`
`POST`
`POST`
`GET`
`GET`
`POST`
`GET`
`PATCH`
`GET`

List all tasks runs

Get a list of runs for a specific task.

Required API key scopes

task:read

Path parameters

project_id
string
task_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/tasks/:task_id/runs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/".format(
        project_id=project_id,
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 List of task runs

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "task": "4879b8a6-fb3e-4a0d-aef8-b0ea469ac85c",
      "stage": "string",
      "branch": "string",
      "status": "not_started",
      "environment": "local",
      "log_url": "string",
      "error_message": "string",
      "output": null,
      "state": null,
      "artifacts": [
        {
          "name": "string",
          "type": "string",
          "size": 0,
          "content_type": "string",
          "storage_path": "string",
          "uploaded_at": "string"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "completed_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create tasks runs

Create a new run for a specific task.

Required API key scopes

task:write

Path parameters

project_id
string
task_id
string

Response

Example request

POST /api/projects/:project_id/tasks/:task_id/runs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/".format(
        project_id=project_id,
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 201 Created task run

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "task": "4879b8a6-fb3e-4a0d-aef8-b0ea469ac85c",
  "stage": "string",
  "branch": "string",
  "status": "not_started",
  "environment": "local",
  "log_url": "string",
  "error_message": "string",
  "output": null,
  "state": null,
  "artifacts": [
    {
      "name": "string",
      "type": "string",
      "size": 0,
      "content_type": "string",
      "storage_path": "string",
      "uploaded_at": "string"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}

Retrieve tasks runs

API for managing task runs. Each run represents an execution of a task.

Required API key scopes

task:read

Path parameters

id
string
project_id
string
task_id
string

Response

Example request

GET /api/projects/:project_id/tasks/:task_id/runs/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/{task-run_id}/".format(
        project_id=project_id,
		task-run_id="<the task-run id>",
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "task": "4879b8a6-fb3e-4a0d-aef8-b0ea469ac85c",
  "stage": "string",
  "branch": "string",
  "status": "not_started",
  "environment": "local",
  "log_url": "string",
  "error_message": "string",
  "output": null,
  "state": null,
  "artifacts": [
    {
      "name": "string",
      "type": "string",
      "size": 0,
      "content_type": "string",
      "storage_path": "string",
      "uploaded_at": "string"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}

Update tasks runs

API for managing task runs. Each run represents an execution of a task.

Required API key scopes

task:write

Path parameters

id
string
project_id
string
task_id
string

Request parameters

status
branch
string
stage
string
output
state
error_message
string

Response

Example request

PATCH /api/projects/:project_id/tasks/:task_id/runs/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/:id/\
	-d status=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/{task-run_id}/".format(
        project_id=project_id,
		task-run_id="<the task-run id>",
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200 Updated task run

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "task": "4879b8a6-fb3e-4a0d-aef8-b0ea469ac85c",
  "stage": "string",
  "branch": "string",
  "status": "not_started",
  "environment": "local",
  "log_url": "string",
  "error_message": "string",
  "output": null,
  "state": null,
  "artifacts": [
    {
      "name": "string",
      "type": "string",
      "size": 0,
      "content_type": "string",
      "storage_path": "string",
      "uploaded_at": "string"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}

Status 400 Invalid update data

RESPONSE
{
  "error": "string"
}

Status 404 Task run not found

Create tasks runs append log

Append one or more log entries to the task run log array

Required API key scopes

task:write

Path parameters

id
string
project_id
string
task_id
string

Request parameters

entries
array

Response

Example request

POST /api/projects/:project_id/tasks/:task_id/runs/:id/append_log
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/:id/append_log/\
	-d entries="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/{task-run_id}/append_log/".format(
        project_id=project_id,
		task-run_id="<the task-run id>",
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"entries": "array"
	}
).json()

Example response

Status 200 Run with updated log

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "task": "4879b8a6-fb3e-4a0d-aef8-b0ea469ac85c",
  "stage": "string",
  "branch": "string",
  "status": "not_started",
  "environment": "local",
  "log_url": "string",
  "error_message": "string",
  "output": null,
  "state": null,
  "artifacts": [
    {
      "name": "string",
      "type": "string",
      "size": 0,
      "content_type": "string",
      "storage_path": "string",
      "uploaded_at": "string"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}

Status 400 Invalid log entries

RESPONSE
{
  "error": "string"
}

Status 404 Run not found

Create tasks runs artifacts

Persist task artifacts to S3 and attach them to the run manifest.

Required API key scopes

task:write

Path parameters

id
string
project_id
string
task_id
string

Request parameters

artifacts
array

Response

Example request

POST /api/projects/:project_id/tasks/:task_id/runs/:id/artifacts
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/\
	-d artifacts="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/{task-run_id}/artifacts/".format(
        project_id=project_id,
		task-run_id="<the task-run id>",
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"artifacts": "array"
	}
).json()

Example response

Status 200 Run with updated artifact manifest

RESPONSE
{
  "artifacts": [
    {
      "name": "string",
      "type": "string",
      "size": 0,
      "content_type": "string",
      "storage_path": "string",
      "uploaded_at": "string"
    }
  ]
}

Status 400 Invalid artifact payload

RESPONSE
{
  "error": "string"
}

Status 404 Run not found

Create tasks runs artifacts presign

Returns a temporary, signed URL that can be used to download a specific artifact.

Required API key scopes

task:read

Path parameters

id
string
project_id
string
task_id
string

Request parameters

storage_path
string

Response

Example request

POST /api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/presign
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/presign/\
	-d storage_path="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/{task-run_id}/artifacts/presign/".format(
        project_id=project_id,
		task-run_id="<the task-run id>",
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"storage_path": "string"
	}
).json()

Example response

Status 200 Presigned URL for the requested artifact

RESPONSE
{
  "url": "http://example.com",
  "expires_in": 0
}

Status 400 Invalid request

RESPONSE
{
  "error": "string"
}

Status 404 Artifact not found

Create tasks runs command

Forward a JSON-RPC command to the agent server running in the sandbox. Supports user_message, cancel, and close commands.

Required API key scopes

task:write

Path parameters

id
string
project_id
string
task_id
string

Request parameters

jsonrpc
method
params
object
id

Response

Example request

POST /api/projects/:project_id/tasks/:task_id/runs/:id/command
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/:id/command/\
	-d jsonrpc=undefined,\
	-d method=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/{task-run_id}/command/".format(
        project_id=project_id,
		task-run_id="<the task-run id>",
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200 Agent server response

RESPONSE
{
  "jsonrpc": "string",
  "id": null,
  "result": {
    "property1": null,
    "property2": null
  },
  "error": {
    "property1": null,
    "property2": null
  }
}

Status 400 Invalid command or no active sandbox

RESPONSE
{
  "error": "string"
}

Status 404 Task run not found

Status 502 Agent server unreachable

RESPONSE
{
  "error": "string"
}

Retrieve tasks runs connection token

Generate a JWT token for direct connection to the sandbox. Valid for 24 hours.

Required API key scopes

task:read

Path parameters

id
string
project_id
string
task_id
string

Response

Example request

GET /api/projects/:project_id/tasks/:task_id/runs/:id/connection_token
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/:id/connection_token/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/{task-run_id}/connection_token/".format(
        project_id=project_id,
		task-run_id="<the task-run id>",
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 Connection token for direct sandbox connection

RESPONSE
{
  "token": "string"
}

Status 404 Task run not found

Retrieve tasks runs logs

Fetch the logs for a task run. Returns JSONL formatted log entries.

Required API key scopes

task:read

Path parameters

id
string
project_id
string
task_id
string

Example request

GET /api/projects/:project_id/tasks/:task_id/runs/:id/logs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/:id/logs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/{task-run_id}/logs/".format(
        project_id=project_id,
		task-run_id="<the task-run id>",
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 Log content in JSONL format

Status 404 Task run not found

Create tasks runs relay message

Queue a Slack relay workflow to post a run message into the mapped Slack thread.

Required API key scopes

task:write

Path parameters

id
string
project_id
string
task_id
string

Request parameters

text
string

Response

Example request

POST /api/projects/:project_id/tasks/:task_id/runs/:id/relay_message
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/:id/relay_message/\
	-d text="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/{task-run_id}/relay_message/".format(
        project_id=project_id,
		task-run_id="<the task-run id>",
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"text": "string"
	}
).json()

Example response

Status 200 Relay accepted

RESPONSE
{
  "status": "string",
  "relay_id": "string"
}

Status 404 Run not found

Retrieve tasks runs session logs

Fetch session log entries for a task run with optional filtering by timestamp, event type, and limit.

Required API key scopes

task:read

Path parameters

id
string
project_id
string
task_id
string

Query parameters

after
string
event_types
string
exclude_types
string
limit
integer
Default: 1000

Example request

GET /api/projects/:project_id/tasks/:task_id/runs/:id/session_logs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/:id/session_logs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/{task-run_id}/session_logs/".format(
        project_id=project_id,
		task-run_id="<the task-run id>",
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 Filtered log events as JSON array

Status 404 Task run not found

Update tasks runs set output

Update the output field for a task run (e.g., PR URL, commit SHA, etc.)

Required API key scopes

task:write

Path parameters

id
string
project_id
string
task_id
string

Response

Example request

PATCH /api/projects/:project_id/tasks/:task_id/runs/:id/set_output
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/:id/set_output/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/{task-run_id}/set_output/".format(
        project_id=project_id,
		task-run_id="<the task-run id>",
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 Run with updated output

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "task": "4879b8a6-fb3e-4a0d-aef8-b0ea469ac85c",
  "stage": "string",
  "branch": "string",
  "status": "not_started",
  "environment": "local",
  "log_url": "string",
  "error_message": "string",
  "output": null,
  "state": null,
  "artifacts": [
    {
      "name": "string",
      "type": "string",
      "size": 0,
      "content_type": "string",
      "storage_path": "string",
      "uploaded_at": "string"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}

Status 404 Run not found

Retrieve tasks runs stream

API for managing task runs. Each run represents an execution of a task.

Required API key scopes

task:read

Path parameters

id
string
project_id
string
task_id
string

Response

Example request

GET /api/projects/:project_id/tasks/:task_id/runs/:id/stream
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/tasks/:task_id/runs/:id/stream/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/tasks/{task_id}/runs/{task-run_id}/stream/".format(
        project_id=project_id,
		task-run_id="<the task-run id>",
		task_id="<the task id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "task": "4879b8a6-fb3e-4a0d-aef8-b0ea469ac85c",
  "stage": "string",
  "branch": "string",
  "status": "not_started",
  "environment": "local",
  "log_url": "string",
  "error_message": "string",
  "output": null,
  "state": null,
  "artifacts": [
    {
      "name": "string",
      "type": "string",
      "size": 0,
      "content_type": "string",
      "storage_path": "string",
      "uploaded_at": "string"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}