cURL
curl --request POST \
--url https://api.alcamine.com/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"version": {
"config": {
"llm": {
"provider": "OPENAI",
"temperature": 1
},
"tts": {
"provider": "CARTESIA",
"model": "SONIC_2",
"voiceId": "<string>"
},
"stt": {
"provider": "DEEPGRAM",
"model": "NOVA_3"
}
},
"systemPrompt": "<string>",
"knowledgeBaseId": "<string>",
"inputMode": [],
"followUp": true
},
"description": "<string>",
"slug": "<string>"
}
'import requests
url = "https://api.alcamine.com/agents"
payload = {
"name": "<string>",
"version": {
"config": {
"llm": {
"provider": "OPENAI",
"temperature": 1
},
"tts": {
"provider": "CARTESIA",
"model": "SONIC_2",
"voiceId": "<string>"
},
"stt": {
"provider": "DEEPGRAM",
"model": "NOVA_3"
}
},
"systemPrompt": "<string>",
"knowledgeBaseId": "<string>",
"inputMode": [],
"followUp": True
},
"description": "<string>",
"slug": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
version: {
config: {
llm: {provider: 'OPENAI', temperature: 1},
tts: {provider: 'CARTESIA', model: 'SONIC_2', voiceId: '<string>'},
stt: {provider: 'DEEPGRAM', model: 'NOVA_3'}
},
systemPrompt: '<string>',
knowledgeBaseId: '<string>',
inputMode: [],
followUp: true
},
description: '<string>',
slug: '<string>'
})
};
fetch('https://api.alcamine.com/agents', 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.alcamine.com/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'version' => [
'config' => [
'llm' => [
'provider' => 'OPENAI',
'temperature' => 1
],
'tts' => [
'provider' => 'CARTESIA',
'model' => 'SONIC_2',
'voiceId' => '<string>'
],
'stt' => [
'provider' => 'DEEPGRAM',
'model' => 'NOVA_3'
]
],
'systemPrompt' => '<string>',
'knowledgeBaseId' => '<string>',
'inputMode' => [
],
'followUp' => true
],
'description' => '<string>',
'slug' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.alcamine.com/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"version\": {\n \"config\": {\n \"llm\": {\n \"provider\": \"OPENAI\",\n \"temperature\": 1\n },\n \"tts\": {\n \"provider\": \"CARTESIA\",\n \"model\": \"SONIC_2\",\n \"voiceId\": \"<string>\"\n },\n \"stt\": {\n \"provider\": \"DEEPGRAM\",\n \"model\": \"NOVA_3\"\n }\n },\n \"systemPrompt\": \"<string>\",\n \"knowledgeBaseId\": \"<string>\",\n \"inputMode\": [],\n \"followUp\": true\n },\n \"description\": \"<string>\",\n \"slug\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.alcamine.com/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"version\": {\n \"config\": {\n \"llm\": {\n \"provider\": \"OPENAI\",\n \"temperature\": 1\n },\n \"tts\": {\n \"provider\": \"CARTESIA\",\n \"model\": \"SONIC_2\",\n \"voiceId\": \"<string>\"\n },\n \"stt\": {\n \"provider\": \"DEEPGRAM\",\n \"model\": \"NOVA_3\"\n }\n },\n \"systemPrompt\": \"<string>\",\n \"knowledgeBaseId\": \"<string>\",\n \"inputMode\": [],\n \"followUp\": true\n },\n \"description\": \"<string>\",\n \"slug\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alcamine.com/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"version\": {\n \"config\": {\n \"llm\": {\n \"provider\": \"OPENAI\",\n \"temperature\": 1\n },\n \"tts\": {\n \"provider\": \"CARTESIA\",\n \"model\": \"SONIC_2\",\n \"voiceId\": \"<string>\"\n },\n \"stt\": {\n \"provider\": \"DEEPGRAM\",\n \"model\": \"NOVA_3\"\n }\n },\n \"systemPrompt\": \"<string>\",\n \"knowledgeBaseId\": \"<string>\",\n \"inputMode\": [],\n \"followUp\": true\n },\n \"description\": \"<string>\",\n \"slug\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}Agents
Create an Agent
POST
/
agents
cURL
curl --request POST \
--url https://api.alcamine.com/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"version": {
"config": {
"llm": {
"provider": "OPENAI",
"temperature": 1
},
"tts": {
"provider": "CARTESIA",
"model": "SONIC_2",
"voiceId": "<string>"
},
"stt": {
"provider": "DEEPGRAM",
"model": "NOVA_3"
}
},
"systemPrompt": "<string>",
"knowledgeBaseId": "<string>",
"inputMode": [],
"followUp": true
},
"description": "<string>",
"slug": "<string>"
}
'import requests
url = "https://api.alcamine.com/agents"
payload = {
"name": "<string>",
"version": {
"config": {
"llm": {
"provider": "OPENAI",
"temperature": 1
},
"tts": {
"provider": "CARTESIA",
"model": "SONIC_2",
"voiceId": "<string>"
},
"stt": {
"provider": "DEEPGRAM",
"model": "NOVA_3"
}
},
"systemPrompt": "<string>",
"knowledgeBaseId": "<string>",
"inputMode": [],
"followUp": True
},
"description": "<string>",
"slug": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
version: {
config: {
llm: {provider: 'OPENAI', temperature: 1},
tts: {provider: 'CARTESIA', model: 'SONIC_2', voiceId: '<string>'},
stt: {provider: 'DEEPGRAM', model: 'NOVA_3'}
},
systemPrompt: '<string>',
knowledgeBaseId: '<string>',
inputMode: [],
followUp: true
},
description: '<string>',
slug: '<string>'
})
};
fetch('https://api.alcamine.com/agents', 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.alcamine.com/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'version' => [
'config' => [
'llm' => [
'provider' => 'OPENAI',
'temperature' => 1
],
'tts' => [
'provider' => 'CARTESIA',
'model' => 'SONIC_2',
'voiceId' => '<string>'
],
'stt' => [
'provider' => 'DEEPGRAM',
'model' => 'NOVA_3'
]
],
'systemPrompt' => '<string>',
'knowledgeBaseId' => '<string>',
'inputMode' => [
],
'followUp' => true
],
'description' => '<string>',
'slug' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.alcamine.com/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"version\": {\n \"config\": {\n \"llm\": {\n \"provider\": \"OPENAI\",\n \"temperature\": 1\n },\n \"tts\": {\n \"provider\": \"CARTESIA\",\n \"model\": \"SONIC_2\",\n \"voiceId\": \"<string>\"\n },\n \"stt\": {\n \"provider\": \"DEEPGRAM\",\n \"model\": \"NOVA_3\"\n }\n },\n \"systemPrompt\": \"<string>\",\n \"knowledgeBaseId\": \"<string>\",\n \"inputMode\": [],\n \"followUp\": true\n },\n \"description\": \"<string>\",\n \"slug\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.alcamine.com/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"version\": {\n \"config\": {\n \"llm\": {\n \"provider\": \"OPENAI\",\n \"temperature\": 1\n },\n \"tts\": {\n \"provider\": \"CARTESIA\",\n \"model\": \"SONIC_2\",\n \"voiceId\": \"<string>\"\n },\n \"stt\": {\n \"provider\": \"DEEPGRAM\",\n \"model\": \"NOVA_3\"\n }\n },\n \"systemPrompt\": \"<string>\",\n \"knowledgeBaseId\": \"<string>\",\n \"inputMode\": [],\n \"followUp\": true\n },\n \"description\": \"<string>\",\n \"slug\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alcamine.com/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"version\": {\n \"config\": {\n \"llm\": {\n \"provider\": \"OPENAI\",\n \"temperature\": 1\n },\n \"tts\": {\n \"provider\": \"CARTESIA\",\n \"model\": \"SONIC_2\",\n \"voiceId\": \"<string>\"\n },\n \"stt\": {\n \"provider\": \"DEEPGRAM\",\n \"model\": \"NOVA_3\"\n }\n },\n \"systemPrompt\": \"<string>\",\n \"knowledgeBaseId\": \"<string>\",\n \"inputMode\": [],\n \"followUp\": true\n },\n \"description\": \"<string>\",\n \"slug\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
201 - application/json
Create agent
Maximum string length:
24Example:
"2023-12-25T00:00:00.000Z"
Example:
"2023-12-25T00:00:00.000Z"
Maximum string length:
24Maximum string length:
24Maximum string length:
255Maximum string length:
500Maximum string length:
255Available options:
DRAFT, ARCHIVED, PUBLISHED, COMPLETED Maximum string length:
24Maximum string length:
24Maximum string length:
24Maximum string length:
24Show child attributes
Show child attributes
Example:
"2023-12-25T00:00:00.000Z"
Example:
"2023-12-25T00:00:00.000Z"
Example:
"2023-12-25T00:00:00.000Z"