Skip to main content
PATCH
/
agents
/
{id}
cURL
curl --request PATCH \
  --url https://api.alcamine.com/agents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "version": {
    "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>",
    "knowledgeBaseId": "<string>",
    "inputMode": [
      "SMS"
    ],
    "followUp": true
  },
  "name": "<string>",
  "description": "<string>",
  "slug": "<string>"
}
'
{
  "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.

Body

application/json
​
id
string<cuid2>
required
​
version
object
required
​
name
string
Maximum string length: 255
​
description
string | null
Maximum string length: 500
​
slug
string
Maximum string length: 255

Response

200 - application/json

Update agent

​
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"