Start a task

curl --request POST \
  --url https://api.phylo.bio/api/v1/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "proj_a4374b138a",
  "title": "Quick variant lookup"
}
'

{
  "id": "sess_d9711ec9b477",
  "object": "task",
  "created": 1779132780,
  "status": "idle",
  "title": "BRCA1 variant clinical report",
  "platform": "api"
}

POST

tasks

curl --request POST \
  --url https://api.phylo.bio/api/v1/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "proj_a4374b138a",
  "title": "Quick variant lookup"
}
'

{
  "id": "sess_d9711ec9b477",
  "object": "task",
  "created": 1779132780,
  "status": "idle",
  "title": "BRCA1 variant clinical report",
  "platform": "api"
}

The Task shares the Project’s file Drive and starts in idle, doing nothing until you post the first message with POST /messages, which moves it to running (→ completed | failed | cancelled). Related: GET /tasks/{id} to poll status · POST /tasks/{id}/cancel to stop it.

Authorizations

Authorization

string

header

required

Requires an API key. See the Authentication guide.

Body

application/json

project_id

string

required

title

string | null

plan_mode

boolean

default:false

auto_mode

boolean

default:false

Response

201 - application/json

Task created (status starts as idle).

string

required

created

integer

required

status

enum<string>

required

Available options:

idle,

running,

completed,

cancelled,

failed

object

string

default:task

Allowed value: "task"

project_id

string | null

title

string | null

platform

enum<string>

default:api

Available options:

api,

mcp,

web,

desktop,

mobile

review_status

enum<string> | null

Available options:

running,

done,

failed

review_error

string | null

Guides

Reference

Authorizations

Body

Response