Skip to content

Get chat.

GET
/backend/v1/chats/{chatId}

Retrieves a chat by its ID, including its associated prompts.

The user must have access to the chat.

Access is automatically granted to the creator and can be manually assigned to others by the owner.

Authorizations

HTTPBearer
TypeHTTP (bearer)

Parameters

Path Parameters

chatId*
Typestring
Required
formatuuid

Responses

Successful Response
application/json
JSON
{
"chat": {
"access": {
"org": true,
"public": "string",
"users": [
"string"
]
},
"createdAt": "string",
"id": "string",
"name": "string",
"projectId": "string",
"promptId": "string",
"promptTemplateId": "string",
"starred": true,
"updatedAt": "string",
"userId": "string"
},
"prompts": [
{
"externalMetadata": "string",
"fromTemplate": false,
"id": "string",
"input": "string",
"memory": "string",
"orgId": "string",
"parentId": "string",
"preserve": false,
"projectId": "string",
"provider": "string",
"receivedAt": "string",
"result": {
"analysis": "string",
"files": "string",
"outcome": "string",
"providerResult": "string",
"response": "string",
"scannerResults": [
{
"completedDate": "string",
"customConfig": false,
"data": {
"matches": [
[
]
],
"type": "regex"
},
"outcome": "string",
"scanDirection": "string",
"scannerId": "string",
"scannerVersionMeta": "string",
"startedDate": "string"
}
]
},
"type": "string",
"userId": "string"
}
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Updated at: