Skills

List Agent Skills

GET/workspaces/{workspaceId}/inbox/skills

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200

A paginated list of agent skills.

Body

application/json

nextPageTokenstring

The token to fetch the next page of results. If empty, there are no more results to fetch.

results*array of AgentSkill (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/skills', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

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": "2024-11-21T08:40:36.004Z"
        }
      ],
      "createdAt": "2024-11-21T08:40:36.004Z",
      "updatedAt": "2024-11-21T08:40:36.004Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Create Agent Skill

POST/workspaces/{workspaceId}/inbox/skills

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

name*string

description*string

valueType*AgentSkillValueType (enum)

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

singlemultipleboolean

values*array of object

Response

201404409422

The agent skill.

Body

application/json

id*string (uuid)

workspaceId*string (uuid)

name*string

description*string

valueType*AgentSkillValueType (enum)

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

singlemultipleboolean

values*array of AgentSkillValue (object)

createdAt*string (date-time)

updatedAt*string (date-time)

createdBy*string (uuid)

updatedBy*string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/skills', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "description": "text",
      "valueType": "single",
      "values": [
        {
          "value": "text",
          "icon": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

201404409422

{
  "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": "2024-11-21T08:40:36.004Z"
    }
  ],
  "createdAt": "2024-11-21T08:40:36.004Z",
  "updatedAt": "2024-11-21T08:40:36.004Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

Get Agent Skill

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

Authorization

useraccessKey

Path parameters

workspaceId*string

agentSkillId*string (uuid)

Response

200404

The agent skill.

Body

application/json

id*string (uuid)

workspaceId*string (uuid)

name*string

description*string

valueType*AgentSkillValueType (enum)

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

singlemultipleboolean

values*array of AgentSkillValue (object)

createdAt*string (date-time)

updatedAt*string (date-time)

createdBy*string (uuid)

updatedBy*string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/skills/{agentSkillId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "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": "2024-11-21T08:40:36.004Z"
    }
  ],
  "createdAt": "2024-11-21T08:40:36.004Z",
  "updatedAt": "2024-11-21T08:40:36.004Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

Update Agent Skill

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

Authorization

useraccessKey

Path parameters

workspaceId*string

agentSkillId*string (uuid)

Body

application/json

namenullable string

descriptionnullable string

valueTypeAgentSkillValueType (enum)

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

singlemultipleboolean

valuesarray of object

Response

200404409422

The agent skill.

Body

application/json

id*string (uuid)

workspaceId*string (uuid)

name*string

description*string

valueType*AgentSkillValueType (enum)

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

singlemultipleboolean

values*array of AgentSkillValue (object)

createdAt*string (date-time)

updatedAt*string (date-time)

createdBy*string (uuid)

updatedBy*string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/skills/{agentSkillId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404409422

{
  "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": "2024-11-21T08:40:36.004Z"
    }
  ],
  "createdAt": "2024-11-21T08:40:36.004Z",
  "updatedAt": "2024-11-21T08:40:36.004Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

Delete Agent Skill

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

Authorization

useraccessKey

Path parameters

workspaceId*string

agentSkillId*string (uuid)

Response

204404

OK

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/skills/{agentSkillId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}