> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/auth-tokens.md).

# Connect with an auth token

Keep your Convai API key on your server by minting an auth token there and connecting the Web SDK in the browser with that token instead.

Connect the Convai Web SDK with an auth token minted by your server, so your API key never reaches the browser. Use this page before you publish any page that talks to a character.

### Why use an auth token

An API key is a credential for your whole Convai account. Any value in a client bundle can be read by anyone who opens the page, so a shipped API key can be copied and used outside your application. An auth token is created on your server from the API key, and only the token is sent to the browser.

```mermaid
sequenceDiagram
    participant Browser
    participant Server as Your server
    participant Convai
    Browser->>Server: Request a token
    Server->>Convai: POST /user/connect with CONVAI-API-KEY
    Convai-->>Server: apiAuthToken
    Server-->>Browser: Token
    Browser->>Convai: connect() with authToken
```

The diagram shows the API key staying on your server: the browser only ever holds the token.

### Mint a token on your server

Send a `POST` request to `https://api.convai.com/user/connect` with your API key in the `CONVAI-API-KEY` header. The token is in the `apiAuthToken` field of the JSON response.

{% tabs %}
{% tab title="Node.js" %}
{% code title="server/token.ts" %}

```typescript
export async function createConvaiToken(): Promise<string> {
  const response = await fetch('https://api.convai.com/user/connect', {
    method: 'POST',
    headers: {
      'CONVAI-API-KEY': process.env.CONVAI_API_KEY!,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({}),
  });
  if (!response.ok) {
    throw new Error(`Token request failed: ${response.status}`);
  }
  const data = await response.json();
  return data.apiAuthToken;
}
```

{% endcode %}
{% endtab %}

{% tab title="Python" %}

```python
import os
import requests

def create_convai_token() -> str:
    response = requests.post(
        "https://api.convai.com/user/connect",
        headers={
            "CONVAI-API-KEY": os.environ["CONVAI_API_KEY"],
            "Content-Type": "application/json",
        },
        json={},
    )
    response.raise_for_status()
    return response.json()["apiAuthToken"]
```

{% endtab %}
{% endtabs %}

Expose the function through an endpoint of your own that only your signed-in end users can call.

### Connect with the token

Pass `authToken` instead of `apiKey`. Every other option stays the same.

{% tabs %}
{% tab title="React" %}

```tsx
import { useConvaiClient, ConvaiWidget } from '@convai/web-sdk/react';

export function Assistant({ token }: { token: string }) {
  const client = useConvaiClient({
    authToken: token,
    characterId: 'YOUR_CHARACTER_ID',
  });

  return <ConvaiWidget convaiClient={client} />;
}
```

{% endtab %}

{% tab title="TypeScript" %}

```typescript
import { ConvaiClient } from '@convai/web-sdk/core';

const token = await fetch('/api/convai-token').then((r) => r.text());

const client = new ConvaiClient({
  authToken: token,
  characterId: 'YOUR_CHARACTER_ID',
});

await client.connect();
```

{% endtab %}
{% endtabs %}

The vanilla `createConvaiWidget()` helper also accepts `authToken` in place of `apiKey` when you let it create the client.

Credential rules in `connect()`:

| Configuration                    | Result                                                                                          |
| -------------------------------- | ----------------------------------------------------------------------------------------------- |
| `authToken` set                  | The SDK sends it in the `API-AUTH-TOKEN` header. It takes precedence when `apiKey` is also set. |
| Only `apiKey` set                | The SDK sends it in the `X-API-Key` header.                                                     |
| Neither set, or no `characterId` | `connect()` throws `Either apiKey or authToken is required, and characterId is required`.       |

The long-term memory manager created for the session uses the same credential, so memory calls also work with a token. See [Use long-term memory](/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/long-term-memory.md).

{% hint style="danger" %}
Do not ship an API key in browser code for a public page. Keep `apiKey` for local development and server-side tools.
{% endhint %}

### Verify the connection

Connect from the page and confirm that `connect()` resolves and the `botReady` event fires. In the browser's network panel, the `/connect` request carries an `API-AUTH-TOKEN` header and no `X-API-Key` header.

### Next steps

{% content-ref url="/pages/QOOOI31YjB7Tih8ktqsx" %}
[Handle errors and disconnects](/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/error-handling.md)
{% endcontent-ref %}

{% content-ref url="/pages/WyjROD93MGIykd6sRYNa" %}
[Use long-term memory](/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/long-term-memory.md)
{% endcontent-ref %}

{% content-ref url="/pages/Ao6AKyD9m1Dhix32kGFx" %}
[Configuration and type reference](/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/best-practices-and-type-definitions.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/auth-tokens.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.