Guarded Responses

POST

guarded

responses

Responses API V2 (guarded)

curl --request POST \
  --url https://platform.ai.gloo.com/ai/v2/guarded/responses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "input": "<string>",
  "instructions": "<string>",
  "max_output_tokens": 123,
  "temperature": 123,
  "top_p": 123,
  "frequency_penalty": 123,
  "presence_penalty": 123,
  "stop": null,
  "tools": [
    {}
  ],
  "tool_choice": null,
  "stream": false,
  "reasoning": {},
  "response_format": {},
  "text": {},
  "parallel_tool_calls": true,
  "prompt_cache_key": "<string>",
  "image_generation": {},
  "tradition": "<string>"
}
'

import requests

url = "https://platform.ai.gloo.com/ai/v2/guarded/responses"

payload = {
    "model": "<string>",
    "input": "<string>",
    "instructions": "<string>",
    "max_output_tokens": 123,
    "temperature": 123,
    "top_p": 123,
    "frequency_penalty": 123,
    "presence_penalty": 123,
    "stop": None,
    "tools": [{}],
    "tool_choice": None,
    "stream": False,
    "reasoning": {},
    "response_format": {},
    "text": {},
    "parallel_tool_calls": True,
    "prompt_cache_key": "<string>",
    "image_generation": {},
    "tradition": "<string>"
}
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: '<string>',
    input: '<string>',
    instructions: '<string>',
    max_output_tokens: 123,
    temperature: 123,
    top_p: 123,
    frequency_penalty: 123,
    presence_penalty: 123,
    stop: null,
    tools: [{}],
    tool_choice: null,
    stream: false,
    reasoning: {},
    response_format: {},
    text: {},
    parallel_tool_calls: true,
    prompt_cache_key: '<string>',
    image_generation: {},
    tradition: '<string>'
  })
};

fetch('https://platform.ai.gloo.com/ai/v2/guarded/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://platform.ai.gloo.com/ai/v2/guarded/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' => '<string>',
    'input' => '<string>',
    'instructions' => '<string>',
    'max_output_tokens' => 123,
    'temperature' => 123,
    'top_p' => 123,
    'frequency_penalty' => 123,
    'presence_penalty' => 123,
    'stop' => null,
    'tools' => [
        [
                
        ]
    ],
    'tool_choice' => null,
    'stream' => false,
    'reasoning' => [
        
    ],
    'response_format' => [
        
    ],
    'text' => [
        
    ],
    'parallel_tool_calls' => true,
    'prompt_cache_key' => '<string>',
    'image_generation' => [
        
    ],
    'tradition' => '<string>'
  ]),
  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://platform.ai.gloo.com/ai/v2/guarded/responses"

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"input\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_output_tokens\": 123,\n  \"temperature\": 123,\n  \"top_p\": 123,\n  \"frequency_penalty\": 123,\n  \"presence_penalty\": 123,\n  \"stop\": null,\n  \"tools\": [\n    {}\n  ],\n  \"tool_choice\": null,\n  \"stream\": false,\n  \"reasoning\": {},\n  \"response_format\": {},\n  \"text\": {},\n  \"parallel_tool_calls\": true,\n  \"prompt_cache_key\": \"<string>\",\n  \"image_generation\": {},\n  \"tradition\": \"<string>\"\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://platform.ai.gloo.com/ai/v2/guarded/responses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"<string>\",\n  \"input\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_output_tokens\": 123,\n  \"temperature\": 123,\n  \"top_p\": 123,\n  \"frequency_penalty\": 123,\n  \"presence_penalty\": 123,\n  \"stop\": null,\n  \"tools\": [\n    {}\n  ],\n  \"tool_choice\": null,\n  \"stream\": false,\n  \"reasoning\": {},\n  \"response_format\": {},\n  \"text\": {},\n  \"parallel_tool_calls\": true,\n  \"prompt_cache_key\": \"<string>\",\n  \"image_generation\": {},\n  \"tradition\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.ai.gloo.com/ai/v2/guarded/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\": \"<string>\",\n  \"input\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_output_tokens\": 123,\n  \"temperature\": 123,\n  \"top_p\": 123,\n  \"frequency_penalty\": 123,\n  \"presence_penalty\": 123,\n  \"stop\": null,\n  \"tools\": [\n    {}\n  ],\n  \"tool_choice\": null,\n  \"stream\": false,\n  \"reasoning\": {},\n  \"response_format\": {},\n  \"text\": {},\n  \"parallel_tool_calls\": true,\n  \"prompt_cache_key\": \"<string>\",\n  \"image_generation\": {},\n  \"tradition\": \"<string>\"\n}"

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

{
  "id": "resp_123",
  "object": "response",
  "created_at": 1716912000,
  "model": "gloo-openai-gpt-5.5",
  "status": "completed",
  "output": [
    {
      "type": "reasoning",
      "id": "rs_123",
      "summary": [
        {
          "type": "summary_text",
          "text": "The user is greeting me, so a short friendly reply fits."
        }
      ]
    },
    {
      "type": "message",
      "id": "msg_123",
      "role": "assistant",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "text": "Hello! How can I help?"
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 8,
    "output_tokens": 7,
    "total_tokens": 15
  },
  "reasoning": {
    "effort": "medium",
    "summary": "auto"
  }
}

Error Reference: Guarded Responses

Common errors: guardrail block, unsupported model, unsupported sampling parameter, context window exceeded, provider timeout, provider unavailable.

Authorizations

Authorization

string

header

default:<api-key>

required

Bearer authentication header of the form Bearer <api-key>, where <api-key> is your API key.

Headers

X-Cache-TTL

string | null

Body

application/json

Responses API request for the guarded v2 endpoint. model is required (pinned-model routing only — no model_family/auto_routing on this shape).

model

string

required

input

required

String prompt or array of input items

instructions

string | null

max_output_tokens

integer | null

temperature

number | null

top_p

number | null

frequency_penalty

number | null

presence_penalty

number | null

stop

unknown

tools

Tools · object[] | null

tool_choice

unknown

stream

boolean

default:false

reasoning

Reasoning Config · object | null

Reasoning controls for a Responses request. On the Responses endpoints, a summary comes back only when summary is set. See the Reasoning guide (/api-guides/reasoning).

Show child attributes

response_format

Response Format · object | null

text

Text · object | null

Text options, as on OpenAI's Responses API. text.format requests structured output — {"type": "json_schema", "name": ..., "schema": {...}, "strict": true}, {"type": "json_object"}, or {"type": "text"}. If response_format is also supplied it takes precedence. Other keys, such as verbosity, are accepted and ignored.

parallel_tool_calls

boolean | null

prompt_cache_key

string | null

image_generation

Image Generation · object | null

Image generation options (quality, size) mapped onto OpenAI's image_generation tool; ignored by providers without quality controls.

tradition

string | null

Optional tradition for guardrail static responses and personalization (catholic, evangelical, mainline, not_faith_specific). Invalid values are ignored gracefully.

Response

Successful Responses API result. If stream is false or omitted, the response is JSON. If stream=true, the response is a named Server-Sent Events stream.

A non-streaming Responses API result.

string

required

object

string

default:response

required

Allowed value: "response"

created_at

integer

required

Unix timestamp when the response was created.

model

string

required

status

enum<string>

required

Available options:

completed,

failed,

in_progress,

incomplete

output

(Message · object | Image Generation · object | Function Call · object | Reasoning · object)[]

required

Items generated by the model, such as assistant messages, images, function calls, or reasoning summaries.

An assistant message produced by the model.

Message
Image Generation
Function Call
Reasoning

Show child attributes

usage

Usage · object

Token usage for the response.

Show child attributes

instructions

string

max_output_tokens

integer

metadata

object

Show child attributes

parallel_tool_calls

boolean

prompt_cache_key

string

reasoning

object

temperature

number

text

object

tool_choice

any

tools

object[]

top_p

number

ignored_params

Ignored Parameters · object

Parameters that were ignored or not applied as sent. The request still succeeds. Entries are name=value: sampling parameters the selected model does not accept and, on Direct Responses, reasoning removed from input (input.reasoning=<n> reasoning items, input.reasoning_paired=<n> other items removed with them) and stateful parameters that have no effect (previous_response_id, conversation, store=True, background=True). On a stream, the parameter names are in the X-Ignored-Params header instead.

Show child attributes

Example:

{
  "params": ["input.reasoning=1"],
  "model": "gloo-openai-gpt-5.4-nano",
  "reason": "These parameters were ignored and did not affect the response: the model does not accept them, or this surface does not forward them to the provider."
}

reasoning_carryover

Reasoning Carry-over Report · object

What happened to the reasoning items in the request's input. Present only when input contained at least one reasoning item, or the request asked for include: ["reasoning.encrypted_content"]; otherwise absent. Gloo does not carry reasoning from one request to the next: reasoning state sent back in input is removed before any model is called, and the request still succeeds. Returned by the guarded Responses and Grounded Responses endpoints. On a stream, the counts are in the X-Gloo-Reasoning-Carryover header and this object is a top-level field of the final response.completed or response.incomplete event's data; a stream that fails before either event ends without it. Direct Responses does not return this object or the header: it reports removed reasoning as input.reasoning=<n> and input.reasoning_paired=<n> in ignored_params (X-Ignored-Params on a stream).

Show child attributes

Example:

{
  "received": 1,
  "carried": 0,
  "dropped": [
    {
      "id": "rs_123",
      "reason": "not_gloo_state"
    }
  ],
  "not_sealed": null,
  "paired_removed": 1
}

⌘I

Responses API V2 (guarded)

curl --request POST \
  --url https://platform.ai.gloo.com/ai/v2/guarded/responses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "input": "<string>",
  "instructions": "<string>",
  "max_output_tokens": 123,
  "temperature": 123,
  "top_p": 123,
  "frequency_penalty": 123,
  "presence_penalty": 123,
  "stop": null,
  "tools": [
    {}
  ],
  "tool_choice": null,
  "stream": false,
  "reasoning": {},
  "response_format": {},
  "text": {},
  "parallel_tool_calls": true,
  "prompt_cache_key": "<string>",
  "image_generation": {},
  "tradition": "<string>"
}
'

import requests

url = "https://platform.ai.gloo.com/ai/v2/guarded/responses"

payload = {
    "model": "<string>",
    "input": "<string>",
    "instructions": "<string>",
    "max_output_tokens": 123,
    "temperature": 123,
    "top_p": 123,
    "frequency_penalty": 123,
    "presence_penalty": 123,
    "stop": None,
    "tools": [{}],
    "tool_choice": None,
    "stream": False,
    "reasoning": {},
    "response_format": {},
    "text": {},
    "parallel_tool_calls": True,
    "prompt_cache_key": "<string>",
    "image_generation": {},
    "tradition": "<string>"
}
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: '<string>',
    input: '<string>',
    instructions: '<string>',
    max_output_tokens: 123,
    temperature: 123,
    top_p: 123,
    frequency_penalty: 123,
    presence_penalty: 123,
    stop: null,
    tools: [{}],
    tool_choice: null,
    stream: false,
    reasoning: {},
    response_format: {},
    text: {},
    parallel_tool_calls: true,
    prompt_cache_key: '<string>',
    image_generation: {},
    tradition: '<string>'
  })
};

fetch('https://platform.ai.gloo.com/ai/v2/guarded/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://platform.ai.gloo.com/ai/v2/guarded/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' => '<string>',
    'input' => '<string>',
    'instructions' => '<string>',
    'max_output_tokens' => 123,
    'temperature' => 123,
    'top_p' => 123,
    'frequency_penalty' => 123,
    'presence_penalty' => 123,
    'stop' => null,
    'tools' => [
        [
                
        ]
    ],
    'tool_choice' => null,
    'stream' => false,
    'reasoning' => [
        
    ],
    'response_format' => [
        
    ],
    'text' => [
        
    ],
    'parallel_tool_calls' => true,
    'prompt_cache_key' => '<string>',
    'image_generation' => [
        
    ],
    'tradition' => '<string>'
  ]),
  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://platform.ai.gloo.com/ai/v2/guarded/responses"

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"input\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_output_tokens\": 123,\n  \"temperature\": 123,\n  \"top_p\": 123,\n  \"frequency_penalty\": 123,\n  \"presence_penalty\": 123,\n  \"stop\": null,\n  \"tools\": [\n    {}\n  ],\n  \"tool_choice\": null,\n  \"stream\": false,\n  \"reasoning\": {},\n  \"response_format\": {},\n  \"text\": {},\n  \"parallel_tool_calls\": true,\n  \"prompt_cache_key\": \"<string>\",\n  \"image_generation\": {},\n  \"tradition\": \"<string>\"\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://platform.ai.gloo.com/ai/v2/guarded/responses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"<string>\",\n  \"input\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_output_tokens\": 123,\n  \"temperature\": 123,\n  \"top_p\": 123,\n  \"frequency_penalty\": 123,\n  \"presence_penalty\": 123,\n  \"stop\": null,\n  \"tools\": [\n    {}\n  ],\n  \"tool_choice\": null,\n  \"stream\": false,\n  \"reasoning\": {},\n  \"response_format\": {},\n  \"text\": {},\n  \"parallel_tool_calls\": true,\n  \"prompt_cache_key\": \"<string>\",\n  \"image_generation\": {},\n  \"tradition\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.ai.gloo.com/ai/v2/guarded/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\": \"<string>\",\n  \"input\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_output_tokens\": 123,\n  \"temperature\": 123,\n  \"top_p\": 123,\n  \"frequency_penalty\": 123,\n  \"presence_penalty\": 123,\n  \"stop\": null,\n  \"tools\": [\n    {}\n  ],\n  \"tool_choice\": null,\n  \"stream\": false,\n  \"reasoning\": {},\n  \"response_format\": {},\n  \"text\": {},\n  \"parallel_tool_calls\": true,\n  \"prompt_cache_key\": \"<string>\",\n  \"image_generation\": {},\n  \"tradition\": \"<string>\"\n}"

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

{
  "id": "resp_123",
  "object": "response",
  "created_at": 1716912000,
  "model": "gloo-openai-gpt-5.5",
  "status": "completed",
  "output": [
    {
      "type": "reasoning",
      "id": "rs_123",
      "summary": [
        {
          "type": "summary_text",
          "text": "The user is greeting me, so a short friendly reply fits."
        }
      ]
    },
    {
      "type": "message",
      "id": "msg_123",
      "role": "assistant",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "text": "Hello! How can I help?"
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 8,
    "output_tokens": 7,
    "total_tokens": 15
  },
  "reasoning": {
    "effort": "medium",
    "summary": "auto"
  }
}

General

Models

Responses & Completions

Embeddings

Content

Data Engine Content Controls

Legacy / Deprecated APIs

Guarded Responses

Error Reference: Guarded Responses

Authorizations

Headers

Body

Response