ASasteroid
Profiles

Update Profile

Update an existing profile. 409 when two attached secrets share a key.

patch/agents/v2/profiles/{profileId}

Request

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

Path parameters

profileIdstring uuid required

Request body

cookiesToDeleteCommonUuid[]
credentialsToDeleteCommonUuid[]

Deprecated: use secretIds. IDs of credentials to remove from the profile.

descriptionstring
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
secretIdsCommonUuid[]

Secret IDs attached to this profile. Replaces the full list. To change part of it, use secretIdsToAdd and secretIdsToRemove.

secretIdsToAddCommonUuid[]

Secret IDs to attach. Secrets already attached stay. Cannot be combined with secretIds.

secretIdsToRemoveCommonUuid[]

Secret IDs to detach. IDs that are not attached are ignored. Applied before secretIdsToAdd. Cannot be combined with secretIds.

stickyIPboolean

Turn the dedicated IP on or off. A change clears the profile's saved browser state, and is refused while a run uses the profile.

tracingEnabledboolean

Whether browser tracing is enabled (admin only)

vaultItemIdsCommonUuid[]

Deprecated: use secretIds.

vaultItemIdsToAddCommonUuid[]

Deprecated: use secretIdsToAdd.

vaultItemIdsToRemoveCommonUuid[]

Deprecated: use secretIdsToRemove.

Response

The request has succeeded.

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.