Skip to main content
POST
/
v2
/
guidances
Create Guidance
curl --request POST \
  --url https://public.api.serval.com/v2/guidances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "name": "<string>",
  "content": "<string>",
  "description": "<string>",
  "shouldAlwaysUse": true,
  "isPublished": true
}
'
{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "content": "<string>",
    "shouldAlwaysUse": true,
    "isPublished": true,
    "hasUnpublishedChanges": true
  }
}

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 Help Desk 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.

​
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. Required for the skill to actually do anything useful.

​
description
string

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." Required for the skill to be matched against incoming tickets.

​
shouldAlwaysUse
boolean | null

Whether this guidance should always be used (optional, defaults to false).

​
isPublished
boolean | null

Whether to publish the guidance after creation (optional).

Response

Success

​
data
data · object

The created guidance.