DokumentasiEngagement Platform API
Sign inGet started
Guides
API

Skills

GET
/workspaces/{workspaceId}/inbox/skills
List Agent Skills
Parameter 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 respons
nextPageToken
string
The token to fetch the next page of results. If empty, there are no more results to fetch.
results
array of object
wajib
Tampilkan atribut turunan
results.createdAt
string
wajib
results.createdBy
string
wajib
results.description
string
wajib
results.id
string
wajib
results.name
string
wajib
results.updatedAt
string
wajib
results.updatedBy
string
wajib
results.valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
results.values
array of object
wajib
Tampilkan atribut turunan
results.values.createdAt
string
wajib
results.values.icon
string
wajib
results.values.id
string
wajib
results.values.value
string
wajib
results.workspaceId
string
wajib
Contoh kode
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 permintaan
name
string
wajib
description
string
wajib
valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
values
array of object
wajib
Tampilkan parameter turunan
values.value
string
wajib
values.icon
string
wajib
Payload respons
createdAt
string
wajib
createdBy
string
wajib
description
string
wajib
id
string
wajib
name
string
wajib
updatedAt
string
wajib
updatedBy
string
wajib
valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
values
array of object
wajib
Tampilkan atribut turunan
values.createdAt
string
wajib
values.icon
string
wajib
values.id
string
wajib
values.value
string
wajib
workspaceId
string
wajib
Contoh kode
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 respons
createdAt
string
wajib
createdBy
string
wajib
description
string
wajib
id
string
wajib
name
string
wajib
updatedAt
string
wajib
updatedBy
string
wajib
valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
values
array of object
wajib
Tampilkan atribut turunan
values.createdAt
string
wajib
values.icon
string
wajib
values.id
string
wajib
values.value
string
wajib
workspaceId
string
wajib
Contoh kode
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 permintaan
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
Tampilkan parameter turunan
values.id
string
values.value
string
values.icon
string
values.createdAt
string
Payload respons
createdAt
string
wajib
createdBy
string
wajib
description
string
wajib
id
string
wajib
name
string
wajib
updatedAt
string
wajib
updatedBy
string
wajib
valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
values
array of object
wajib
Tampilkan atribut turunan
values.createdAt
string
wajib
values.icon
string
wajib
values.id
string
wajib
values.value
string
wajib
workspaceId
string
wajib
Contoh kode
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
Contoh kode
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/inbox/skills/{agentSkillId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'