AimableDocs
DocsAPI Reference
POST/v1/chat/completions

Create Chat Completion

Headers

NameTypeRequiredDescription
X-Trace-IdstringOptional
X-Parent-Span-IdstringOptional
X-Request-TypestringOptional
X-NamestringOptional
X-Apply-Pii-PseudonymizationstringOptional
Default: false
X-Apply-Oii-PseudonymizationstringOptional
Default: true
X-Collection-IdsstringOptional
Default:
X-Pii-MappingstringOptional
X-Auto-Pii-MappingstringOptional
X-Pii-PositionsstringOptional
X-Uploaded-FilesstringOptional
Default:
X-Chat-History-Pii-MappingstringOptional
X-ModelstringOptional
X-Aimable-Space-IdstringOptional
X-Space-IdstringOptional
X-Model-Api-KeystringOptional
X-Model-Api-Base-UrlstringOptional
X-Collection-DescriptionsstringOptional
X-API-KeystringOptional

Request Body

application/jsonRequired
messagesobjectRequired
frequency_penaltyobject
logit_biasobject
logprobsobject
top_logprobsobject
max_tokensobject
nobject
response_formatobject
seedobject
stopobject
streamobject
temperatureobject
top_pobject
userobject
uploaded_filesobject
trusted_model_overrideobject
toolsobject
tool_choiceobject
chunksobject

Request

curl -X POST '/api-proxy/v1/chat/completions' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": {},
  "frequency_penalty": 0,
  "logit_bias": {},
  "logprobs": {},
  "top_logprobs": {},
  "max_tokens": {},
  "n": 1,
  "response_format": {},
  "seed": {},
  "stop": {},
  "stream": false,
  "temperature": 0.7,
  "top_p": {},
  "user": {},
  "uploaded_files": {},
  "trusted_model_override": {},
  "tools": {},
  "tool_choice": {},
  "chunks": {}
}'

Response

200

No response body documented

Error Responses