Get skill

GET 
/api/skills/:skillId

Gets a specific skill by its id. You need to be a Contributor to call this api.

Request

Path Parameters

skillId uuidrequired

Responses

200

Success

application/json;odata.metadata=minimal;odata.streaming=true

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.668Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/json;odata.metadata=minimal;odata.streaming=false

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.669Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/json;odata.metadata=minimal

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.669Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/json;odata.metadata=full;odata.streaming=true

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.669Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/json;odata.metadata=full;odata.streaming=false

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.669Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/json;odata.metadata=full

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.670Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/json;odata.metadata=none;odata.streaming=true

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.670Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/json;odata.metadata=none;odata.streaming=false

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.670Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/json;odata.metadata=none

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.670Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/json;odata.streaming=true

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.670Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/json;odata.streaming=false

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.670Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/json

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.671Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/xml

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

<root>
  <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
  <title>string</title>
  <description/>
  <jobReference>string</jobReference>
  <trainingStatus>Pending</trainingStatus>
  <accessMode>Everyone</accessMode>
  <members>
    <identity>string</identity>
    <privileges>Reader</privileges>
  </members>
  <type>Dialog</type>
  <currentSnapshot>
    <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
    <skillId>3fa85f64-5717-4562-b3fc-2c963f66afa6</skillId>
    <content>string</content>
    <hash>string</hash>
    <languages>string</languages>
    <bootstrapIntents>string</bootstrapIntents>
    <status>Draft</status>
    <trainingStatus>Pending</trainingStatus>
    <variables/>
    <createdOn>2023-12-18T13:30:32.671Z</createdOn>
    <createdBy>string</createdBy>
  </currentSnapshot>
  <tags>
    <key>string</key>
  </tags>
  <properties/>
  <logApiKeys/>
</root>

text/plain

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.671Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

application/octet-stream

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.671Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

text/json

Schema

Schema

id uuid

Skill id (GUID)

title stringnullable

Title of the skill

description objectnullable
Brief description of the skill in different languages.
property name* string
jobReference stringnullable

Internal field to track jobs associated to this skill

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

accessMode SkillAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their skill access privileges
Array [
identity stringnullable
privileges MemberPrivileges
Possible values: [Reader, Owner, Contributor]
]
type SkillType

Possible values: [Dialog, Search]

currentSnapshot object

id uuid

Snapshot id (GUID)

skillId uuid

Skill id (GUID)

content stringnullable

Information associated with the skill that can be versioned through snapshots. This information is in json format.

hash stringnullable

Hash associated with the snapshot is calculated based on the Content.

languages string[]nullable

List of languages associated with the skills.

bootstrapIntents string[]nullable

List of bootstrap intentns associated with the skill.

status SkillStatus

Possible values: [Draft, Published, Retired]

trainingStatus SkillTrainingStatus

Possible values: [Pending, Training, Trained, Error]

variables objectnullable

Skill variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
properties objectnullable

Skill properties

logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "Reader"
    }
  ],
  "type": "Dialog",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "languages": [
      "string"
    ],
    "bootstrapIntents": [
      "string"
    ],
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.671Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "properties": {},
  "logApiKeys": {}
}

400

Bad Request

application/json;odata.metadata=minimal;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=minimal;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=minimal

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/xml

Schema

Schema

error stringnullable

Error message

Example (from schema)

<error>string</error>

text/plain

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/octet-stream

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

text/json

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

401

Unauthorized

application/json;odata.metadata=minimal;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=minimal;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=minimal

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/xml

Schema

Schema

error stringnullable

Error message

Example (from schema)

<error>string</error>

text/plain

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/octet-stream

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

text/json

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

500

Server Error

application/json;odata.metadata=minimal;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=minimal;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=minimal

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=full

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.metadata=none

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.streaming=true

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json;odata.streaming=false

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/json

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/xml

Schema

Schema

error stringnullable

Error message

Example (from schema)

<error>string</error>

text/plain

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

application/octet-stream

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

text/json

Schema

Schema

error stringnullable

Error message

Example (from schema)

{
  "error": "string"
}

Loading...