get session

curl --request GET \
  --url https://api.anam.ai/v1/sessions/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.anam.ai/v1/sessions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anam.ai/v1/sessions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anam.ai/v1/sessions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.anam.ai/v1/sessions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "75e63782-f47a-4d2c-a0ff-8875ed6706ba",
  "personaId": null,
  "clientLabel": "anam-lab-chat",
  "startTime": "2026-04-20T09:00:00.000Z",
  "endTime": "2026-04-20T09:12:34.000Z",
  "sessionLengthMs": 754000,
  "exitStatus": "CLOSED_BY_ENGINE",
  "engineHost": "connect-eu.anam.ai/v1/webrtc/engines/anam-engine-7dddcb9ccd-db8v9",
  "engineProtocol": "https",
  "engineVersion": "v5.1.0",
  "clientMetadata": {
    "userAgent": "Mozilla/5.0"
  },
  "personaConfig": {
    "type": "ephemeral",
    "name": "Cara",
    "metadata": {
      "client": "js-sdk"
    },
    "llmConfig": {
      "id": "a7cf662c-2ace-4de1-a21e-ef0fbf144bb7",
      "modelName": "gpt-4o",
      "format": "openai",
      "urls": [
        {
          "url": "https://api.openai.com/v1",
          "region": "default"
        }
      ],
      "maxTokens": 4096,
      "temperature": 0.7,
      "metadata": {},
      "secret_iv": "[REDACTED]",
      "encrypted_secret": "[REDACTED]",
      "createdByOrganizationId": null
    },
    "systemPrompt": "You are a helpful assistant.",
    "personality": "",
    "languageCode": "en",
    "skipGreeting": false,
    "zeroDataRetention": false,
    "ttsProvider": "ELEVENLABS",
    "ttsProviderVoiceId": "lcMyyd2HUfFzxdCaC4Ta",
    "ttsProviderModelId": "eleven_flash_v2_5",
    "ttsProviderOptions": {},
    "avatarEngineKey": "cara_home",
    "avatarVersion": "cara-3",
    "disableBrains": false,
    "fillerPhrases": [],
    "useFillerPhrases": false,
    "enableAudioPassthrough": false,
    "voiceDetectionOptions": {},
    "voiceGenerationOptions": {},
    "maxSessionLengthSeconds": 1000000,
    "fps": 25
  },
  "apiKeyId": "b0416794-1524-45b5-88c4-6f5dd9e19485",
  "organizationId": "c2d0a5f9-0d47-4c67-a37b-e17861244e40",
  "createdAt": "2026-04-20T09:00:00.000Z",
  "updatedAt": "2026-04-20T09:12:34.000Z",
  "toolCalls": []
}

{
  "error": "Service temporarily unavailable",
  "message": "We could not check your API key. Please retry shortly."
}

get session

Returns a session by ID, including the tool calls made during the session once it has ended and the engine has delivered its session report (toolCalls is empty until then, and always empty for LiveKit and audio-passthrough sessions, which never produce a report). Tool call names, timing, status and errors are always included; call arguments, results and accessed-document names are only included when transcripts were enabled for the session and the session is not zero-data-retention, since they embed conversation content. HTTP headers and credential-like keys are never returned. Anam-internal admin API keys may fetch sessions of any organization.

GET

sessions

{id}

get session

curl --request GET \
  --url https://api.anam.ai/v1/sessions/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.anam.ai/v1/sessions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anam.ai/v1/sessions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anam.ai/v1/sessions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.anam.ai/v1/sessions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "75e63782-f47a-4d2c-a0ff-8875ed6706ba",
  "personaId": null,
  "clientLabel": "anam-lab-chat",
  "startTime": "2026-04-20T09:00:00.000Z",
  "endTime": "2026-04-20T09:12:34.000Z",
  "sessionLengthMs": 754000,
  "exitStatus": "CLOSED_BY_ENGINE",
  "engineHost": "connect-eu.anam.ai/v1/webrtc/engines/anam-engine-7dddcb9ccd-db8v9",
  "engineProtocol": "https",
  "engineVersion": "v5.1.0",
  "clientMetadata": {
    "userAgent": "Mozilla/5.0"
  },
  "personaConfig": {
    "type": "ephemeral",
    "name": "Cara",
    "metadata": {
      "client": "js-sdk"
    },
    "llmConfig": {
      "id": "a7cf662c-2ace-4de1-a21e-ef0fbf144bb7",
      "modelName": "gpt-4o",
      "format": "openai",
      "urls": [
        {
          "url": "https://api.openai.com/v1",
          "region": "default"
        }
      ],
      "maxTokens": 4096,
      "temperature": 0.7,
      "metadata": {},
      "secret_iv": "[REDACTED]",
      "encrypted_secret": "[REDACTED]",
      "createdByOrganizationId": null
    },
    "systemPrompt": "You are a helpful assistant.",
    "personality": "",
    "languageCode": "en",
    "skipGreeting": false,
    "zeroDataRetention": false,
    "ttsProvider": "ELEVENLABS",
    "ttsProviderVoiceId": "lcMyyd2HUfFzxdCaC4Ta",
    "ttsProviderModelId": "eleven_flash_v2_5",
    "ttsProviderOptions": {},
    "avatarEngineKey": "cara_home",
    "avatarVersion": "cara-3",
    "disableBrains": false,
    "fillerPhrases": [],
    "useFillerPhrases": false,
    "enableAudioPassthrough": false,
    "voiceDetectionOptions": {},
    "voiceGenerationOptions": {},
    "maxSessionLengthSeconds": 1000000,
    "fps": 25
  },
  "apiKeyId": "b0416794-1524-45b5-88c4-6f5dd9e19485",
  "organizationId": "c2d0a5f9-0d47-4c67-a37b-e17861244e40",
  "createdAt": "2026-04-20T09:00:00.000Z",
  "updatedAt": "2026-04-20T09:12:34.000Z",
  "toolCalls": []
}

{
  "error": "Service temporarily unavailable",
  "message": "We could not check your API key. Please retry shortly."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

Session ID

Response

Successfully retrieved session

A single connection between a client and a persona. Contains metadata but not the transcript or recording — those are fetched separately.

string<uuid>

Unique identifier for the session.

personaId

string<uuid> | null

ID of the persona the client connected to, or null if the session was issued with an ephemeral persona config.

clientLabel

string | null

Label supplied by the caller when minting the session token.

startTime

string<date-time>

Timestamp when the session started.

endTime

string<date-time> | null

Timestamp when the session ended, or null if still active.

sessionLengthMs

integer | null

Duration of the session in milliseconds, or null if still active.

exitStatus

string | null

How the session ended, or null if still active. Treat this as an open string set — new values may be added over time, so clients should handle unrecognised values gracefully rather than exhaustively matching. Known values: CLOSED_BY_ENGINE, CLOSED_DANGLING_SESSION, HOST_FAILED_HEALTH_CHECK, HOST_UNREGISTERED, FAILED_TO_START, FAILED_PENDING_TIMEOUT, ORPHANED_NO_END_SIGNAL, CLOSED_CLIENT_CONFIG_ERROR, CLOSED_MAX_DURATION, CLOSED_IDLE_TIMEOUT, CLOSED_NEVER_JOINED, CLOSED_NO_INPUT_AUDIO, CLOSED_PROVIDER_ERROR.

engineHost

string | null

Hostname of the engine pod that served the session.

engineProtocol

string | null

Protocol used to stream the session (e.g. https).

engineVersion

string | null

Version of the engine pod that served the session.

clientMetadata

object

Arbitrary metadata collected from the client during the session.

personaConfig

object

Snapshot of the persona configuration taken at the moment the session started.

apiKeyId

string<uuid> | null

ID of the API key that minted the session token.

organizationId

string

ID of the organization that owns the session. IDs may be either UUIDs or nanoid-style strings depending on when the organization was created.

createdAt

string<date-time>

Timestamp when the session record was created.

updatedAt

string<date-time> | null

Timestamp when the session record was last updated.

toolCalls

object[]

Tool calls made during the session, in conversational order. Empty until the session has ended and its report has been delivered.

Show child attributes

Use the API

Sessions

Meetings

Avatar Videos

Personas

Avatars

Voices

Pronunciation Dictionaries

LLMs

Knowledge

Tools

Share Links

Engine

get session

Authorizations

Path Parameters

Response