Create bot

POST 
/api/bots

Creates a new empty bot. You need the Creator role to call this api.

Request

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

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

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

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

application/json;odata.metadata=minimal

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

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

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

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

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

application/json;odata.metadata=full

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

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

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

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

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

application/json;odata.metadata=none

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

application/json;odata.streaming=true

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

application/json;odata.streaming=false

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

application/json

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

application/xml

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

text/plain

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

text/json

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

application/*+json

Body

id uuidnullable

Bot id (GUID)

title stringnullable

Title of the bot

description objectnullable
Brief description of the bot in different languages.
property name* string
accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

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

Responses

200

Success

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

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.291Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

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

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.292Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

application/json;odata.metadata=minimal

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.292Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

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

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.292Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

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

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.292Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

application/json;odata.metadata=full

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.293Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

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

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.293Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

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

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.293Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

application/json;odata.metadata=none

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.293Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

application/json;odata.streaming=true

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.294Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

application/json;odata.streaming=false

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.294Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

application/json

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.294Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

application/xml

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

<root>
  <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
  <enable>true</enable>
  <title>string</title>
  <description/>
  <jobReference>string</jobReference>
  <trainingStatus>Pending</trainingStatus>
  <accessMode>Everyone</accessMode>
  <members>
    <identity>string</identity>
    <privileges>User</privileges>
  </members>
  <strategy>Router</strategy>
  <currentSnapshot>
    <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
    <botId>3fa85f64-5717-4562-b3fc-2c963f66afa6</botId>
    <content>string</content>
    <hash>string</hash>
    <status>Draft</status>
    <trainingStatus>Pending</trainingStatus>
    <variables/>
    <createdOn>2023-12-18T13:30:32.295Z</createdOn>
    <createdBy>string</createdBy>
  </currentSnapshot>
  <tags>
    <key>string</key>
  </tags>
  <apiKey>string</apiKey>
  <apiUrl>string</apiUrl>
  <logApiKeys/>
  <properties/>
</root>

text/plain

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.295Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

application/octet-stream

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.295Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

text/json

Schema

Schema

id uuid

Bot id (GUID)

enable boolean

Indicates if the bot is available for use

title stringnullable

Title of the bot

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

Internal field to track jobs associated to this bot

trainingStatus BotTrainingStatus

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

accessMode BotAccessMode

Possible values: [Everyone, MembersOnly]

members object[]nullable
List of users and their bot access privileges
Array [
identity stringnullable
privileges BotMemberPrivileges
Possible values: [User, Owner, Contributor, ImpersonatedUser, Tester, Reader]
]
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

currentSnapshot object

id uuid

Snapshot id (GUID)

botId uuid

Bot id (GUID)

content stringnullable

Information associated with the bot 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.

status BotStatus

Possible values: [Draft, Published, Retired]

trainingStatus BotTrainingStatus

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

variables objectnullable

Bot variables

createdOn date-time

Creation date

createdBy stringnullable

Creation user

tags object[]nullable
List of tags
Array [
key stringnullable
value nullable
]
apiKey stringnullable
apiUrl stringnullable
logApiKeys objectnullable
property name* LogApiKeyItemnullable
audiences string[]nullable
properties objectnullable

Bot properties

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "jobReference": "string",
  "trainingStatus": "Pending",
  "accessMode": "Everyone",
  "members": [
    {
      "identity": "string",
      "privileges": "User"
    }
  ],
  "strategy": "Router",
  "currentSnapshot": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "botId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "content": "string",
    "hash": "string",
    "status": "Draft",
    "trainingStatus": "Pending",
    "variables": {},
    "createdOn": "2023-12-18T13:30:32.296Z",
    "createdBy": "string"
  },
  "tags": [
    {
      "key": "string"
    }
  ],
  "apiKey": "string",
  "apiUrl": "string",
  "logApiKeys": {},
  "properties": {}
}

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...