Skip to main content
GET
/
agents
cURL
curl --request GET \
  --url https://api.alcamine.com/agents \
  --header 'Authorization: Bearer <token>'
[
  {
    "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",
      "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"
        }
      },
      "systemPrompt": "<string>"
    },
    "archivedAt": "2023-12-25T00:00:00.000Z",
    "completedAt": "2023-12-25T00:00:00.000Z",
    "publishedAt": "2023-12-25T00:00:00.000Z"
  }
]

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"

​
createdBy
string<cuid2> | null
required
​
updatedBy
string<cuid2> | null
required
​
workspaceId
string<cuid2>
required
Maximum string length: 24
​
publishedVersionId
string | null
required
Maximum string length: 24
​
name
string
required
Maximum string length: 255
​
description
string | null
required
Maximum string length: 500
​
slug
string
required
Maximum string length: 255
​
status
enum<string>
required
Available options:
DRAFT,
ARCHIVED,
PUBLISHED,
COMPLETED
​
sourceTemplateId
string | null
required
Maximum string length: 24
​
archivedBy
string | null
required
Maximum string length: 24
​
completedBy
string | null
required
Maximum string length: 24
​
publishedBy
string | null
required
Maximum string length: 24
​
version
object
required
​
archivedAt
Example:

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

​
completedAt
Example:

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

​
publishedAt
Example:

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