Pimsy LLM

Tasks API

Conceptual

Create, inspect, control and cancel tasks.

POST/v1/tasks— Create a task
GET/v1/tasks— List tasks
GET/v1/tasks/{id}— Retrieve a task
PATCH/v1/tasks/{id}— Adjust budget, approvals or webhook
POST/v1/tasks/{id}/cancel— Cancel at the next step boundary
POST/v1/tasks/{id}/messages— Inject guidance into a running task

Request body#

objectivestringrequired
The outcome to achieve.
projectIdstring
Bind the task to a project context.
capabilitiesstring[]
Requested scopes; intersected with key and policy.
budgetobjectdefault: plan default
steps, wallClockSeconds, toolCalls, usd.
approvalsobject
required[], mode, timeout, onTimeout.
completionobject
criteria[] evaluated before the task may close.
attachmentsAttachment[]
Files or datasets available to the run.
scheduleobject
cron or runAt with timezone.
dryRunbooleandefault: false
Return the plan without executing.
webhookUrlstring
Lifecycle callback destination.

Response#

json
{
  class="tok-str">"id": class="tok-str">"task_8fk21",
  class="tok-str">"object": class="tok-str">"task",
  class="tok-str">"status": class="tok-str">"planning",
  class="tok-str">"run_id": class="tok-str">"run_7c1a9d",
  class="tok-str">"created_at": class="tok-str">"class="tok-num">2026-class="tok-num">09-15T10:class="tok-num">22:41Z",
  class="tok-str">"budget": { class="tok-str">"steps": class="tok-num">60, class="tok-str">"steps_used": class="tok-num">0, class="tok-str">"usd": class="tok-num">10, class="tok-str">"usd_used": class="tok-num">0 },
  class="tok-str">"capabilities": [class="tok-str">"research.web", class="tok-str">"files.read"],
  class="tok-str">"stream_url": class="tok-str">"https://api.pimsy.ai/v1/runs/run_7c1a9d/events"
}

Last updated 2026-09-15