Update knowledge base

PATCH/v1/knowledge-bases/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Path Parameters

id*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 200

description?|null

starred?boolean

instructions?|

System prompt / instructions used when this base answers questions.

Response Body

`application/json`

cURL

curl -X PATCH "https://example.com/knowledge-bases/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{
  "success": true,
  "knowledgeBase": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "starred": true,
    "sourceCount": -9007199254740991,
    "chunkCount": -9007199254740991,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "unauthorized"
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`