Completions

Chat Completions

post/v1/chat/completions

Request

  • Base URL: https://api.ambient.xyz (the document declares no server; this is the origin it was published from)
  • URL: https://api.ambient.xyz/v1/chat/completions
  • Auth: none declared

Headers

public-keystring nullable

Public key for encryption. Only supported with streaming right now.

ivstring nullable

Initialization vector for encryption. Only supported with streaming right now.

Request body

thinking_budgetinteger nullable

WARNING. DEPRECATED. Use reasoning configuration instead.

emit_usageboolean

Whether to return usage information

emit_verifiedboolean

Whether to return verification status

emit_ambient_eventsboolean

Whether to return lifecycle events

wait_for_verificationboolean nullable

Whether to wait for verification to complete before completing the request

enabled_toolsstring[] nullable

List of enabled tools. Supported tools: ['*', 'websearch', 'retrieval', 'crypto_price', 'stock_price', 'weather', 'currency_convert', 'calculator']. Use [*] to enable all tools.

force_auction_v2boolean

Force routing via the NATS-based auction v2 request router, bypassing rollout sampling.

modelstring nullable
frequency_penaltynumber nullable
include_reasoningboolean nullable
logit_biasobject nullable
logprobsboolean nullable
max_tokensinteger nullable

Maximum number of tokens to generate

max_completion_tokensinteger nullable

Maximum number of tokens to generate

min_pnumber nullable
presence_penaltynumber nullable
repetition_penaltynumber nullable
seedinteger nullable
temperaturenumber nullable

Sampling temperature

top_kinteger nullable
top_logprobsinteger nullable
top_pnumber nullable
streamboolean

Example request

{
  "thinking_budget": 1000,
  "reasoning": {
    "effort": "medium",
    "max_tokens": 1000,
    "enabled": true
  },
  "enabled_tools": [
    "*",
    "websearch",
    "retrieval"
  ],
  "messages": [
    {
      "content": "Hello!",
      "role": "user"
    }
  ],
  "max_tokens": 5000,
  "max_completion_tokens": 5000,
  "temperature": 0.7
}

Response

Successful Response

idstring required
createdinteger required
modelstring required
object'chat.completion' required
service_tier'auto' | 'default' | 'flex' | 'scale' | 'priority' nullable
system_fingerprintstring nullable
merkle_rootstring required
verifiedboolean nullable

Changes

No recorded changes to this operation across all 1 revision of this API.