Migrating

​

Deprecate GET /session-token

​

What This Means For You

If you currently use the GET /session-token endpoint, or use the POST /session-token endpoint with a personaConfig on the client side, you will need to update your code to pass your persona config in the request body. This means you will need to move your persona configuration from your client side to your server side.

The benefits of this change are:

• Allows for persona config to be defined entirely at runtime
• Increased security, don’t reveal your Anam config such as persona ID or system prompt to the client
• Improved performance, this is part of a wider initiative to improve connection start times

​

Implementation Recommendations

1. Upgrade to the latest version of the Anam SDK.
2. If you currently make a GET request to /session-token, please update this to a POST and pass the personaConfig in this request. This must still be from you server side config, so you may need to pass details from your client side config to your server if you are creating your system prompt dynamically.
3. Update your client side to use the session token only createClient(sessionToken). Optionally you can still pass in client options such as disableInputAudio to the client: createClient(sessionToken, { disableInputAudio: true }).

For more information on creating sessions, see here.

​

Example migration

The old way:

// On the server side
const response = await fetch('https://api.anam.ai/v1/auth/session-token', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${ANAM_API_KEY}`
  }
});
const { sessionToken } = await response.json();
return sessionToken;


// On the client side
const anamClient = createClient(sessionToken, { personaId: '<YOUR_PERSONA_ID>' });

The new way:

// On the server side
const response = await fetch("https://api.anam.ai/v1/auth/session-token", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: `Bearer ${ANAM_API_KEY}`,
  },
  body: JSON.stringify({
    personaConfig: {
      personaId: '<YOUR_PERSONA_ID>',
    },
  }),
});

const { sessionToken } = await response.json();
return sessionToken;

// On the client side
const anamClient = createClient(sessionToken);

For more in depth examples of how to define your persona config at runtime see our full implementation example.