Skip to main content

Get bot

GET 
/api/bots/:botId

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

Request​

Path Parameters

    botId uuidrequired

Responses​

Success

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

Loading...