Skills

Last updated 6 months ago

Was this helpful?

Get Agent Skill

get

Authorizations

Path parameters

workspaceIdstringrequired

agentSkillIdstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/inbox/skills/{agentSkillId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "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-03-22T09:31:38.028Z"
    }
  ],
  "createdAt": "2025-03-22T09:31:38.028Z",
  "updatedAt": "2025-03-22T09:31:38.028Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

The agent skill.

Delete Agent Skill

delete

Authorizations

Path parameters

workspaceIdstringrequired

agentSkillIdstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/inbox/skills/{agentSkillId}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

List Agent Skills

get

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10optional

Limits the number of results to return

pageTokenstringoptional

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

reverseboolean · default: falseoptional

Order in which to retrieve the results

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/inbox/skills' \
  --header 'Authorization: Bearer jwt'

200

{
  "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-03-22T09:31:38.028Z"
        }
      ],
      "createdAt": "2025-03-22T09:31:38.028Z",
      "updatedAt": "2025-03-22T09:31:38.028Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

A paginated list of agent skills.

Create Agent Skill

post

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestringrequired

descriptionstringrequired

valueTypestring · enumrequired

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

Options: single, multiple, boolean

valuesobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/inbox/skills' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "valueType": "single",
    "values": [
      {
        "value": "text",
        "icon": "text"
      }
    ]
  }'

201

404

409

422

{
  "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-03-22T09:31:38.028Z"
    }
  ],
  "createdAt": "2025-03-22T09:31:38.028Z",
  "updatedAt": "2025-03-22T09:31:38.028Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

The agent skill.

Update Agent Skill

patch

Authorizations

Path parameters

workspaceIdstringrequired

agentSkillIdstring · uuidrequired

Body

namestring | nullableoptional

descriptionstring | nullableoptional

valueTypestring · enum | nullableoptional

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

Options: single, multiple, boolean

valuesobject[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/inbox/skills/{agentSkillId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "valueType": "single",
    "values": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "value": "text",
        "icon": "text",
        "createdAt": "2025-03-22T09:31:38.028Z"
      }
    ]
  }'

200

404

409

422

{
  "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-03-22T09:31:38.028Z"
    }
  ],
  "createdAt": "2025-03-22T09:31:38.028Z",
  "updatedAt": "2025-03-22T09:31:38.028Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

The agent skill.

Get Agent Skill

Delete Agent Skill

List Agent Skills

Create Agent Skill

Show child attributes

Update Agent Skill

Show child attributes