Create an agent skill

POST

api

agent-builder

agents

{id}

skills

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/skills \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "instructions",
  "name": "Pricing objections",
  "whenToUse": "The caller says the service costs too much.",
  "enabled": true,
  "instructions": "Acknowledge the concern, explain the value, and never invent a discount.",
  "expectedVersion": 4
}'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/agents/{id}/skills"

payload = {
    "type": "instructions",
    "name": "Pricing objections",
    "instructions": "Acknowledge the concern, explain the value, and never invent a discount."
}
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({
    type: 'instructions',
    name: 'Pricing objections',
    instructions: 'Acknowledge the concern, explain the value, and never invent a discount.'
  })
};

fetch('https://api.teamfollowup.ai/api/agent-builder/agents/{id}/skills', 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.teamfollowup.ai/api/agent-builder/agents/{id}/skills",
  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([
    'type' => 'instructions',
    'name' => 'Pricing objections',
    'instructions' => 'Acknowledge the concern, explain the value, and never invent a discount.'
  ]),
  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.teamfollowup.ai/api/agent-builder/agents/{id}/skills"

	payload := strings.NewReader("{\n  \"type\": \"instructions\",\n  \"name\": \"Pricing objections\",\n  \"instructions\": \"Acknowledge the concern, explain the value, and never invent a discount.\"\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.teamfollowup.ai/api/agent-builder/agents/{id}/skills")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"instructions\",\n  \"name\": \"Pricing objections\",\n  \"instructions\": \"Acknowledge the concern, explain the value, and never invent a discount.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/agents/{id}/skills")

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  \"type\": \"instructions\",\n  \"name\": \"Pricing objections\",\n  \"instructions\": \"Acknowledge the concern, explain the value, and never invent a discount.\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "skill": {
    "id": "pricing_objections",
    "type": "instructions",
    "name": "Pricing objections",
    "whenToUse": "The caller says the service costs too much.",
    "enabled": true,
    "instructions": "Acknowledge the concern, explain the value, and never invent a discount."
  },
  "version": 5
}

{
  "success": false,
  "error": "NotFound",
  "message": "We couldn't find that. It may have been moved or deleted.",
  "errors": [
    {
      "field": "name",
      "code": "FieldRequired",
      "message": "Please fill this in."
    }
  ],
  "details": {},
  "ref": "3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b"
}

{
  "success": false,
  "error": "NotFound",
  "message": "We couldn't find that. It may have been moved or deleted.",
  "errors": [
    {
      "field": "name",
      "code": "FieldRequired",
      "message": "Please fill this in."
    }
  ],
  "details": {},
  "ref": "3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b"
}

{
  "success": false,
  "error": "NotFound",
  "message": "We couldn't find that. It may have been moved or deleted.",
  "errors": [
    {
      "field": "name",
      "code": "FieldRequired",
      "message": "Please fill this in."
    }
  ],
  "details": {},
  "ref": "3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b"
}

{
  "success": false,
  "error": "NotFound",
  "message": "We couldn't find that. It may have been moved or deleted.",
  "errors": [
    {
      "field": "name",
      "code": "FieldRequired",
      "message": "Please fill this in."
    }
  ],
  "details": {},
  "ref": "3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b"
}

{
  "success": false,
  "error": "CONFLICT",
  "message": "This changed while you were working on it. Please refresh and try again."
}

{
  "success": false,
  "error": "NotFound",
  "message": "We couldn't find that. It may have been moved or deleted.",
  "errors": [
    {
      "field": "name",
      "code": "FieldRequired",
      "message": "Please fill this in."
    }
  ],
  "details": {},
  "ref": "3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b"
}

{
  "success": false,
  "error": "NotFound",
  "message": "We couldn't find that. It may have been moved or deleted.",
  "errors": [
    {
      "field": "name",
      "code": "FieldRequired",
      "message": "Please fill this in."
    }
  ],
  "details": {},
  "ref": "3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b"
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

string

required

Agent id.

Minimum string length: 1

Body

application/json

Choose a type to create either a custom instruction skill or a configured in-call tool.

type

string

required

The kind of skill. instructions is a custom playbook. The other types add a built-in call tool. The type cannot change later.

Allowed value: "instructions"

name

string

required

Human-readable name for the skill. Longer input is truncated to 120 characters and saved, not rejected. Whitespace is trimmed first, so a whitespace-only name is rejected as empty.

Required string length: 1 - 120

Pattern: \S

instructions

string

required

The playbook the agent follows once the trigger lands. Longer input is truncated to this length and saved; it is not rejected. Leading and trailing whitespace is stripped before validation, so a value that is only whitespace counts as empty.

Required string length: 1 - 12000

Pattern: \S

string

Stable skill id. Generated when omitted during creation.

Minimum string length: 1

whenToUse

string

default:""

Plain-English trigger: when the agent should reach for this. Longer input is truncated to 300 characters and saved, not rejected.

Maximum string length: 300

enabled

boolean

default:true

Whether the skill is active on the agent. A disabled skill is kept but its tool is not installed.

expectedVersion

integer

Version from the latest skills read. When supplied, a stale write returns 409.

Required range: x >= 0

{key}

any

Response

Skill created.

success

boolean

required

version

integer

required

Required range: x >= 0

skill

Custom instruction skill · object

required

A plain-English playbook that teaches the agent when and how to handle a use case.

Show child attributes

partialFailures

string[]

Background synchronization work that did not finish. The skill change was still saved.

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/skills \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "instructions",
  "name": "Pricing objections",
  "whenToUse": "The caller says the service costs too much.",
  "enabled": true,
  "instructions": "Acknowledge the concern, explain the value, and never invent a discount.",
  "expectedVersion": 4
}'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/agents/{id}/skills"

payload = {
    "type": "instructions",
    "name": "Pricing objections",
    "instructions": "Acknowledge the concern, explain the value, and never invent a discount."
}
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({
    type: 'instructions',
    name: 'Pricing objections',
    instructions: 'Acknowledge the concern, explain the value, and never invent a discount.'
  })
};

fetch('https://api.teamfollowup.ai/api/agent-builder/agents/{id}/skills', 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.teamfollowup.ai/api/agent-builder/agents/{id}/skills",
  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([
    'type' => 'instructions',
    'name' => 'Pricing objections',
    'instructions' => 'Acknowledge the concern, explain the value, and never invent a discount.'
  ]),
  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.teamfollowup.ai/api/agent-builder/agents/{id}/skills"

	payload := strings.NewReader("{\n  \"type\": \"instructions\",\n  \"name\": \"Pricing objections\",\n  \"instructions\": \"Acknowledge the concern, explain the value, and never invent a discount.\"\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.teamfollowup.ai/api/agent-builder/agents/{id}/skills")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"instructions\",\n  \"name\": \"Pricing objections\",\n  \"instructions\": \"Acknowledge the concern, explain the value, and never invent a discount.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/agents/{id}/skills")

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  \"type\": \"instructions\",\n  \"name\": \"Pricing objections\",\n  \"instructions\": \"Acknowledge the concern, explain the value, and never invent a discount.\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "skill": {
    "id": "pricing_objections",
    "type": "instructions",
    "name": "Pricing objections",
    "whenToUse": "The caller says the service costs too much.",
    "enabled": true,
    "instructions": "Acknowledge the concern, explain the value, and never invent a discount."
  },
  "version": 5
}

{
  "success": false,
  "error": "NotFound",
  "message": "We couldn't find that. It may have been moved or deleted.",
  "errors": [
    {
      "field": "name",
      "code": "FieldRequired",
      "message": "Please fill this in."
    }
  ],
  "details": {},
  "ref": "3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b"
}

{
  "success": false,
  "error": "NotFound",
  "message": "We couldn't find that. It may have been moved or deleted.",
  "errors": [
    {
      "field": "name",
      "code": "FieldRequired",
      "message": "Please fill this in."
    }
  ],
  "details": {},
  "ref": "3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b"
}

{
  "success": false,
  "error": "NotFound",
  "message": "We couldn't find that. It may have been moved or deleted.",
  "errors": [
    {
      "field": "name",
      "code": "FieldRequired",
      "message": "Please fill this in."
    }
  ],
  "details": {},
  "ref": "3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b"
}

{
  "success": false,
  "error": "NotFound",
  "message": "We couldn't find that. It may have been moved or deleted.",
  "errors": [
    {
      "field": "name",
      "code": "FieldRequired",
      "message": "Please fill this in."
    }
  ],
  "details": {},
  "ref": "3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b"
}

{
  "success": false,
  "error": "CONFLICT",
  "message": "This changed while you were working on it. Please refresh and try again."
}

{
  "success": false,
  "error": "NotFound",
  "message": "We couldn't find that. It may have been moved or deleted.",
  "errors": [
    {
      "field": "name",
      "code": "FieldRequired",
      "message": "Please fill this in."
    }
  ],
  "details": {},
  "ref": "3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b"
}

{
  "success": false,
  "error": "NotFound",
  "message": "We couldn't find that. It may have been moved or deleted.",
  "errors": [
    {
      "field": "name",
      "code": "FieldRequired",
      "message": "Please fill this in."
    }
  ],
  "details": {},
  "ref": "3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b"
}

Developer setup

Agents

TFU Live

In-call Capabilities

Campaigns

Master agent

Phone Numbers

Caller ID

Voices

Projects

Calls

Contacts

Native Contacts

Native Calendar

Analytics

Billing

Authorizations

Path Parameters

Body

Response