Sign in

v1

latestOpenAPI 3.0.02026-08-042945133.6 KB
starters

List starters

Retrieves the list of starters for the assistant.

get/api/v1/assistants/{assistantId}/starters

Path parameters

assistantIdstring uuid required
Example:507f191e810c19729de860ea

The ID of the assistant from which to retrieve starters.

Query parameters

limitinteger

The number of starters to get.

nextstring

Optional parameter to request the next page.

prevstring

Optional parameter to request the previous page.

sort'QUESTION' | '-QUESTION' | 'CREATED' | '-CREATED' | 'UPDATED' | '-UPDATED'

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

Response

Successfully retrieved the assistant's starters.

Example response

{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "question": "Where was Genghis Khan buried?",
      "createdAt": "2021-10-02T14:20:50.52Z",
      "followups": [
        {
          "id": "507f191e810c19729de860ea",
          "question": "Where was Genghis Khan buried?",
          "recommendedAnswer": {
            "contentType": "text | markdown | html"
          }
        }
      ],
      "updatedAt": "2021-10-02T14:20:50.52Z",
      "recommendedAnswer": {
        "contentType": "text | markdown | html"
      }
    }
  ]
}