Skip to main content
POST
Create an agent with a key and a mailbox

Authorizations

Authorization
string
header
required

Either a key (keya_…) or an access token (a JWT) for the audience https://access.noetive.io. agents/v1 needs the scope agent:provision and an agent with May create agents and keys; access/v1 accepts any agent credential. Pass as Authorization: Bearer <credential>.

Body

application/json
name
string
required

Shown in the dashboard. Unique among the owner's agents, ignoring case.

Required string length: 1 - 100
local_part
string

The part of the address before the @: lowercase letters, digits and ., _, +, -. Generated when omitted. Fixed once created, because it is in the From of every message the agent sends.

Maximum string length: 64
bud_scopes
enum<string>[]

What the agent may do in Bud. Defaults to the provisioner's own when omitted; [] means none. Must be among the provisioner's own.

Available options:
mail
namespaces
object

Which Semantik namespaces the agent reaches. Omitted means none. Must be within what the provisioner reaches.

roles
string[]

Tenant roles the agent acts under. Omitted means none; roles are never inherited. Must be among the roles the provisioner holds.

Maximum array length: 16
Required string length: 1 - 64
expires_in_days
integer

When the key stops working. 0 or omitted means never.

Required range: 0 <= x <= 3650

Response

The agent, its address and its key.

agent_id
string
required
address
string
required

The agent's email address. Empty when it has no Bud scopes, and so no mailbox.

key_id
string
required

The key's id, for revoke_key. Not a secret.

key
string
required

The key itself. Shown once.

expires_at
string<date-time> | null
required

When the key stops working; null when it never does.