Skills | Bird API Docs

No-code docs

Get Agent Skill

get

Authorizations

Path parameters

workspaceIdstringRequired

agentSkillIdstring · uuidRequired

Responses

application/json

objectOptional

AgentSkill can be assigned to Agent or Ticket. In case of RootItem it specifies what skills Agent should have to handle the item.

application/json

get

GET /workspaces/{workspaceId}/inbox/skills/{agentSkillId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "valueType": "single",
  "values": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "icon": "text",
      "createdAt": "2025-04-18T23:39:34.651Z"
    }
  ],
  "createdAt": "2025-04-18T23:39:34.651Z",
  "updatedAt": "2025-04-18T23:39:34.651Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

Delete Agent Skill

delete

Authorizations

Path parameters

workspaceIdstringRequired

agentSkillIdstring · uuidRequired

Responses

application/json

delete

DELETE /workspaces/{workspaceId}/inbox/skills/{agentSkillId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

List Agent Skills

get

Authorizations

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstringOptional

Pagination token that keeps of track of the current position in the list

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

application/json

all ofOptional

A list of results that supports pagination.

get

GET /workspaces/{workspaceId}/inbox/skills HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

200

A paginated list of agent skills.

{
  "nextPageToken": "text",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "valueType": "single",
      "values": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text",
          "createdAt": "2025-04-18T23:39:34.651Z"
        }
      ],
      "createdAt": "2025-04-18T23:39:34.651Z",
      "updatedAt": "2025-04-18T23:39:34.651Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Create Agent Skill

post

Authorizations

Path parameters

workspaceIdstringRequired

Body

CreateAgentSkill is the request body for creating a new AgentSkill.

namestringRequired

descriptionstringRequired

valueTypestring · enumRequired

AgentSkillValueType defines how can the Values of a Skill can be selected.

Available options:

valuesobject[]Required

Responses

application/json

objectOptional

AgentSkill can be assigned to Agent or Ticket. In case of RootItem it specifies what skills Agent should have to handle the item.

application/json

post

POST /workspaces/{workspaceId}/inbox/skills HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "name": "text",
  "description": "text",
  "valueType": "single",
  "values": [
    {
      "value": "text",
      "icon": "text"
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "valueType": "single",
  "values": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "icon": "text",
      "createdAt": "2025-04-18T23:39:34.651Z"
    }
  ],
  "createdAt": "2025-04-18T23:39:34.651Z",
  "updatedAt": "2025-04-18T23:39:34.651Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

Update Agent Skill

patch

Authorizations

Path parameters

workspaceIdstringRequired

agentSkillIdstring · uuidRequired

Body

UpdateAgentSkill is the request body for updating an existing AgentSkill.

namestring | nullableOptional

descriptionstring | nullableOptional

valueTypestring · enum | nullableOptional

AgentSkillValueType defines how can the Values of a Skill can be selected.

Available options:

valuesobject[]Optional

Responses

application/json

objectOptional

AgentSkill can be assigned to Agent or Ticket. In case of RootItem it specifies what skills Agent should have to handle the item.

application/json

patch

PATCH /workspaces/{workspaceId}/inbox/skills/{agentSkillId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "name": "text",
  "description": "text",
  "valueType": "single",
  "values": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "icon": "text",
      "createdAt": "2025-04-18T23:39:34.651Z"
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "valueType": "single",
  "values": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "icon": "text",
      "createdAt": "2025-04-18T23:39:34.651Z"
    }
  ],
  "createdAt": "2025-04-18T23:39:34.651Z",
  "updatedAt": "2025-04-18T23:39:34.651Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}