Sign in
assistants

Changed on
patch/v1/assistants/access-consent/

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

Headers

Vellum-Organization-Idstring uuid

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

Request body

access_consentedboolean

When True, Vellum staff may access this assistant and its data for debugging: daemon log files, an admin terminal on the running assistant, and a disposable clone of its disk. Defaults to False; the owner can revoke at any time, which blocks new access and further commands in open admin terminal sessions. A grant lapses on its own at access_consent_expires_at; reads report False once it has.

never_expiresboolean

Only with access_consented=true: keep access on until the owner turns it off, instead of for expires_in_hours.

expires_in_hoursinteger

Only with access_consented=true: how long the grant lasts, 1 to 168 hours. Defaults to 24. Enabling again resets the clock.

Response

access_consentedboolean required

When True, Vellum staff may access this assistant and its data for debugging: daemon log files, an admin terminal on the running assistant, and a disposable clone of its disk. Defaults to False; the owner can revoke at any time, which blocks new access and further commands in open admin terminal sessions. A grant lapses on its own at access_consent_expires_at; reads report False once it has.

access_consent_expires_atstring date-time nullable required

When the current grant lapses. Set on every enable, 24 hours out by default. Null when access is off or never expires.

access_consent_never_expiresboolean required

True when the owner chose to keep access on until they turn it off, in which case access_consent_expires_at is null.

Changes

  • ad08cc82e970Revision changes
    • ○

      added the new optional request property (media type: application/json)

    • ○

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • ○

      added the new optional request property (media type: multipart/form-data)

    • ○

      added the required property to the response with the status

  • ba57f0a2366fRevision changes
    • ○

      added the new optional request property (media type: application/json)

    • ○

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • ○

      added the new optional request property (media type: multipart/form-data)

    • ○

      added the required property to the response with the status