Agent commands: create, get, list

Reference for Agent, one group of Agent commands.

Agent.create

Creates an Agent. Verb page.

Text

npx startup-builder do Agent.create --json '<input>' [--try | --send | --do]

Emits Agent.created.

Inputs

Input	Type	Required	Description
`instructions`	`text`	required	What the Agent does and how.
`model`	`string`	required	The model the Agent runs on.
`tools`	`string[]`		The tools the Agent may call.
`skills`	list of Skill		The Skills it loads.
`memory`	`string`		One of `tenant` (one Memory per Customer Tenant) or `startup` (one Memory for the Startup).
`maxSteps`	`integer`		The most steps one Task may take.
`budget`	`money`		The most one Task may spend; the Mandate’s Limits apply as well.
`handoffs`	list of Role		The Roles it hands work to.

Returns

Output	Type	Required	Description
`agent`	Agent	required	The Agent.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

npx startup-builder do Agent.create --json '{"instructions":"Example instructions","model":"Example model"}'

Returns one Agent by id. Verb page.

Text

npx startup-builder do Agent.get --json '<input>' [--try]

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Agent.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`agent`	Agent	required	The Agent.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

npx startup-builder do Agent.get --json '{"id":"agent_tCzKDMorKn"}'

Returns Agents, newest first, one page at a time. Verb page.

Text

npx startup-builder do Agent.list --json '<input>' [--try]

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`agents`	list of Agent	required	One page of Agents.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

npx startup-builder do Agent.list --json '{"limit":20}'