Create Response

Create a new response using the Response API. This endpoint provides an OpenAI Responses-compatible interface for chat completions with video collections.

The response can be processed synchronously (default) or asynchronously using the background parameter.

POST /responses

Create a response

cURL

curl --request POST \
  --url https://api.cloudglue.dev/v1/responses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "nimbus-001",
  "input": "<string>",
  "instructions": "<string>",
  "temperature": 1,
  "knowledge_base": {
    "collections": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "source": "collections",
    "filter": {
      "metadata": [
        {
          "path": "<string>",
          "valueText": "<string>",
          "valueTextArray": [
            "<string>"
          ]
        }
      ],
      "video_info": [
        {
          "valueText": "<string>",
          "valueTextArray": [
            "<string>"
          ]
        }
      ],
      "file": [
        {
          "valueText": "<string>",
          "valueTextArray": [
            "<string>"
          ]
        }
      ],
      "source_metadata": [
        {
          "path": "<string>",
          "valueText": "<string>",
          "valueTextArray": [
            "<string>"
          ]
        }
      ]
    }
  },
  "include": [
    "cloudglue_citations.media_descriptions"
  ],
  "tools": [
    {
      "type": "function",
      "name": "<string>",
      "parameters": {},
      "description": "<string>",
      "strict": true
    }
  ],
  "max_output_tokens": 64000,
  "background": true,
  "stream": true
}
'

import requests

url = "https://api.cloudglue.dev/v1/responses"

payload = {
    "model": "nimbus-001",
    "input": "<string>",
    "instructions": "<string>",
    "temperature": 1,
    "knowledge_base": {
        "collections": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
        "source": "collections",
        "filter": {
            "metadata": [
                {
                    "path": "<string>",
                    "valueText": "<string>",
                    "valueTextArray": ["<string>"]
                }
            ],
            "video_info": [
                {
                    "valueText": "<string>",
                    "valueTextArray": ["<string>"]
                }
            ],
            "file": [
                {
                    "valueText": "<string>",
                    "valueTextArray": ["<string>"]
                }
            ],
            "source_metadata": [
                {
                    "path": "<string>",
                    "valueText": "<string>",
                    "valueTextArray": ["<string>"]
                }
            ]
        }
    },
    "include": ["cloudglue_citations.media_descriptions"],
    "tools": [
        {
            "type": "function",
            "name": "<string>",
            "parameters": {},
            "description": "<string>",
            "strict": True
        }
    ],
    "max_output_tokens": 64000,
    "background": True,
    "stream": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'nimbus-001',
    input: '<string>',
    instructions: '<string>',
    temperature: 1,
    knowledge_base: {
      collections: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
      source: 'collections',
      filter: {
        metadata: [{path: '<string>', valueText: '<string>', valueTextArray: ['<string>']}],
        video_info: [{valueText: '<string>', valueTextArray: ['<string>']}],
        file: [{valueText: '<string>', valueTextArray: ['<string>']}],
        source_metadata: [{path: '<string>', valueText: '<string>', valueTextArray: ['<string>']}]
      }
    },
    include: ['cloudglue_citations.media_descriptions'],
    tools: [
      {
        type: 'function',
        name: '<string>',
        parameters: {},
        description: '<string>',
        strict: true
      }
    ],
    max_output_tokens: 64000,
    background: true,
    stream: true
  })
};

fetch('https://api.cloudglue.dev/v1/responses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cloudglue.dev/v1/responses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => 'nimbus-001',
    'input' => '<string>',
    'instructions' => '<string>',
    'temperature' => 1,
    'knowledge_base' => [
        'collections' => [
                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ],
        'source' => 'collections',
        'filter' => [
                'metadata' => [
                                [
                                                                'path' => '<string>',
                                                                'valueText' => '<string>',
                                                                'valueTextArray' => [
                                                                                                                                '<string>'
                                                                ]
                                ]
                ],
                'video_info' => [
                                [
                                                                'valueText' => '<string>',
                                                                'valueTextArray' => [
                                                                                                                                '<string>'
                                                                ]
                                ]
                ],
                'file' => [
                                [
                                                                'valueText' => '<string>',
                                                                'valueTextArray' => [
                                                                                                                                '<string>'
                                                                ]
                                ]
                ],
                'source_metadata' => [
                                [
                                                                'path' => '<string>',
                                                                'valueText' => '<string>',
                                                                'valueTextArray' => [
                                                                                                                                '<string>'
                                                                ]
                                ]
                ]
        ]
    ],
    'include' => [
        'cloudglue_citations.media_descriptions'
    ],
    'tools' => [
        [
                'type' => 'function',
                'name' => '<string>',
                'parameters' => [
                                
                ],
                'description' => '<string>',
                'strict' => true
        ]
    ],
    'max_output_tokens' => 64000,
    'background' => true,
    'stream' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudglue.dev/v1/responses"

	payload := strings.NewReader("{\n  \"model\": \"nimbus-001\",\n  \"input\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"temperature\": 1,\n  \"knowledge_base\": {\n    \"collections\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"source\": \"collections\",\n    \"filter\": {\n      \"metadata\": [\n        {\n          \"path\": \"<string>\",\n          \"valueText\": \"<string>\",\n          \"valueTextArray\": [\n            \"<string>\"\n          ]\n        }\n      ],\n      \"video_info\": [\n        {\n          \"valueText\": \"<string>\",\n          \"valueTextArray\": [\n            \"<string>\"\n          ]\n        }\n      ],\n      \"file\": [\n        {\n          \"valueText\": \"<string>\",\n          \"valueTextArray\": [\n            \"<string>\"\n          ]\n        }\n      ],\n      \"source_metadata\": [\n        {\n          \"path\": \"<string>\",\n          \"valueText\": \"<string>\",\n          \"valueTextArray\": [\n            \"<string>\"\n          ]\n        }\n      ]\n    }\n  },\n  \"include\": [\n    \"cloudglue_citations.media_descriptions\"\n  ],\n  \"tools\": [\n    {\n      \"type\": \"function\",\n      \"name\": \"<string>\",\n      \"parameters\": {},\n      \"description\": \"<string>\",\n      \"strict\": true\n    }\n  ],\n  \"max_output_tokens\": 64000,\n  \"background\": true,\n  \"stream\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cloudglue.dev/v1/responses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"nimbus-001\",\n  \"input\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"temperature\": 1,\n  \"knowledge_base\": {\n    \"collections\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"source\": \"collections\",\n    \"filter\": {\n      \"metadata\": [\n        {\n          \"path\": \"<string>\",\n          \"valueText\": \"<string>\",\n          \"valueTextArray\": [\n            \"<string>\"\n          ]\n        }\n      ],\n      \"video_info\": [\n        {\n          \"valueText\": \"<string>\",\n          \"valueTextArray\": [\n            \"<string>\"\n          ]\n        }\n      ],\n      \"file\": [\n        {\n          \"valueText\": \"<string>\",\n          \"valueTextArray\": [\n            \"<string>\"\n          ]\n        }\n      ],\n      \"source_metadata\": [\n        {\n          \"path\": \"<string>\",\n          \"valueText\": \"<string>\",\n          \"valueTextArray\": [\n            \"<string>\"\n          ]\n        }\n      ]\n    }\n  },\n  \"include\": [\n    \"cloudglue_citations.media_descriptions\"\n  ],\n  \"tools\": [\n    {\n      \"type\": \"function\",\n      \"name\": \"<string>\",\n      \"parameters\": {},\n      \"description\": \"<string>\",\n      \"strict\": true\n    }\n  ],\n  \"max_output_tokens\": 64000,\n  \"background\": true,\n  \"stream\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cloudglue.dev/v1/responses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"nimbus-001\",\n  \"input\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"temperature\": 1,\n  \"knowledge_base\": {\n    \"collections\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"source\": \"collections\",\n    \"filter\": {\n      \"metadata\": [\n        {\n          \"path\": \"<string>\",\n          \"valueText\": \"<string>\",\n          \"valueTextArray\": [\n            \"<string>\"\n          ]\n        }\n      ],\n      \"video_info\": [\n        {\n          \"valueText\": \"<string>\",\n          \"valueTextArray\": [\n            \"<string>\"\n          ]\n        }\n      ],\n      \"file\": [\n        {\n          \"valueText\": \"<string>\",\n          \"valueTextArray\": [\n            \"<string>\"\n          ]\n        }\n      ],\n      \"source_metadata\": [\n        {\n          \"path\": \"<string>\",\n          \"valueText\": \"<string>\",\n          \"valueTextArray\": [\n            \"<string>\"\n          ]\n        }\n      ]\n    }\n  },\n  \"include\": [\n    \"cloudglue_citations.media_descriptions\"\n  ],\n  \"tools\": [\n    {\n      \"type\": \"function\",\n      \"name\": \"<string>\",\n      \"parameters\": {},\n      \"description\": \"<string>\",\n      \"strict\": true\n    }\n  ],\n  \"max_output_tokens\": 64000,\n  \"background\": true,\n  \"stream\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "response",
  "created_at": 123,
  "model": "<string>",
  "instructions": "<string>",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "<string>",
          "annotations": [
            {
              "type": "cloudglue_citation",
              "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "start_time": 123,
              "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "end_time": 123,
              "context": "<string>",
              "relevant_sources": [
                "<string>"
              ],
              "visual_scene_description": [
                "<string>"
              ],
              "scene_text": [
                "<string>"
              ],
              "speech": [
                "<string>"
              ],
              "audio_description": [
                "<string>"
              ]
            }
          ]
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 123,
    "output_tokens": 123,
    "total_tokens": 123
  },
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response creation parameters

model · string · required

The model to use for generating the response.

• nimbus-001: Fast general question answering model. Requires knowledge_base. Default temperature: 0.7.
• nimbus-002-preview: Light reasoning model capable of multi-step reasoning, cross-video synthesis, and structured entity data. Requires knowledge_base. Supports entity_collections in the knowledge base. Default temperature: 1.

Metadata collections (collection_type: 'metadata') in the knowledge base are only supported by nimbus-002-preview — its agent retrieves them at file granularity; nimbus-001 rejects them (400).

Minimum string length: 1

Example:

"nimbus-001"

input · string object[] · required

The input for the response. Can be a simple string or an array of messages.

instructions · string

System instructions to guide the model's behavior (maps to developer/system message)

temperature · number

Sampling temperature for the model. Defaults to 0.7 for nimbus-001 and 1 for nimbus-002-preview.

Required range: 0 <= x <= 2

knowledge_base · object

Knowledge base configuration. Required for nimbus-001 and nimbus-002-preview.

Option 1

Option 2

Option 3

Show child attributes

include · enum<string>[]

Additional data to include in the response annotations

Available options: cloudglue_citations.media_descriptions

tools · object[]

Tool definitions for function calling.

Show child attributes

max_output_tokens · integer

Maximum number of output tokens.

Required range: 1 <= x <= 128000

background · boolean

Set to true to process the response in the background. When true, the response is returned immediately with status 'in_progress'.

stream · boolean

Stream response via SSE. Mutually exclusive with background.

Response

200

application/json

Response created successfully

id · string<uuid>

Unique identifier for the response

object · enum<string>

Object type identifier

Available options: response

status · enum<string>

Current status of the response

Available options: in_progress, completed, failed, cancelled

created_at · integer

Unix timestamp of when the response was created

model · string

The model used for the response

instructions · string | null

The system instructions used

output · object[] | null

The generated output messages

Show child attributes

usage · object | null

Token usage statistics for the response

Show child attributes

error · object | null

Error details when the response status is 'failed'

Show child attributes