Agents API

Start a run, or schedule a repeating one

post/api/v1/agents/{id}/runs

Request

  • Base URL: https://three.ws
  • URL: https://three.ws/api/v1/agents/{id}/runs
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

idstring required

Headers

Idempotency-Keystring

A retry with the same key and body replays the stored response for 24 hours.

Request body

goalstring required

What the run should accomplish.

maxStepsinteger
budgetCreditsUsdnumber
budgetUsdnumber

On-chain budget. Needs wallet:write.

modelstring

Model id.

temperaturenumber
toolsAllowedstring[]
scheduledForstring date-time

ISO 8601 start time.

schedulestring

Cron expression. Creates an automation that starts a run on that schedule.

Response

The { data, meta: { requestId, timestamp } } envelope.

Changes

No recorded changes to this operation across all 1 revision of this API.