Skip to main content
GET
/
sessions
cURL
curl --request GET \
  --url https://api.alcamine.com/sessions \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "createdAt": "2023-12-25T00:00:00.000Z",
    "updatedAt": "2023-12-25T00:00:00.000Z",
    "name": "<string>",
    "type": "INBOUND_CALL",
    "status": "PENDING",
    "completedAt": "2023-12-25T00:00:00.000Z",
    "lastHeartbeatAt": "2023-12-25T00:00:00.000Z",
    "startedAt": "2023-12-25T00:00:00.000Z",
    "endedAt": "2023-12-25T00:00:00.000Z",
    "recordAudio": true,
    "isDemo": true,
    "agentId": "<string>",
    "agentVersionId": "<string>",
    "workspaceId": "<string>",
    "personId": "<string>",
    "conversationId": "<string>",
    "agent": {
      "id": "<string>",
      "createdAt": "2023-12-25T00:00:00.000Z",
      "updatedAt": "2023-12-25T00:00:00.000Z",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "workspaceId": "<string>",
      "publishedVersionId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "slug": "<string>",
      "status": "DRAFT",
      "sourceTemplateId": "<string>",
      "archivedBy": "<string>",
      "completedBy": "<string>",
      "publishedBy": "<string>",
      "version": {
        "id": "<string>",
        "createdAt": "2023-12-25T00:00:00.000Z",
        "updatedAt": "2023-12-25T00:00:00.000Z",
        "createdBy": "<string>",
        "updatedBy": "<string>",
        "agentId": "<string>",
        "version": -1,
        "workspaceId": "<string>",
        "sourceAgentVersionId": "<string>",
        "themeId": "<string>",
        "incentiveType": "CASH",
        "incentiveAmount": 500050,
        "incentiveCurrencyCode": "USD",
        "maxParticipants": -1,
        "length": "FIVE_MINUTES",
        "languages": [
          "en"
        ],
        "inputMode": [
          "SMS"
        ],
        "knowledgeBaseId": "<string>",
        "followUp": true,
        "limitToKnowledgeBase": true,
        "timezone": "<string>",
        "authentication": "NONE",
        "systemPrompt": "<string>",
        "agentFlowId": "<string>",
        "config": {
          "llm": {
            "provider": "OPENAI",
            "model": "GPT_4O",
            "temperature": 1
          },
          "tts": {
            "provider": "CARTESIA",
            "model": "SONIC_2",
            "voiceId": "<string>"
          },
          "stt": {
            "provider": "DEEPGRAM",
            "model": "NOVA_3"
          }
        }
      },
      "archivedAt": "2023-12-25T00:00:00.000Z",
      "completedAt": "2023-12-25T00:00:00.000Z",
      "publishedAt": "2023-12-25T00:00:00.000Z"
    },
    "conversation": {
      "id": "<string>",
      "createdAt": "2023-12-25T00:00:00.000Z",
      "updatedAt": "2023-12-25T00:00:00.000Z",
      "workspaceId": "<string>",
      "personId": "<string>",
      "name": "<string>",
      "isDemo": true,
      "lastViewedAt": "2023-12-25T00:00:00.000Z",
      "lastViewedBy": "<string>",
      "lastSessionEndedAt": "2023-12-25T00:00:00.000Z",
      "archivedAt": "2023-12-25T00:00:00.000Z",
      "archivedBy": "<string>"
    },
    "person": {
      "id": "<string>",
      "createdAt": "2023-12-25T00:00:00.000Z",
      "updatedAt": "2023-12-25T00:00:00.000Z",
      "workspaceId": "<string>",
      "properties": {},
      "firstSeenAt": "2023-12-25T00:00:00.000Z",
      "lastSeenAt": "2023-12-25T00:00:00.000Z",
      "identifiedAt": "2023-12-25T00:00:00.000Z",
      "deletedAt": "2023-12-25T00:00:00.000Z",
      "email": "[email protected]",
      "phone": "<string>",
      "rootPersonId": "<string>",
      "mergedBy": "<string>",
      "mergedAt": "2023-12-25T00:00:00.000Z",
      "mergeMeta": {}
    },
    "ledger": {
      "id": "<string>",
      "createdAt": "2023-12-25T00:00:00.000Z",
      "updatedAt": "2023-12-25T00:00:00.000Z",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "workspaceId": "<string>",
      "amount": -1,
      "reason": "INITIAL_BALANCE",
      "reasonDetails": "<string>",
      "redemptionCodeId": "<string>",
      "agentId": "<string>",
      "sessionId": "<string>",
      "idempotencyKey": "<string>"
    },
    "completedMeta": {
      "traceId": "<string>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
limit
integer
default:25
Required range: 1 <= x <= 250
​
offset
integer
default:0
Required range: x >= 0

Response

200 - application/json

List sessions

​
id
string<cuid2>
required
Maximum string length: 24
​
createdAt
required
Example:

"2023-12-25T00:00:00.000Z"

​
updatedAt
required
Example:

"2023-12-25T00:00:00.000Z"

​
name
string
required
Maximum string length: 255
​
type
enum<string>
required
Available options:
INBOUND_CALL,
WEB_VOICE
​
status
enum<string>
required
Available options:
PENDING,
IN_PROGRESS,
COMPLETED
​
completedAt
required
Example:

"2023-12-25T00:00:00.000Z"

​
lastHeartbeatAt
required
Example:

"2023-12-25T00:00:00.000Z"

​
startedAt
required
Example:

"2023-12-25T00:00:00.000Z"

​
endedAt
required
Example:

"2023-12-25T00:00:00.000Z"

​
recordAudio
boolean
required
​
isDemo
boolean
required
​
agentId
string
required
Maximum string length: 24
​
agentVersionId
string
required
Maximum string length: 24
​
workspaceId
string<cuid2>
required
Maximum string length: 24
​
personId
string
required
Maximum string length: 24
​
conversationId
string
required
Maximum string length: 24
​
agent
object
required
​
conversation
object
required
​
person
object
required
​
ledger
object
required
​
completedMeta
object