DocumentazioneEngagement Platform API
Sign inGet started
Guides
API

Skills

GET
/workspaces/{workspaceId}/inbox/skills
List Agent Skills
Parametri di query
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
Payload della risposta
nextPageToken
string
The token to fetch the next page of results. If empty, there are no more results to fetch.
results
array of object
obbligatorio
Mostra attributi secondari
results.createdAt
string
obbligatorio
results.createdBy
string
obbligatorio
results.description
string
obbligatorio
results.id
string
obbligatorio
results.name
string
obbligatorio
results.updatedAt
string
obbligatorio
results.updatedBy
string
obbligatorio
results.valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
results.values
array of object
obbligatorio
Mostra attributi secondari
results.values.createdAt
string
obbligatorio
results.values.icon
string
obbligatorio
results.values.id
string
obbligatorio
results.values.value
string
obbligatorio
results.workspaceId
string
obbligatorio
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/skills' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/inbox/skills
Create Agent Skill
Payload della richiesta
name
string
obbligatorio
description
string
obbligatorio
valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
values
array of object
obbligatorio
Mostra parametri secondari
values.value
string
obbligatorio
values.icon
string
obbligatorio
Payload della risposta
createdAt
string
obbligatorio
createdBy
string
obbligatorio
description
string
obbligatorio
id
string
obbligatorio
name
string
obbligatorio
updatedAt
string
obbligatorio
updatedBy
string
obbligatorio
valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
values
array of object
obbligatorio
Mostra attributi secondari
values.createdAt
string
obbligatorio
values.icon
string
obbligatorio
values.id
string
obbligatorio
values.value
string
obbligatorio
workspaceId
string
obbligatorio
Esempio di codice
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/inbox/skills' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/inbox/skills/{agentSkillId}
Get Agent Skill
Payload della risposta
createdAt
string
obbligatorio
createdBy
string
obbligatorio
description
string
obbligatorio
id
string
obbligatorio
name
string
obbligatorio
updatedAt
string
obbligatorio
updatedBy
string
obbligatorio
valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
values
array of object
obbligatorio
Mostra attributi secondari
values.createdAt
string
obbligatorio
values.icon
string
obbligatorio
values.id
string
obbligatorio
values.value
string
obbligatorio
workspaceId
string
obbligatorio
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/skills/{agentSkillId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/inbox/skills/{agentSkillId}
Update Agent Skill
Payload della richiesta
name
string
description
string
valueType
string
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
values
array of object
Mostra parametri secondari
values.id
string
values.value
string
values.icon
string
values.createdAt
string
Payload della risposta
createdAt
string
obbligatorio
createdBy
string
obbligatorio
description
string
obbligatorio
id
string
obbligatorio
name
string
obbligatorio
updatedAt
string
obbligatorio
updatedBy
string
obbligatorio
valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
values
array of object
obbligatorio
Mostra attributi secondari
values.createdAt
string
obbligatorio
values.icon
string
obbligatorio
values.id
string
obbligatorio
values.value
string
obbligatorio
workspaceId
string
obbligatorio
Esempio di codice
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/inbox/skills/{agentSkillId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/inbox/skills/{agentSkillId}
Delete Agent Skill
Esempio di codice
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/inbox/skills/{agentSkillId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'