50d1e60d479d

latestOpenAPI 3.0.02026-08-042945133.6 KB

assistants

List assistants

Retrieves the list of assistants. The result can be filtered, sorted, and paginated.

get/api/v1/assistants

Query parameters

limitinteger

The number of assistants to get.

nextstring

Optional parameter to request the next page.

prevstring

Optional parameter to request the previous page.

Optional resource field name to sort on, case insensitive, e.g. name. Can be prefixed with - to set descending order; defaults to ascending.

spaceIdstring

Optional parameter to filter assistants by space ID.

countTotalboolean

Optional parameter to request total count for query.

Response

Successful operation.

Example response

{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Organization-wide Assistant",
      "tags": [
        "Red",
        "Sales"
      ],
      "title": "Assistant for Sales activities",
      "ownerId": "507f191e810c19729de860ea",
      "spaceId": "507f191e810c19729de860ea",
      "tenantId": "507f191e810c19729de860ea",
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "hasAvatar": true,
      "updatedAt": "2021-10-02T14:20:50.52Z",
      "updatedBy": "507f191e810c19729de860ea",
      "description": "This assistant is used for...",
      "systemMessage": "You are helpful Sales assistant. Provide concise and actionable insights.",
      "knowledgeBases": [
        "507f191e810c19729de860ea"
      ],
      "welcomeMessage": "Welcome to Sales process support Assistant.",
      "customProperties": {
        "customErrors": {
          "outsideScopeError": "Outside of scope error",
          "complexQuestionError": "Complex question error",
          "promptInjectionError": "Prompt injection error"
        }
      },
      "defaultPromptType": "thread",
      "orderedStarterIds": [
        "507f191e810c19729de860ea",
        "787f191e810c19729de860er"
      ]
    }
  ]
}