Personas

A Persona represents the account and role used for a browser test. It has a name, an optional description of up to 2,000 characters, variables, and saved session connections. Connect it to one or more Environments in the same project. Persona variables apply only to that Persona. At execution, the selected Environment supplies shared defaults and Persona values override matching keys.

Sensitive variable values are encrypted at rest and never returned by the API after creation. Plain values are returned in detail reads. Describe the role and intended tasks without putting credentials in the description.

Saved sessions live in the project library. A Persona can connect one account per domain; separate Personas can use different accounts for the same domain. Session capture, health settings and connections are managed in the app. Expired login blocks execution until repaired.

The former Environment variable endpoints are now Persona endpoints, without compatibility aliases. Existing variable sets and sessions migrate to Personas with their IDs preserved. Each gains a same-named Environment group.

The persona object

{
  "id": "018edddd-abcd-7000-8000-abc123456789",
  "workspaceId": "018e1234-abcd-7000-8000-abc123456789",
  "projectId": "018e5678-abcd-7000-8000-abc123456789",
  "name": "Staging",
  "variables": [
    {
      "id": "018eeeee-abcd-7000-8000-abc123456789",
      "key": "BASE_URL",
      "isSensitive": false
    },
    {
      "id": "018effff-abcd-7000-8000-abc123456789",
      "key": "ADMIN_PASSWORD",
      "isSensitive": true
    }
  ],
  "createdAt": "2026-04-01T08:00:00.000Z",
  "updatedAt": "2026-05-20T12:00:00.000Z"
}

List personas

curl "https://api.smoketest.sh/v1/projects/018e5678-abcd-7000-8000-abc123456789/personas" \
  -H "Authorization: Bearer $SMOKETEST_API_KEY"

Sample response

[
  {
    "id": "018edddd-abcd-7000-8000-abc123456789",
    "workspaceId": "018e1234-abcd-7000-8000-abc123456789",
    "projectId": "018e5678-abcd-7000-8000-abc123456789",
    "name": "Staging",
    "variables": [
      { "id": "018eeeee-abcd-7000-8000-abc123456789", "key": "BASE_URL", "isSensitive": false },
      { "id": "018effff-abcd-7000-8000-abc123456789", "key": "ADMIN_PASSWORD", "isSensitive": true }
    ],
    "createdAt": "2026-04-01T08:00:00.000Z",
    "updatedAt": "2026-05-20T12:00:00.000Z"
  }
]

Create a Persona

curl -X POST "https://api.smoketest.sh/v1/projects/018e5678-abcd-7000-8000-abc123456789/personas" \
  -H "Authorization: Bearer $SMOKETEST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Staging",
    "variables": [
      { "key": "BASE_URL", "isSensitive": false, "value": "https://staging.acme.com" },
      { "key": "ADMIN_PASSWORD", "isSensitive": true, "value": "s3cr3t!" }
    ]
  }'

Get a Persona

curl https://api.smoketest.sh/v1/personas/018edddd-abcd-7000-8000-abc123456789 \
  -H "Authorization: Bearer $SMOKETEST_API_KEY"