Cygnal Responses

Process and monitor OpenAI-compatible response requests.

This endpoint processes completion requests with monitoring capabilities, similar to the chat completions endpoint.

Docs: Guide | API Reference

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

background?Background

Defaultfalse

conversation?string||null

include?array<unknown>|null

input?string|array<unknown>|null

instructions?string|null

max_output_tokens?integer|null

max_tool_calls?integer|null

metadata?|null

model?string|null

parallel_tool_calls?|

Defaulttrue

previous_response?string|null

prompt?|null

prompt_cache_key?string|null

reasoning?|null

safety_identifier?string|null

service_tier?|null

store?|

Defaulttrue

stream?|

Defaultfalse

stream_options?unknown|null

temperature?|

Default1

text?unknown|null

tool_choice?|

Default"auto"

tools?array<unknown>|null

top_logprobs?integer|null

top_p?|

Default1

truncation?|

Default"disabled"

user?string|null

monitor_details?boolean|null

policy_id?|

Policy ID to apply to the request. Required unless a policy ID header is provided or an agent supplies an associated policy. Cygnal does not apply a default policy.

Response Body

`application/json`

curl -X POST "https://example.com/cygnal/responses" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "object": "string",  "model": "string",  "output": [    "string"  ],  "choices": [    {      "index": 0,      "finish_reason": "string",      "message": {        "role": "string",        "content": "string"      }    }  ],  "usage": {    "prompt_tokens": 0,    "completion_tokens": 0,    "total_tokens": 0,    "input_tokens": 0,    "output_tokens": 0  },  "error": {    "message": "string",    "type": "string",    "code": "string",    "param": "string"  }}

Request Body

Response Body

200application/json

400application/json

401application/json

422application/json

500application/json

502application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`