starters

Update a starter

Updates the specified starter.

put/api/v1/assistants/{assistantId}/starters/{starterId}

Path parameters

assistantIdstring uuid required

Example:507f191e810c19729de860ea

The ID of the assistant containing the requested starter.

starterIdstring uuid required

Example:507f191e810c19729de860ea

The ID of the starter to retrieve.

Request body

idstring uuid required

Unique identifier of the starter.

questionstring required

Starter sample question.

createdAtstring date-time required

Datetime when the starter was created.

updatedAtstring date-time required

Datetime when the starter was updated.

additionalContextstring required

Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.

Example request

{
  "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"
  }
}

Response

Successfully updated the starter.