GRgrayswan

Cygnal Completions

Changed on

Create OpenAI-compatible chat completions with Cygnal protection.

Docs: Guide | API Reference

post/cygnal/chat/completions

Request

Request body

modelstring required
metadataobject nullable
frequency_penaltynumber nullable
logit_biasobject nullable
logprobsboolean nullable
top_logprobsinteger nullable
max_tokensinteger nullable
max_completion_tokensinteger nullable
modalitiesstring[] nullable
ninteger
predictionunknown
audiounknown
presence_penaltynumber nullable
response_formatunknown
seedinteger nullable
service_tierstring nullable
storeboolean nullable
streamboolean nullable
stream_optionsunknown
temperaturenumber nullable
top_pnumber nullable
parallel_tool_callsboolean nullable
userstring nullable
monitor_detailsboolean nullable
policy_idstring nullable
moderate_beforeboolean nullable

Response

Successful Response

idstring required
createdinteger required
modelstring required
object'chat.completion' required
system_fingerprintstring nullable

Example response

{
  "choices": [
    {
      "finish_reason": "stop",
      "index": 0,
      "message": {
        "content": "Sure, just let me know what you'd like me to help with!",
        "role": "assistant"
      }
    }
  ],
  "created": 1987654321,
  "id": "1234567890",
  "model": "gpt-4o",
  "object": "chat.completion",
  "system_fingerprint": "v-0.2"
}

Changes