# AgentToken

> The AgentToken object in the Guv API.

## Fields

| Field | Type | Description |
| --- | --- | --- |
| `id` * | string |  |
| `workspace_id` * | string |  |
| `name` * | string |  |
| `description` | string or null |  |
| `prefix` | string |  |
| `scopes` * | array of [Scope](/docs/api/objects/scope/) |  |
| `projects` | array of string or null | Project ids the token may touch; null means every project in the workspace. |
| `environments` * | array of string | Environment names the token may change. Changes elsewhere return `approval_required`. `*` means all. |
| `budget` | [AgentTokenBudget](/docs/api/objects/agent-token-budget/) |  |
| `approval_channel` | array of [ApprovalChannel](/docs/api/objects/approval-channel/) |  |
| `status` * | `active`, `expired`, `revoked` |  |
| `summary` | array of string | Human-readable sentences describing what the token can and cannot do. Read-only. |
| `created_by` | [Actor](/docs/api/objects/actor/) |  |
| `expires_at` | string (date-time) or null |  |
| `last_used_at` | string (date-time) or null |  |
| `revoked_at` | string (date-time) or null |  |
| `created_at` * | string (date-time) |  |

\* always present

## Example

```json
{
  "id": "tok_01jbx2m9k7q4r8t5v6w3y0z1tk",
  "workspace_id": "ws_01jbx2m9k7q4r8t5v6w3y0z1ws",
  "name": "claude-code-on-stewart-laptop",
  "description": "Claude Code on Stewart's MacBook",
  "prefix": "guv_agt_Qm4x",
  "scopes": [
    "projects:read",
    "deploy:preview",
    "deploy:staging",
    "logs:read",
    "secrets:write-only",
    "db:branch"
  ],
  "projects": null,
  "environments": [
    "preview",
    "staging"
  ],
  "budget": {
    "spend_increase_per_day": {
      "amount": "10.00",
      "currency": "GBP",
      "display": "£10.00"
    }
  },
  "approval_channel": [
    "push",
    "email"
  ],
  "status": "active",
  "summary": [
    "Can deploy to staging and previews.",
    "Cannot touch production without your approval.",
    "Can set secrets but never read them.",
    "Can raise spend by up to £10.00 a day."
  ],
  "created_by": {
    "type": "user",
    "id": "usr_01jbx2m9k7q4r8t5v6w3y0z1us",
    "display": "Stewart Webb"
  },
  "expires_at": "2026-11-22T09:00:00Z",
  "last_used_at": "2026-10-23T13:58:00Z",
  "revoked_at": null,
  "created_at": "2026-10-23T09:00:00Z"
}
```

## Used by

- [Get an agent token](/docs/api/agent-tokens/#get-an-agent-token)
- [Change an agent token's scopes, environments, budget or channel](/docs/api/agent-tokens/#change-an-agent-tokens-scopes-environments-budget-or-channel)