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

backgroundboolean

context_managementobject[] nullable

instructionsstring nullable

max_output_tokensinteger nullable

max_tool_callsinteger nullable

metadataobject nullable

modelstring nullable

moderationobject nullable

parallel_tool_callsboolean nullable

previous_response_idstring nullable

prompt_cache_keystring nullable

prompt_cache_optionsobject nullable

prompt_cache_retention'in_memory' | 'in-memory' | '24h' nullable

reasoningobject nullable

safety_identifierstring nullable

service_tier'auto' | 'default' | 'flex' | 'scale' | 'priority' nullable

storeboolean nullable

streamboolean nullable

{"stackTrail":"components:schemas:CreateResponseRequest:properties:stream_options:anyOf","oasType":"schema","type":"unknown","title":"Stream Options","nullable":true}

temperaturenumber nullable

{"stackTrail":"components:schemas:CreateResponseRequest:properties:text:anyOf","oasType":"schema","type":"unknown","title":"Text","nullable":true}

top_logprobsinteger nullable

top_pnumber nullable

truncation'auto' | 'disabled' nullable

userstring nullable

monitor_detailsboolean nullable

policy_idstring nullable

Response

Successful Response

idstring nullable

objectstring nullable

modelstring nullable

Changes

No recorded changes to this endpoint across all 3 revisions of this API.