Cygnal

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

POST
/cygnal/responses

Request Body

application/json

background?boolean
Defaultfalse
conversation?||
include?array<>|
input?|array<>|
instructions?|
max_output_tokens?|
max_tool_calls?|
metadata?|
model?|
parallel_tool_calls?|
Defaulttrue
previous_response?|
prompt?|
prompt_cache_key?|
reasoning?|
safety_identifier?|
service_tier?|
store?|
Defaulttrue
stream?|
Defaultfalse
stream_options?|
temperature?|
Default1
text?|
tool_choice?|
Default"auto"
tools?array<>|
top_logprobs?|
top_p?|
Default1
truncation?|
Default"disabled"
user?|
monitor_details?|
policy_id?|

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.grayswan.ai/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"
  }
}
{
  "error": true,
  "message": "string",
  "detail": "string",
  "error_code": "string",
  "details": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "error": true,
  "message": "string",
  "detail": "string",
  "error_code": "string",
  "details": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "error": true,
  "message": "string",
  "detail": "string",
  "error_code": "string",
  "details": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "error": true,
  "message": "string",
  "detail": "string",
  "error_code": "string",
  "details": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "error": true,
  "message": "string",
  "detail": "string",
  "error_code": "string",
  "details": {
    "property1": "string",
    "property2": "string"
  }
}