ASasteroid
Agent Profiles

Create Agent Profile

Create a new agent profile. 409 when two attached vault items share a key.

post/agents/v2/agent-profiles

Request

  • Base URL
    https://odyssey.asteroid.ai
  • URL
    https://odyssey.asteroid.ai/agents/v2/agent-profiles
  • Auth
    API key in header X-Api-Key

Request body

descriptionstring required
fingerprintIdstring

Anchor browser fingerprint ID (24-character hex). An empty string means unset (create) or clear (update).

inboxEmailPrefixstring

Optional custom prefix for the agent's inbox email address. If set, the inbox will be {prefix}@agentmail.asteroid.ai.

namestring required

Name of the agent profile (must be unique within organization)

organizationIdstring uuid
secretIdsCommonUuid[]

Secret IDs to attach to this profile. Do not set together with vaultItemIds.

stickyIPboolean

Give browser runs on this profile one dedicated IP. Applies when the environment uses the managed proxy or no proxy.

tracingEnabledboolean

Whether browser tracing is enabled (admin only, defaults to true)

vaultItemIdsCommonUuid[]

Deprecated: use secretIds. Org vault item IDs attached to this profile.

Response

The request has succeeded and a new resource has been created as a result.

createdAtstring date-time required
descriptionstring required
fingerprintIdstring nullable

Anchor browser fingerprint ID applied at session create (admin only). Absent or null when unset.

idstring uuid required
inboxEmailstring required

The resolved inbox email address for this profile

inboxEmailPrefixstring

Optional custom prefix for the agent's inbox email address. If set, the inbox will be {prefix}@agentmail.asteroid.ai. If not set, defaults to the first 8 characters of the profile ID.

namestring required

Name of the agent profile (unique within organization)

organizationIdstring uuid required
stickyIPboolean required

Whether browser runs on this profile egress from one dedicated IP. Applies when the environment uses the managed proxy or no proxy.

tracingEnabledboolean required

Whether browser tracing is enabled (admin only)

updatedAtstring date-time required

Changes

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