Create Agent Work Item

POST

/agent/work-items

• Production
• QA

Start a unit of autonomous work. THE AGENT BEGINS PLANNING IMMEDIATELY.

agent_id selects the planner template. A known id gets its own template; anything else falls back to full, which is why it is an open string rather than an enum - an enum would reject the ad-hoc case the planner explicitly supports.

visibility defaults to private: work started through a key is not visible org-wide unless asked for.

user_email defaults to the identity the key was minted under, so the item belongs to a real person rather than to nobody.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Start a unit of autonomous work.

object

agent_id

required

Which agent owns it. A known id the planner has a template for - onboarding, dialer_setup, sequencer_setup, campaign_run, voice_setup, marketplace, dev_setup - or a free-form value, for which the planner falls back to its full template. Left as an open string for that reason: an enum here would reject the ad-hoc case the planner explicitly supports.

string

entry_point

Any of:

string

string

null

null

goal

required

What the agent should achieve.

string

>= 1 characters

page

Any of:

string

string

<= 500 characters

null

null

platform

Any of:

string

string

Allowed values: whatsapp slack roam imessage

null

null

seed_message

Any of:

string

string

null

null

session_title

Any of:

string

string

null

null

skill_mode

Any of:

string

string

null

null

source

Any of:

string

string

Allowed values: canvas bridge

null

null

subject_account_id

Any of:

string

string

null

null

subject_campaign_id

Any of:

string

string

null

null

title

required

string

>= 1 characters <= 500 characters

user_email

Any of:

string

string

null

null

visibility

private (default) or shared org-wide. The default is the safe one: work started through an API key is not visible to the whole org unless asked for.

string

default: private

Allowed values: shared private

Responses

201

Successful Response

object

data

required

One unit of autonomous work.

object

agent_id

Any of:

string

string

null

null

created_at

Any of:

string

string format: date-time

null

null

goal

Any of:

string

string

null

null

id

Any of:

string

string

null

null

session_id

Any of:

string

string

null

null

status

Any of:

string

string

null

null

title

Any of:

string

string

null

null

updated_at

Any of:

string

string format: date-time

null

null

visibility

Any of:

string

string

null

null

work_item_id

Any of:

string

string

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string