POST /tasks/{id}/run

Run task

Trigger the task's agent. Returns immediately; poll the run for the result. Requires `tasks:write`.

Authenticate with Authorization: Bearer obk_live_xxx. See authentication.

Parameters

Name	In	Type	Required	Description
`X-Workspace-Id`	header	string	required	The workspace to scope the request to. Can also be passed as a `workspace_id` query parameter.
`id`	path	string	required

Responses

202 Accepted

Field	Type	Description
`data`	object

Example request

curl --request POST \
  --url https://app.orchly.ai/api/v1/tasks/:id/run \
  --header 'Authorization: Bearer obk_live_xxx' \
  --header 'X-Workspace-Id: ws_xxx'

const res = await fetch(`https://app.orchly.ai/api/v1/tasks/${id}/run`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer obk_live_xxx',
    'X-Workspace-Id': 'ws_xxx',
  },
});
const data = await res.json();

import requests

resp = requests.post(
    "https://app.orchly.ai/api/v1/tasks/{id}/run",
    headers={
        "Authorization": "Bearer obk_live_xxx",
        "X-Workspace-Id": "ws_xxx",
    },
)
data = resp.json()