Skills

Last updated 5 months ago

Was this helpful?

List Agent Skills

get

/workspaces/{workspaceId}/inbox/skills

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

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

Limits the number of results to return

pageTokenstring

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

reverseboolean

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",
      "createdAt": "2025-02-21T18:07:31.604Z",
      "updatedAt": "2025-02-21T18:07:31.604Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "values": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "icon": "text",
          "createdAt": "2025-02-21T18:07:31.604Z"
        }
      ]
    }
  ]
}

A paginated list of agent skills.

Create Agent Skill

post

/workspaces/{workspaceId}/inbox/skills

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",
  "createdAt": "2025-02-21T18:07:31.604Z",
  "updatedAt": "2025-02-21T18:07:31.604Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "values": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "icon": "text",
      "createdAt": "2025-02-21T18:07:31.604Z"
    }
  ]
}

The agent skill.

Get Agent Skill

get

/workspaces/{workspaceId}/inbox/skills/{agentSkillId}

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",
  "createdAt": "2025-02-21T18:07:31.604Z",
  "updatedAt": "2025-02-21T18:07:31.604Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "values": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "icon": "text",
      "createdAt": "2025-02-21T18:07:31.604Z"
    }
  ]
}

The agent skill.

Update Agent Skill

patch

/workspaces/{workspaceId}/inbox/skills/{agentSkillId}

Authorizations

Path parameters

workspaceIdstringrequired

agentSkillIdstring · uuidrequired

Body

namestring | nullable

descriptionstring | nullable

valueTypestring · enum | nullable

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

Options: single, multiple, boolean

valuesobject[]

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 '{"valueType":"single","values":[{}]}'

200

404

409

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "valueType": "single",
  "createdAt": "2025-02-21T18:07:31.604Z",
  "updatedAt": "2025-02-21T18:07:31.604Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "values": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "icon": "text",
      "createdAt": "2025-02-21T18:07:31.604Z"
    }
  ]
}

The agent skill.

Delete Agent Skill

delete

/workspaces/{workspaceId}/inbox/skills/{agentSkillId}

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