copilot_skills

activate_copilot_skill

POST

/api/v2/copilot_skills/activate_copilot_skill

Set a copilot skill's status to ACTIVE.

Code
Parameters
----------
id : str
    UUID of the copilot skill to activate.

Returns
-------
dict
    ``{"skill": {...}}`` containing the activated skill.

activate_copilot_skill › Request Body

Request schema for /api/v2/copilot_skills/activate_copilot_skill

request-activate_copilot_skill

id

string · uuid · required

UUID of the copilot skill to activate

activate_copilot_skill › Responses

200

Response schema for /api/v2/copilot_skills/activate_copilot_skill

response-activate_copilot_skill

object · required

success

boolean · required

Indicates if the request was successful

required

Any messages or errors related to the request

POST/api/v2/copilot_skills/activate_copilot_skill

curl --request POST \
  --url /api/v2/copilot_skills/activate_copilot_skill \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "skill": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "description": "description",
      "body": "body",
      "status": "DRAFT",
      "applicable_copilots": [
        "string"
      ],
      "added_by": "00000000-0000-0000-0000-000000000000",
      "updated_by": "00000000-0000-0000-0000-000000000000",
      "updated_by_username": "updated_by_username",
      "date_added": "2024-08-25T15:00:00Z",
      "date_updated": "2024-08-25T15:00:00Z"
    }
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

archive_copilot_skill

POST

/api/v2/copilot_skills/archive_copilot_skill

Set a copilot skill's status to ARCHIVED.

Code
Parameters
----------
id : str
    UUID of the copilot skill to archive.

Returns
-------
dict
    ``{"skill": {...}}`` containing the archived skill.

archive_copilot_skill › Request Body

Request schema for /api/v2/copilot_skills/archive_copilot_skill

request-archive_copilot_skill

id

string · uuid · required

UUID of the copilot skill to archive

archive_copilot_skill › Responses

200

Response schema for /api/v2/copilot_skills/archive_copilot_skill

response-archive_copilot_skill

object · required

success

boolean · required

Indicates if the request was successful

required

Any messages or errors related to the request

POST/api/v2/copilot_skills/archive_copilot_skill

curl --request POST \
  --url /api/v2/copilot_skills/archive_copilot_skill \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "skill": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "description": "description",
      "body": "body",
      "status": "DRAFT",
      "applicable_copilots": [
        "string"
      ],
      "added_by": "00000000-0000-0000-0000-000000000000",
      "updated_by": "00000000-0000-0000-0000-000000000000",
      "updated_by_username": "updated_by_username",
      "date_added": "2024-08-25T15:00:00Z",
      "date_updated": "2024-08-25T15:00:00Z"
    }
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

create_copilot_skill

POST

/api/v2/copilot_skills/create_copilot_skill

Create a new copilot skill.

Code
Parameters
----------
skill : dict
    Skill payload with keys:
    - name (str): Display name, max 120 characters.
    - description (str, optional): Short summary, max 500 characters.
    - body (str): Markdown instruction body, max 20000 characters.
    - status (str, optional): One of DRAFT, ACTIVE, ARCHIVED.
      Defaults to DRAFT.
    - applicable_copilots (list of str, optional): Copilot
      identifiers this skill applies to. Empty list means all
      copilots.

Returns
-------
dict
    ``{"skill": {...}}`` containing the newly created skill with
    server-assigned id and timestamps.

create_copilot_skill › Request Body

Request schema for /api/v2/copilot_skills/create_copilot_skill

request-create_copilot_skill

name

string · maxLength: 120 · required

Display name of the skill

body

string · maxLength: 20000 · required

Markdown instruction body consumed by agents

description

string · maxLength: 500

Short summary of the skill

status

string · enum

Initial status. Defaults to DRAFT if omitted.

Enum values:

DRAFT

ACTIVE

ARCHIVED

Default: DRAFT

applicable_copilots

string[]

Copilot identifiers this skill applies to. Empty means all copilots.

Default: []

create_copilot_skill › Responses

200

Response schema for /api/v2/copilot_skills/create_copilot_skill

response-create_copilot_skill

object · required

success

boolean · required

Indicates if the request was successful

required

Any messages or errors related to the request

POST/api/v2/copilot_skills/create_copilot_skill

curl --request POST \
  --url /api/v2/copilot_skills/create_copilot_skill \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "description",
  "body": "body",
  "status": "DRAFT",
  "applicable_copilots": []
}
'

Example Request Body

{
  "name": "name",
  "description": "description",
  "body": "body",
  "status": "DRAFT",
  "applicable_copilots": []
}

json

Example Responses

{
  "data": {
    "skill": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "description": "description",
      "body": "body",
      "status": "DRAFT",
      "applicable_copilots": [
        "string"
      ],
      "added_by": "00000000-0000-0000-0000-000000000000",
      "updated_by": "00000000-0000-0000-0000-000000000000",
      "updated_by_username": "updated_by_username",
      "date_added": "2024-08-25T15:00:00Z",
      "date_updated": "2024-08-25T15:00:00Z"
    }
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

delete_copilot_skill

POST

/api/v2/copilot_skills/delete_copilot_skill

Hard-delete a copilot skill.

Code
Parameters
----------
id : str
    UUID of the copilot skill to delete.

Returns
-------
dict
    ``{"deleted": true}``

delete_copilot_skill › Request Body

Request schema for /api/v2/copilot_skills/delete_copilot_skill

request-delete_copilot_skill

id

string · uuid · required

UUID of the copilot skill to delete

delete_copilot_skill › Responses

200

Response schema for /api/v2/copilot_skills/delete_copilot_skill

response-delete_copilot_skill

object · required

success

boolean · required

Indicates if the request was successful

required

Any messages or errors related to the request

get_copilot_skill

POST

/api/v2/copilot_skills/get_copilot_skill

Fetch a single copilot skill by ID.

Code
Parameters
----------
id : str
    UUID of the copilot skill to retrieve.

Returns
-------
dict
    ``{"skill": {...}}`` containing the full skill object.

get_copilot_skill › Request Body

Request schema for /api/v2/copilot_skills/get_copilot_skill

request-get_copilot_skill

id

string · uuid · required

UUID of the copilot skill to retrieve

get_copilot_skill › Responses

200

Response schema for /api/v2/copilot_skills/get_copilot_skill

response-get_copilot_skill

object · required

success

boolean · required

Indicates if the request was successful

required

Any messages or errors related to the request

POST/api/v2/copilot_skills/get_copilot_skill

curl --request POST \
  --url /api/v2/copilot_skills/get_copilot_skill \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "skill": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "description": "description",
      "body": "body",
      "status": "DRAFT",
      "applicable_copilots": [
        "string"
      ],
      "added_by": "00000000-0000-0000-0000-000000000000",
      "updated_by": "00000000-0000-0000-0000-000000000000",
      "updated_by_username": "updated_by_username",
      "date_added": "2024-08-25T15:00:00Z",
      "date_updated": "2024-08-25T15:00:00Z"
    }
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

list_copilot_skills

POST

/api/v2/copilot_skills/list_copilot_skills

List copilot skills with optional filters.

Code
Returns all skills visible to the caller, optionally filtered by
status, applicable copilot, or search term. Counts are always
computed against the full carrier-scoped set so the UI can render
tab totals.

Parameters
----------
filters : dict, optional
    A dictionary with optional filter keys:
    - status (str): One of DRAFT, ACTIVE, ARCHIVED. Omit for all.
    - copilot (str): Copilot identifier to filter by applicability.
    - search (str): Case-insensitive substring match on name and
      description.

Returns
-------
dict
    ``{"skills": [...], "counts": {"total": N, "by_status": {...}}}``

list_copilot_skills › Request Body

Request schema for /api/v2/copilot_skills/list_copilot_skills

request-list_copilot_skills

Filter by skill status. Omit or null for all statuses.

copilot

string | null

Filter by applicable copilot identifier (e.g. 'claim-insights'). Returns skills whose applicable_copilots is empty or contains this value.

search

string | null

Case-insensitive substring match on name and description.

list_copilot_skills › Responses

200

Response schema for /api/v2/copilot_skills/list_copilot_skills

response-list_copilot_skills

object · required

success

boolean · required

Indicates if the request was successful

required

Any messages or errors related to the request

POST/api/v2/copilot_skills/list_copilot_skills

curl --request POST \
  --url /api/v2/copilot_skills/list_copilot_skills \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "DRAFT",
  "copilot": "copilot",
  "search": "search"
}
'

Example Request Body

{
  "status": "DRAFT",
  "copilot": "copilot",
  "search": "search"
}

json

Example Responses

{
  "data": {
    "skills": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "description": "description",
        "body": "body",
        "status": "DRAFT",
        "applicable_copilots": [
          "string"
        ],
        "added_by": "00000000-0000-0000-0000-000000000000",
        "updated_by": "00000000-0000-0000-0000-000000000000",
        "updated_by_username": "updated_by_username",
        "date_added": "2024-08-25T15:00:00Z",
        "date_updated": "2024-08-25T15:00:00Z"
      }
    ],
    "counts": {
      "total": 0,
      "by_status": {
        "DRAFT": 0,
        "ACTIVE": 0,
        "ARCHIVED": 0
      }
    }
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

update_copilot_skill

POST

/api/v2/copilot_skills/update_copilot_skill

Update an existing copilot skill.

Code
Any subset of mutable fields may be provided. Immutable fields
(id, added_by, date_added) are ignored if supplied. The updated_by
field is set server-side from the authenticated user.

Parameters
----------
skill : dict
    Update payload with keys:
    - id (str): UUID of the skill to update (required).
    - name (str, optional): New display name, max 120 characters.
    - description (str, optional): New summary, max 500 characters.
    - body (str, optional): New markdown body, max 20000 characters.
    - status (str, optional): One of DRAFT, ACTIVE, ARCHIVED.
    - applicable_copilots (list of str, optional): New copilot list.

Returns
-------
dict
    ``{"skill": {...}}`` containing the updated skill.

update_copilot_skill › Request Body

Request schema for /api/v2/copilot_skills/update_copilot_skill

request-update_copilot_skill

id

string · uuid · required

UUID of the skill to update

name

string · maxLength: 120

New display name

description

string · maxLength: 500

New short summary

body

string · maxLength: 20000

New markdown instruction body

status

string · enum

New lifecycle status

Enum values:

DRAFT

ACTIVE

ARCHIVED

applicable_copilots

string[]

New copilot identifiers list. Empty means all copilots.

update_copilot_skill › Responses

200

Response schema for /api/v2/copilot_skills/update_copilot_skill

response-update_copilot_skill

object · required

success

boolean · required

Indicates if the request was successful

required

Any messages or errors related to the request

POST/api/v2/copilot_skills/update_copilot_skill

curl --request POST \
  --url /api/v2/copilot_skills/update_copilot_skill \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "body": "body",
  "status": "DRAFT",
  "applicable_copilots": [
    "string"
  ]
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "body": "body",
  "status": "DRAFT",
  "applicable_copilots": [
    "string"
  ]
}

json

Example Responses

{
  "data": {
    "skill": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "description": "description",
      "body": "body",
      "status": "DRAFT",
      "applicable_copilots": [
        "string"
      ],
      "added_by": "00000000-0000-0000-0000-000000000000",
      "updated_by": "00000000-0000-0000-0000-000000000000",
      "updated_by_username": "updated_by_username",
      "date_added": "2024-08-25T15:00:00Z",
      "date_updated": "2024-08-25T15:00:00Z"
    }
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

convenience_fees coverages