CLcloudglue
Response

Create a response

Changed on

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

Request

  • Base URL
    https://api.cloudglue.dev/v1
  • Auth
    HTTP bearer

Request body

modelstring 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') and entities collections (collection_type: 'entities') in the knowledge base are only supported by nimbus-002-preview — its agent picks the retrieval scope per search call (metadata docs and file-level entity docs at file granularity, segment-level entity docs at segment granularity); nimbus-001 rejects both (400).

instructionsstring

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

temperaturenumber

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

includestring[]

Additional data to include in the response annotations

max_output_tokensinteger

Maximum number of output tokens.

backgroundboolean

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

streamboolean

Stream response via SSE. Mutually exclusive with background.

Example request

{
  "model": "nimbus-001"
}

Response

Response created successfully

idstring uuid

Unique identifier for the response

object'response'

Object type identifier

status'in_progress' | 'completed' | 'failed' | 'cancelled'

Current status of the response

created_atinteger

Unix timestamp of when the response was created

modelstring

The model used for the response

instructionsstring nullable

The system instructions used

Changes

  • 23d3f240819fRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ba7a6332e97aRevision changes
    • info

      the request property ///// became optional