Skip to main content
POST
/
config
/
templates
Create Template
curl --request POST \
  --url https://api.example.com/config/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "use_case_key": "<string>",
  "recommended_config": {},
  "description": "<string>",
  "required_tools": [
    "<string>"
  ],
  "sample_first_message": "<string>",
  "is_public": false
}
'
import requests

url = "https://api.example.com/config/templates"

payload = {
"name": "<string>",
"use_case_key": "<string>",
"recommended_config": {},
"description": "<string>",
"required_tools": ["<string>"],
"sample_first_message": "<string>",
"is_public": False
}
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>',
use_case_key: '<string>',
recommended_config: {},
description: '<string>',
required_tools: ['<string>'],
sample_first_message: '<string>',
is_public: false
})
};

fetch('https://api.example.com/config/templates', 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.example.com/config/templates",
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>',
'use_case_key' => '<string>',
'recommended_config' => [

],
'description' => '<string>',
'required_tools' => [
'<string>'
],
'sample_first_message' => '<string>',
'is_public' => false
]),
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.example.com/config/templates"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"use_case_key\": \"<string>\",\n \"recommended_config\": {},\n \"description\": \"<string>\",\n \"required_tools\": [\n \"<string>\"\n ],\n \"sample_first_message\": \"<string>\",\n \"is_public\": false\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.example.com/config/templates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"use_case_key\": \"<string>\",\n \"recommended_config\": {},\n \"description\": \"<string>\",\n \"required_tools\": [\n \"<string>\"\n ],\n \"sample_first_message\": \"<string>\",\n \"is_public\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/config/templates")

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 \"use_case_key\": \"<string>\",\n \"recommended_config\": {},\n \"description\": \"<string>\",\n \"required_tools\": [\n \"<string>\"\n ],\n \"sample_first_message\": \"<string>\",\n \"is_public\": false\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "use_case_key": "<string>",
  "description": "<string>",
  "recommended_config": {},
  "required_tools": [
    "<string>"
  ],
  "sample_first_message": "<string>",
  "is_system_template": true,
  "is_public": true,
  "usage_count": 123,
  "created_at": "<string>",
  "updated_at": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Create custom agent template.

name
string
required
Required string length: 3 - 255
use_case_key
string
required
Required string length: 3 - 100
Pattern: ^[a-z_]+$
description
string | null
required_tools
string[] | null
sample_first_message
string | null
is_public
boolean
default:false

Response

Successful Response

Agent template response.

id
string<uuid>
required
owner_id
string<uuid>
required
name
string
required
use_case_key
string
required
description
string | null
required
required_tools
string[]
required
sample_first_message
string | null
required
is_system_template
boolean
required
is_public
boolean
required
usage_count
integer
required
created_at
string
required
updated_at
string
required