Get basic info bot

GET 
/api/bots/:botId/info

Gets a specific bot by its id.

Request

Path Parameters

botId uuidrequired

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

<root>
  <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
  <enable>true</enable>
  <title>string</title>
  <description/>
  <strategy>Router</strategy>
  <userPreferences>string</userPreferences>
</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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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
strategy BotRoutingStrategy

Possible values: [Router, Sequential, Llm]

userPreferences stringnullable

Default properties of user preferences.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enable": true,
  "title": "string",
  "description": {},
  "strategy": "Router",
  "userPreferences": "string"
}

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