Skip to content

Create token (Cloud-only)

client.accessTokens.create(, ?): AccessTokenCreateResponse { token, expiresAt, hostname, policy }

POST/v1/client-side-access-tokens

Create a new client side access token with the specified configuration.

ParametersExpand Collapse

body: AccessTokenCreateParams { hostname, policy, expires_at }

hostname: string

The hostname of the client side application. Please specify the full URL including the protocol (http or https).

formaturi

policy: Array<Policy>

id: string

access: Array<"read_messages" | "write_messages" | "read_agent" | "write_agent">

One of the following:

"read_messages"

"write_messages"

"read_agent"

"write_agent"

type: "agent"

expires_at?: string

The expiration date of the token. If not provided, the token will expire in 5 minutes

ReturnsExpand Collapse

AccessTokenCreateResponse { token, expiresAt, hostname, policy }

token: string

expiresAt: string

hostname: string

policy: Policy { data, version }

data: Array<Data>

id: string

access: Array<"read_messages" | "write_messages" | "read_agent" | "write_agent">

One of the following:

"read_messages"

"write_messages"

"read_agent"

"write_agent"

type: "agent"

version: "1"

Create token (Cloud-only)

import Letta from '@letta-ai/letta-client';

const client = new Letta({
  apiKey: process.env['LETTA_API_KEY'], // This is the default and can be omitted
});

const accessToken = await client.accessTokens.create({
  hostname: 'https://example.com',
  policy: [
    {
      id: 'id',
      access: ['read_messages'],
      type: 'agent',
    },
  ],
});

console.log(accessToken.token);

{
  "token": "token",
  "expiresAt": "expiresAt",
  "hostname": "hostname",
  "policy": {
    "data": [
      {
        "id": "id",
        "access": [
          "read_messages"
        ],
        "type": "agent"
      }
    ],
    "version": "1"
  }
}

Returns Examples

{
  "token": "token",
  "expiresAt": "expiresAt",
  "hostname": "hostname",
  "policy": {
    "data": [
      {
        "id": "id",
        "access": [
          "read_messages"
        ],
        "type": "agent"
      }
    ],
    "version": "1"
  }
}