Delete a chat

DELETE 
https://api.vectara.io/v2/chats/:chat_id

Delete a chat and any turns it contains permanently.

Request

Path Parameters

chat_id stringrequired

Possible values: Value must match regular expression cht_.+$

The ID of the chat.

Header Parameters

Request-Timeout integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified seconds or time out.

Request-Timeout-Millis integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified milliseconds or time out.

Responses

204

Successfully deleted the chat.

403

Permissions do not allow deleting the chat.

application/json

Schema

Schema

messages message[]

The messages describing why the error occurred.

request_id string

The ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "messages": [
    "Internal server error."
  ],
  "request_id": "string"
}

404

Corpus or chat not found.

application/json

Schema

Schema

id string

The ID cannot be found.

messages message[]
request_id string

ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "id": "string",
  "messages": [
    "string"
  ],
  "request_id": "string"
}

Authorization: x-api-key

name: x-api-keytype: apiKeyin: header

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X DELETE 'https://api.vectara.io/v2/chats/:chat_id' \
-H 'x-api-key: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://api.vectara.io

Auth

Security Scheme

ApiKeyAuthOAuth2

ApiKeyAuth

Parameters

chat_id — pathrequired

Request-Timeout — header

Request-Timeout-Millis — header

ResponseClear

Click the Send API Request button above and see the response here!