Chat

Arm a chat with engagement credentials

Attaches saved domain test users and/or credentials supplied in the request to a chat, so its agent can authenticate to the target. Values are encrypted at rest and handed only to the chat’s trusted orchestrator, where host-side auth tools expose derived values (a resolved login, a TOTP code) to the agent; they never enter the chat transcript, the model context, or the agent sandbox. Re-attaching an account replaces it. Recorded as a chat.credentials.attached audit event.

POST

chat

{chatId}

credentials

Error

A valid request URL is required to generate request examples

{
  "credentials": [
    {
      "label": "<string>",
      "username": "<string>",
      "mfa_method": "none",
      "has_password": true,
      "has_totp_secret": true,
      "login_url": "<string>",
      "test_user_id": "<string>"
    }
  ],
  "delivered": true
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

API token obtained from the Tokens endpoint. Include as Authorization: Bearer <token>.

Path Parameters

chatId

string<uuid>

required

Chat id.

Body

application/json

test_user_ids

string<uuid>[]

Saved domain test users to attach; each must sit on a domain within the caller's access scope.

credentials

object[]

Credentials supplied for this chat only (not saved to a domain).

Show child attributes

scan_ids

string<uuid>[]

Pentests whose stored credentials this chat should reuse; the caller must have access to each pentest's targets.

Response

Credentials armed.

credentials

object[]

required

Show child attributes

delivered

boolean

required

False when the chat was still booting; the credentials are stored and handed to its orchestrator at launch.

Error

A valid request URL is required to generate request examples

{
  "credentials": [
    {
      "label": "<string>",
      "username": "<string>",
      "mfa_method": "none",
      "has_password": true,
      "has_totp_secret": true,
      "login_url": "<string>",
      "test_user_id": "<string>"
    }
  ],
  "delivered": true
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>"
}

Scans

Audit

Vulnerabilities

Assets

Schedules

Tokens

Webhooks

Organization

Members

Invitations

Analytics

LLM

Connectors

Chat

PR Reviews

Knowledge

Integrations

Uploads

Test Users

License

Supply Chain

Arm a chat with engagement credentials

Authorizations

Path Parameters

Body

Response