Assistant Instances

Instances of AI Assistant associated with a project.

Endpoints

The AI Assistant Instance object

  • idinteger

    The unique identifier for the AI assistant instance.

  • projectIdinteger

    The unique identifier for the project the AI Assistant instance belongs to.

  • entityIDstring

    Optional. If present, this identifies the entity instane associated with the AI Assistant instance.

  • chatPlatform| options are slack, teams, direct

    Identifies one of the supported chat platforms that this AI Assistant instance is integrated with.

  • slackConfigobject

    This field is required if chatPlatform is 'slack' and contains necessary configuration of a Slack chatbot.

  • namestring

    Display name of AI Assistant.

  • descriptionstring

    Additional information about AI Assistant.

  • createdAtstring| format is date-time

    Instance creation timestamp.

  • updatedAtstring| format is date-time

    Timestamp of last update.

Get AI Assistant instances

Endpoint
get /assistants
Description

Get a list of AI Assistant instances.

Query Parameters

  • projectId

    integer

    required

    Return Assistant instances of the specified project.

  • skip

    integer

    Number of items to skip over.

  • limit

    integer

    Maximum number of items to return.

    Default value is 25

    Minimum value is 1

Request Headers What's this?

  • Authorization

    required

    Must contain the key of a user with permissions to read assistant instances, or a project API key.

Response
  • 200Successfully retrieved the assistant instances.
  • 401Authorization is required to access this resource.
  • 403Request failed because of denied permission.
  • 500An unexpected error has occurred.
  • 503The service is temporarily unavailable.

Create AI Assistant instance

Endpoint
post /assistants
Description

Create an AI Assistant instance in a project.

Request Headers What's this?

  • Authorization

    required

    Must contain the key of a user with permissions to create assistant instances, or a project API key with admin permission.

Request Body

  • slackConfig

    object

    This field is required if chatPlatform is 'slack' and contains necessary configuration of a Slack chatbot.

  • name

    string

    required

    Display name of AI Assistant.

  • description

    string

    Additional information about AI Assistant.

Response
  • 201New AI Assistant successfully created.
  • 401Authorization is required to access this resource.
  • 403Request failed because of invalid data or denied permission.
  • 500An unexpected error has occurred.
  • 503The service is temporarily unavailable.

Get assistant

Endpoint
get /assistants/{assistantId}
Description

Return the AI Assistant instance with the specified ID.

Path Parameters

  • assistantId

    integer

    required

    The unique ID for a specific Assistant instance.

Request Headers What's this?

  • Authorization

    required

    Must contain the key of a user with permissions to read assistant instances, or a project API key.

Response
  • 200Successfully retrieved the specified assistant instance.
  • 401Authorization is required to access this resource.
  • 403Request failed because of denied permission.
  • 404The requested assistant does not exist or is not accessible.
  • 500An unexpected error has occurred.
  • 503The service is temporarily unavailable.

Update an AI Assistant instance

Endpoint
patch /assistants/{assistantId}
Description

Update attributes and configurations of the AI Assistant instance with the sepcified ID.

Path Parameters

  • assistantId

    integer

    required

    The unique ID for a specific Assistant instance.

Request Headers What's this?

  • Authorization

    required

    Must contain the key of a user with permissions to update assistant instances, or a project API key with admin permission.

Request Body

  • slackConfig

    object

    This field is required if chatPlatform is 'slack' and contains necessary configuration of a Slack chatbot.

  • name

    string

    required

    Display name of AI Assistant.

  • description

    string

    Additional information about AI Assistant.

Response
  • 204Successfully update the specified assistant instance.
  • 401Authorization is required to access this resource.
  • 403Request failed because of invalid data or denied permission.
  • 404The requested assistant does not exist or is not accessible.
  • 500An unexpected error has occurred.
  • 503The service is temporarily unavailable.

Delete an AI Assistant instance

Endpoint
delete /assistants/{assistantId}
Description

Delete the AI Assistant instance with the sepcified ID.

Path Parameters

  • assistantId

    integer

    required

    The unique ID for a specific Assistant instance.

Request Headers What's this?

  • Authorization

    required

    Must contain the key of a user with permissions to delete assistant instances, or a project API key with admin permission.

Response
  • 204Successfully deleted the specified assistant instance.
  • 401Authorization is required to access this resource.
  • 403Request failed because of invalid data or denied permission.
  • 404The required assistant does not exist or is not accessible.
  • 409The assistant cannot be deleted because it is being used by another part of the system.
  • 500An unexpected error has occurred.
  • 503The service is temporarily unavailable.