Sign in

v1

latestOpenAPI 3.1.02026-08-04197263.3 KB

Cygnal Completions

Create OpenAI-compatible chat completions with Cygnal protection.

Docs: Guide | API Reference

post/cygnal/chat/completions

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
{"stackTrail":"components:schemas:CreateChatCompletionRequest:properties:prediction:anyOf","oasType":"schema","type":"unknown","title":"Prediction","nullable":true}
{"stackTrail":"components:schemas:CreateChatCompletionRequest:properties:audio:anyOf","oasType":"schema","type":"unknown","title":"Audio","nullable":true}
presence_penaltynumber nullable
{"stackTrail":"components:schemas:CreateChatCompletionRequest:properties:response_format:anyOf","oasType":"schema","type":"unknown","title":"Response Format","nullable":true}
seedinteger nullable
service_tierstring nullable
storeboolean nullable
streamboolean nullable
{"stackTrail":"components:schemas:CreateChatCompletionRequest:properties:stream_options:anyOf","oasType":"schema","type":"unknown","title":"Stream Options","nullable":true}
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"
}