Create Skill

POST

skills

Create Skill

curl --request POST \
  --url https://public.api.serval.com/v2/skills \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "content": "<string>",
  "shouldAlwaysUse": true,
  "isPublished": true,
  "channelFilter": {
    "channels": []
  }
}
'

import requests

url = "https://public.api.serval.com/v2/skills"

payload = {
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "content": "<string>",
    "shouldAlwaysUse": True,
    "isPublished": True,
    "channelFilter": { "channels": [] }
}
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({
    teamId: '<string>',
    name: '<string>',
    description: '<string>',
    content: '<string>',
    shouldAlwaysUse: true,
    isPublished: true,
    channelFilter: {channels: []}
  })
};

fetch('https://public.api.serval.com/v2/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://public.api.serval.com/v2/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([
    'teamId' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'content' => '<string>',
    'shouldAlwaysUse' => true,
    'isPublished' => true,
    'channelFilter' => [
        'channels' => [
                
        ]
    ]
  ]),
  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://public.api.serval.com/v2/skills"

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"content\": \"<string>\",\n  \"shouldAlwaysUse\": true,\n  \"isPublished\": true,\n  \"channelFilter\": {\n    \"channels\": []\n  }\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://public.api.serval.com/v2/skills")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"content\": \"<string>\",\n  \"shouldAlwaysUse\": true,\n  \"isPublished\": true,\n  \"channelFilter\": {\n    \"channels\": []\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/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  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"content\": \"<string>\",\n  \"shouldAlwaysUse\": true,\n  \"isPublished\": true,\n  \"channelFilter\": {\n    \"channels\": []\n  }\n}"

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

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "content": "<string>",
    "shouldAlwaysUse": true,
    "isPublished": true,
    "hasUnpublishedChanges": true,
    "scopedId": "<string>",
    "folderId": "<string>",
    "channelFilter": {
      "channels": [
        "AGENT_CHANNEL_UNSPECIFIED"
      ]
    }
  }
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	`skills:write`
Team-scoped API key	`skills:write`
User-based token (OAuth)	Supported, subject to permissions

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization

string

header

required

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

Body

application/json

teamId

string

required

The ID of the team.

name

string

required

Short title identifying this skill (e.g. "Route password reset tickets to IT"). Shown in the skills list and in chips when the skill is referenced. Keep it descriptive but concise.

description

string

required

TRIGGER condition — when should the help desk agent invoke this skill? Plain prose answering "When should Serval use this skill?". Example: "When a ticket is about an SSO login failure or a user cannot access their Okta account."

content

string

required

BEHAVIOR instructions — how should the help desk agent handle the situation when this skill fires? Plain prose answering "How should Serval handle this situation?". Include the concrete steps, workflows to run (use <@workflow:ID> mentions), who to escalate to (use <@user:ID> mentions), and any relevant context.

shouldAlwaysUse

boolean | null

Whether the help desk agent always uses this skill instead of selecting it by its description. Defaults to false.

isPublished

boolean | null

Whether to publish the skill after creating it. Defaults to false, which saves an unpublished draft.

channelFilter

channel_filter · object

The channels where the help desk agent can use the skill. Omitted or empty selects every channel, including channels added later.

Show child attributes

Response

200 - application/json

Success

data

data · object

The created skill.

Show child attributes

Create Skill

curl --request POST \
  --url https://public.api.serval.com/v2/skills \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "content": "<string>",
  "shouldAlwaysUse": true,
  "isPublished": true,
  "channelFilter": {
    "channels": []
  }
}
'

import requests

url = "https://public.api.serval.com/v2/skills"

payload = {
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "content": "<string>",
    "shouldAlwaysUse": True,
    "isPublished": True,
    "channelFilter": { "channels": [] }
}
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({
    teamId: '<string>',
    name: '<string>',
    description: '<string>',
    content: '<string>',
    shouldAlwaysUse: true,
    isPublished: true,
    channelFilter: {channels: []}
  })
};

fetch('https://public.api.serval.com/v2/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://public.api.serval.com/v2/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([
    'teamId' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'content' => '<string>',
    'shouldAlwaysUse' => true,
    'isPublished' => true,
    'channelFilter' => [
        'channels' => [
                
        ]
    ]
  ]),
  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://public.api.serval.com/v2/skills"

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"content\": \"<string>\",\n  \"shouldAlwaysUse\": true,\n  \"isPublished\": true,\n  \"channelFilter\": {\n    \"channels\": []\n  }\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://public.api.serval.com/v2/skills")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"content\": \"<string>\",\n  \"shouldAlwaysUse\": true,\n  \"isPublished\": true,\n  \"channelFilter\": {\n    \"channels\": []\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/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  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"content\": \"<string>\",\n  \"shouldAlwaysUse\": true,\n  \"isPublished\": true,\n  \"channelFilter\": {\n    \"channels\": []\n  }\n}"

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

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "content": "<string>",
    "shouldAlwaysUse": true,
    "isPublished": true,
    "hasUnpublishedChanges": true,
    "scopedId": "<string>",
    "folderId": "<string>",
    "channelFilter": {
      "channels": [
        "AGENT_CHANNEL_UNSPECIFIED"
      ]
    }
  }
}

Get started

Authentication

Endpoints

Development

Authentication and permissions

Authorizations

Body

Response

​Authentication and permissions

Authorizations

Body

Response

Authentication and permissions