{ "opencollection": "1.0.0", "info": { "name": "PostHog actions task-runs API", "version": "1.0.0" }, "items": [ { "info": { "name": "task-runs", "type": "folder" }, "items": [ { "info": { "name": "List task runs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a list of runs for a specific task." }, { "info": { "name": "Create task run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new run for a specific task without starting execution." }, { "info": { "name": "tasks_runs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "API for managing task runs. Each run represents an execution of a task." }, { "info": { "name": "Update task run", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "API for managing task runs. Each run represents an execution of a task." }, { "info": { "name": "Append log entries", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/append_log/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Append one or more log entries to the task run log array" }, { "info": { "name": "Upload artifacts for a task run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Persist task artifacts to S3 and attach them to the run manifest." }, { "info": { "name": "Download an artifact through the backend", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/download/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Streams artifact content for a task run artifact after validating that it belongs to the run." }, { "info": { "name": "Finalize direct uploads for task run artifacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/finalize_upload/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Verify directly uploaded S3 objects and attach them to the run artifact manifest." }, { "info": { "name": "Prepare direct uploads for task run artifacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/prepare_upload/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reserve S3 object keys for task artifacts and return presigned POST forms for direct uploads." }, { "info": { "name": "Generate presigned URL for an artifact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/presign/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a temporary, signed URL that can be used to download a specific artifact." }, { "info": { "name": "Send command to agent server", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/command/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Forward a JSON-RPC command to the agent server running in the sandbox. Supports user_message, cancel, close, permission_response, and set_config_option commands." }, { "info": { "name": "Get sandbox connection token", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/connection_token/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate a JWT token for direct connection to the sandbox. Valid for 24 hours." }, { "info": { "name": "Get task run logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/logs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch the logs for a task run as JSONL. If the run resumes from another (state.resume_from_run_id), each ancestor's log is concatenated first (oldest ancestor → ... → this run) so resume consumers see a single continuous history and can find the most recent git_checkpoint event regardless of which run emitted it." }, { "info": { "name": "Relay run message to Slack", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/relay_message/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Queue a Slack relay workflow to post a run message into the mapped Slack thread." }, { "info": { "name": "Resume task run in cloud", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/resume_in_cloud/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Resume an existing task run in a cloud sandbox. Terminates any existing workflow and starts a new one." }, { "info": { "name": "Get filtered task run session logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/session_logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return events after this ISO8601 timestamp" }, { "name": "event_types", "value": "", "type": "query", "description": "Comma-separated list of event types to include" }, { "name": "exclude_types", "value": "", "type": "query", "description": "Comma-separated list of event types to exclude" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of entries to return (default 1000, max 5000)" }, { "name": "offset", "value": "", "type": "query", "description": "Zero-based offset into the filtered log entries" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch session log entries for a task run with optional filtering by timestamp, event type, and limit." }, { "info": { "name": "Set run output", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/set_output/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the output field for a task run (e.g., PR URL, commit SHA, etc.)" }, { "info": { "name": "Start task run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/start/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Start an existing cloud run after any initial run-scoped attachments have been uploaded." }, { "info": { "name": "tasks_runs_stream_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/stream/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "API for managing task runs. Each run represents an execution of a task." } ] } ], "bundled": true }