---
title: Auth
---

## GET auth
Agentry API endpoint.
**Endpoint**: `GET /human/v0/auth/confirm`
**Authentication**: `Authorization: Bearer <token>`
### Responses

#### `200`

Success

Content-Type: `application/json`

##### Example

```json
{}
```


## Confirm Auth
Agentry API endpoint.
**Endpoint**: `POST /human/v0/auth/confirm`
**Authentication**: `Authorization: Bearer <token>`
### Request Body
Content-Type: `application/json`
#### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `confirmation_token` | string | Yes |  |
| `inbox_id` | string | Yes |  |

#### Example

```json
{
  "confirmation_token": "<string>",
  "inbox_id": "<string>"
}
```

### Responses

#### `200`

Successful response

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `confirmed_at` | string | Yes |  |
| `email_address` | string | Yes |  |
| `inbox_id` | string | Yes |  |
| `provider` | `google_oauth` \| `imap` | Yes |  |
| `status` | `pending_confirmation` \| `active` | Yes |  |

##### Example

```json
{
  "confirmed_at": "2026-01-01T00:00:00Z",
  "email_address": "<string>",
  "inbox_id": "<string>",
  "provider": "google_oauth",
  "status": "pending_confirmation"
}
```


## Create Auth Tokens
Agentry API endpoint.
**Endpoint**: `POST /human/v0/auth/tokens`
**Authentication**: `Authorization: Bearer <token>`
### Request Body
Content-Type: `application/json`
#### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `confirmation_redirect_url` | string | No |  |
| `email_address` | string | Yes |  |
| `enable_deep_backfill` | boolean | No |  |
| `enable_semantic_search` | boolean | No |  |
| `human_user_id` | string | Yes |  |
| `imap` | object | No |  |
| `oauth` | object | No |  |
| `provider` | `google_oauth` \| `imap` | Yes |  |
| `smtp` | object | No |  |

#### Example

```json
{
  "confirmation_redirect_url": "https://example.com",
  "email_address": "<string>",
  "enable_deep_backfill": true,
  "enable_semantic_search": true,
  "human_user_id": "<string>",
  "imap": {
    "host": "<string>",
    "password": "<string>",
    "port": 0,
    "secure": true,
    "username": "<string>"
  },
  "oauth": {
    "access_token": "<string>",
    "expires_at": "2026-01-01T00:00:00Z",
    "refresh_token": "<string>"
  },
  "provider": "google_oauth",
  "smtp": {
    "host": "<string>",
    "password": "<string>",
    "port": 0,
    "secure": true,
    "username": "<string>"
  }
}
```

### Responses

#### `200`

Successful response

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `confirmation_expires_at` | string | Yes |  |
| `confirmation_sent_at` | string | Yes |  |
| `email_address` | string | Yes |  |
| `inbox_id` | string | Yes |  |
| `status` | `pending_confirmation` \| `active` | Yes |  |

##### Example

```json
{
  "confirmation_expires_at": "2026-01-01T00:00:00Z",
  "confirmation_sent_at": "2026-01-01T00:00:00Z",
  "email_address": "<string>",
  "inbox_id": "<string>",
  "status": "pending_confirmation"
}
```


## Create Auth URL
Agentry API endpoint.
**Endpoint**: `POST /human/v0/auth/url`
**Authentication**: `Authorization: Bearer <token>`
### Request Body
Content-Type: `application/json`
#### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email_address` | string | No |  |
| `human_user_id` | string | Yes |  |
| `provider` | `google_oauth` \| `imap` | Yes |  |
| `redirect_uri` | string | No |  |
| `scopes` | array\<string\> | No |  |

#### Example

```json
{
  "email_address": "<string>",
  "human_user_id": "<string>",
  "provider": "google_oauth",
  "redirect_uri": "https://example.com",
  "scopes": [
    "<string>"
  ]
}
```

### Responses

#### `200`

Successful response

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `authorization_url` | string | Yes |  |
| `provider` | `google_oauth` \| `imap` | Yes |  |
| `state` | string | Yes |  |

##### Example

```json
{
  "authorization_url": "https://example.com",
  "provider": "google_oauth",
  "state": "<string>"
}
```