Skip to main content
POST
/
responses
Create a response
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",
    "type": "general_question_answering",
    "filter": {
      "metadata": [
        {
          "path": "<string>",
          "operator": "NotEqual",
          "valueText": "<string>",
          "valueTextArray": [
            "<string>"
          ],
          "scope": "file"
        }
      ],
      "video_info": [
        {
          "path": "duration_seconds",
          "operator": "NotEqual",
          "valueText": "<string>",
          "valueTextArray": [
            "<string>"
          ],
          "scope": "file"
        }
      ],
      "file": [
        {
          "path": "bytes",
          "operator": "NotEqual",
          "valueText": "<string>",
          "valueTextArray": [
            "<string>"
          ]
        }
      ]
    },
    "entity_backed_knowledge_config": {
      "entity_collections": [
        {
          "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "description": "<string>"
    }
  },
  "include": [
    "cloudglue_citations.media_descriptions"
  ],
  "tools": [
    {
      "type": "function",
      "name": "<string>",
      "parameters": {},
      "description": "<string>",
      "strict": true
    }
  ],
  "max_output_tokens": 64000,
  "background": true,
  "stream": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "response",
  "status": "in_progress",
  "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>"
  }
}

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.
Minimum string length: 1
Example:

"nimbus-001"

​
input
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.

​
include
enum<string>[]

Additional data to include in the response annotations

Available options:
cloudglue_citations.media_descriptions
​
tools
object[]

Tool definitions for function calling.

​
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

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

​
usage
object

Token usage statistics for the response

​
error
object

Error details when the response status is 'failed'