Using the API
Rich Transcripts Collection
Entity Collection
Common Collection Operations
Chat
Chat Completions
Generate a model response to a conversation that can include references to video content
POST
/
chat
/
completions
curl --request POST \
--url https://api.cloudglue.dev/v1/chat/completions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"model": "nimbus-001",
"messages": [
{
"role": "system",
"content": "<string>",
"name": "<string>"
}
],
"collections": [
"<string>"
],
"filter": {
"metadata": [
{
"path": "<string>",
"operator": "NotEqual",
"valueText": "<string>",
"valueTextArray": [
"<string>"
]
}
]
},
"force_search": false,
"include_citations": true,
"temperature": 0.7,
"top_p": 1,
"max_tokens": 1024
}'
{
"id": "<string>",
"object": "<string>",
"created": 123,
"model": "<string>",
"choices": [
{
"index": 123,
"message": {
"role": "system",
"content": "<string>",
"name": "<string>"
},
"citations": [
{
"collection_id": "<string>",
"file_id": "<string>",
"segment_id": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"text": "<string>",
"context": "<string>",
"relevant_sources": [
{
"text": "<string>"
}
],
"visual_scene_description": [
{
"text": "<string>",
"start_time": 123,
"end_time": 123
}
],
"scene_text": [
{
"text": "<string>",
"start_time": 123,
"end_time": 123
}
],
"speech": [
{
"speaker": "<string>",
"text": "<string>",
"start_time": 123,
"end_time": 123
}
]
}
]
}
],
"usage": {
"prompt_tokens": 123,
"completion_tokens": 123,
"total_tokens": 123
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Chat completion parameters
The body is of type object
.
Response
200
application/json
Successful response
The response is of type object
.
curl --request POST \
--url https://api.cloudglue.dev/v1/chat/completions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"model": "nimbus-001",
"messages": [
{
"role": "system",
"content": "<string>",
"name": "<string>"
}
],
"collections": [
"<string>"
],
"filter": {
"metadata": [
{
"path": "<string>",
"operator": "NotEqual",
"valueText": "<string>",
"valueTextArray": [
"<string>"
]
}
]
},
"force_search": false,
"include_citations": true,
"temperature": 0.7,
"top_p": 1,
"max_tokens": 1024
}'
{
"id": "<string>",
"object": "<string>",
"created": 123,
"model": "<string>",
"choices": [
{
"index": 123,
"message": {
"role": "system",
"content": "<string>",
"name": "<string>"
},
"citations": [
{
"collection_id": "<string>",
"file_id": "<string>",
"segment_id": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"text": "<string>",
"context": "<string>",
"relevant_sources": [
{
"text": "<string>"
}
],
"visual_scene_description": [
{
"text": "<string>",
"start_time": 123,
"end_time": 123
}
],
"scene_text": [
{
"text": "<string>",
"start_time": 123,
"end_time": 123
}
],
"speech": [
{
"speaker": "<string>",
"text": "<string>",
"start_time": 123,
"end_time": 123
}
]
}
]
}
],
"usage": {
"prompt_tokens": 123,
"completion_tokens": 123,
"total_tokens": 123
}
}
Assistant
Responses are generated using AI and may contain mistakes.