Skip to content

Get chat by access ID.

GET
/backend/v1/chats/public/{accessId}

Retrieves a chat using a public access ID, including its prompts and other relevant data.

The chat must be publicly accessible.

Parameters

Path Parameters

accessId*
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",
"id": "string",
"input": "string",
"memory": "string",
"parentId": "string",
"preserve": false,
"projectId": "string",
"provider": "string",
"receivedAt": "string",
"result": "string",
"type": "scan",
"userId": "string"
}
],
"provider": "string",
"user": {
"admin": "string",
"blocked": false,
"createdAt": "string",
"email": "string",
"id": "string",
"lastInvitationSentAt": "string",
"name": "string",
"org": "string",
"permissions": [
[
]
],
"roleIds": [
[
]
],
"roles": [
[
]
],
"social": false,
"teams": [
[
]
],
"verified": true
}
}

Playground

Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Updated at: