Sign in
assistants

Changed on
patch/v1/assistants/{id}/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid
    • API key in header X-Session-Token
    • API key in header Authorization

Path parameters

idstring required

Headers

Vellum-Organization-Idstring uuid

Required if using Cookie-based or X-Session-Token authentication methods.

Request body

namestring
descriptionstring nullable
handlestring
avatar_base64string nullable

Base64-encoded avatar image (PNG, JPEG, GIF, or WebP), at most 524288 bytes (512 KiB) decoded. Send null or an empty string to remove the current avatar; omit the field to leave it alone.

notification_avatar_base64string nullable

Base64-encoded notification avatar image (PNG only), square and at most 512 pixels per side, at most 131072 bytes (128 KiB) decoded. Send null or an empty string to remove the current notification avatar; omit the field to leave it alone.

Response

idstring uuid required
namestring
handlestring required
descriptionstring nullable
configurationunknown
status'initializing' | 'active' | 'to_be_deleted' | 'archiving' | 'archived' | 'restoring'
  • initializing - Initializing
  • active - Active
  • to_be_deleted - To be deleted
  • archiving - Archiving
  • archived - Archived
  • restoring - Restoring
createdstring date-time required
modifiedstring date-time required
release_channel'stable' | 'preview' required
  • stable - Stable
  • preview - Preview
current_release_versionstring nullable required
avatar_urlstring nullable required
machine_idstring nullable
vembda_cluster_idstring nullable required
provisioned_storage_gibinteger nullable required

GiB of workspace PVC last successfully provisioned for THIS assistant via a resize/onboarding apply. Null until storage is first applied. Used to derive onboarding pvc_ready and as the never-shrink floor; distinct from BillingAccount billing markers.

is_localboolean required
ingress_urlstring nullable required
platform_actor_tokenstring nullable required
access_consentedboolean required
access_consent_expires_atstring date-time nullable required
access_consent_never_expiresboolean required

Changes