Skip to main content
This page summarizes common request parameters for Moxus AI. Whether a parameter takes effect depends on the protocol, selected model, and upstream provider. Unknown or unsupported fields may be ignored by the provider or rejected with a parameter error.
Do not mix request bodies across protocols. OpenAI-compatible APIs use https://moxus.ai/v1, Anthropic-compatible APIs use https://moxus.ai, and Google-compatible APIs use https://moxus.ai/v1beta.

Common fields

ParameterTypeRequiredDefaultRange / exampleMeaning
modelstringYesNonegpt-4o, claude-3-5-sonnet, gemini-2.5-proModel name. Copy the exact name from Model Square.
messagesarrayRequired for chat / ClaudeNone[{"role":"user","content":"..."}]Conversation messages. OpenAI and Anthropic message shapes differ.
inputstring / array / objectCommon for Responses / embeddingsNoneText, arrays, multimodal inputMain input field for Responses, embeddings, and some models.
promptstring / arraySome completion or image APIsNone"Draw a cat"Single prompt or image generation prompt.
streambooleanNofalsetrue / falseReturn streaming responses.
metadataobjectNoNone{"trace_id":"abc"}Custom metadata for business tracing. Do not put secrets here.
userstring / objectNoNone"user_123"Client-side user identifier. Some providers support it; others ignore it.

Sampling and length

ParameterTypeDefaultRange / exampleMeaning
temperaturenumberModel defaultUsually 0 to 2Controls randomness. Lower is more stable; higher is more diverse.
top_pnumberModel defaultUsually 0 to 1Nucleus sampling threshold. Avoid changing both temperature and top_p aggressively.
top_kinteger / numberModel defaultPositive number, provider-specificLimits candidate tokens. Common in Anthropic and Google; not always supported by OpenAI models.
max_tokensintegerModel defaultNon-negative integer within model/platform limitsMaximum output tokens for Chat Completions and Anthropic-style calls.
max_completion_tokensintegerModel defaultNon-negative integer within model/platform limitsOutput cap for some newer OpenAI models.
max_output_tokensintegerModel defaultNon-negative integer within model/platform limitsOutput cap for Responses API and Google-native calls.
stopstring / arrayNone"\n" or ["END"]OpenAI-compatible stop sequence.
stop_sequencesarrayNone["END"]Anthropic / Google native stop sequences.
ninteger1Usually positive integerNumber of candidates. More candidates usually cost more.
seednumber / integerNone0 or another integerAttempts deterministic output. Reproducibility depends on model and provider.

OpenAI Chat Completions parameters

ParameterTypeDefaultRange / exampleMeaning
messagesarrayNonesystem / user / assistant / toolConversation messages.
response_formatobjectNone{"type":"json_object"}, {"type":"json_schema",...}Ask the model to return JSON or schema-constrained output.
toolsarrayNone[{"type":"function","function":{...}}]Declares tools the model may call.
tool_choicestring / objectautoauto, none, or a specific functionControls whether or which tool is called.
parallel_tool_callsbooleanModel defaulttrue / falseAllows multiple tool calls in one response.
logprobsbooleanfalsetrue / falseReturns token log probabilities if supported.
top_logprobsintegerNoneUsually 0 to 20Number of candidate token logprobs per position.
frequency_penaltynumber0Usually -2 to 2Penalizes repeated token frequency.
presence_penaltynumber0Usually -2 to 2Encourages new topics when positive.
logit_biasobjectNone{ "123": -100 }Adjusts likelihood for token IDs.
modalitiesarrayModel default["text"], ["text","audio"]Output modalities, depending on model support.
audioobjectNone{"voice":"alloy","format":"mp3"}Audio output configuration.

OpenAI Responses parameters

ParameterTypeDefaultRange / exampleMeaning
inputstring / arrayNoneText or multimodal input arrayMain Responses API input.
instructionsstringNone"You are helpful"Global instructions, similar to a system prompt.
previous_response_idstringNoneresp_...Continue from a previous Responses call.
max_output_tokensintegerModel defaultNon-negative integerMaximum output tokens.
reasoningobjectModel default{"effort":"medium"}Reasoning configuration for reasoning models.
textobjectModel default{"format":{...}}Text output format configuration.
toolsarray / objectNoneWeb search, function, MCP, and moreResponses tool configuration.
tool_choicestring / objectautoauto, none, or a specific toolControls tool use.
truncationstringModel defaultauto, disabledBehavior when input is too long.
includearrayNone[...]Requests additional response fields.
storebooleanUpstream defaulttrue / falseWhether upstream may store output. Channel settings may control passthrough.

Anthropic-compatible parameters

ParameterTypeRequiredDefaultRange / exampleMeaning
modelstringYesNoneclaude-3-5-sonnetClaude or Anthropic-compatible model name.
messagesarrayYesNoneuser / assistant messagesClaude Messages content.
systemstring / arrayNoNone"You are helpful"System instruction.
max_tokensintegerCommonly requiredNoneNon-negative integerMaximum output tokens.
temperaturenumberModel defaultUsually 0 to 1Controls randomness. Some Claude models may reject non-default sampling parameters.
top_pnumberModel defaultUsually 0 to 1Nucleus sampling.
top_kintegerModel defaultPositive integerCandidate token limit.
stop_sequencesarrayNone["END"]Stop sequences.
streambooleanfalsetrue / falseReturn streaming response.
toolsarrayNoneTool declarationsDeclares Claude tools.
tool_choiceobjectauto{"type":"auto"}, {"type":"tool","name":"..."}Controls tool selection.
thinkingobjectModel default{"type":"enabled","budget_tokens":1024}Claude thinking configuration, depending on model support.
metadataobjectNone{"user_id":"..."}Business metadata. Avoid sensitive data.

Google-compatible parameters

Google-native APIs usually put generation parameters in generationConfig. Moxus AI also accepts some snake_case fields, such as top_p and max_output_tokens.
ParameterTypeDefaultRange / exampleMeaning
contentsarray / stringNoneText or multimodal partsMain Google-native input.
systemInstructionobject / stringNoneSystem instructionGoogle-native system instruction.
toolsarray / objectNonefunctionDeclarations, googleSearch, etc.Tool or search declarations.
generationConfig.temperaturenumberModel defaultUsually 0 to 2Controls randomness.
generationConfig.topP / top_pnumberModel defaultUsually 0 to 1Nucleus sampling.
generationConfig.topK / top_knumberModel defaultPositive numberCandidate token limit.
generationConfig.maxOutputTokens / max_output_tokensintegerModel defaultNon-negative integerOutput token cap.
generationConfig.candidateCountinteger1Positive integerNumber of candidates.
generationConfig.stopSequencesarrayNone["END"]Stop sequences.
generationConfig.responseMimeTypestringNoneapplication/json, text/plainResponse MIME type.
generationConfig.responseSchemaobjectNoneJSON SchemaStructured output schema.
generationConfig.presencePenaltynumber0Provider-specificTopic repetition penalty.
generationConfig.frequencyPenaltynumber0Provider-specificToken frequency penalty.
generationConfig.seedintegerNoneIntegerRandom seed.
generationConfig.thinkingConfigobjectModel default{"thinkingBudget":1024}Thinking budget or toggle.
generationConfig.responseModalitiesarrayModel default["TEXT"], ["TEXT","IMAGE"]Output modalities, depending on model support.

Image generation parameters

ParameterTypeDefaultRange / exampleMeaning
modelstringNoneImage model nameImage generation model.
promptstringNone"A product poster"Image generation prompt.
ninteger11 to 128Number of images. More images cost more.
sizestringModel default1024x1024, 1024x1792Output size. Allowed values depend on model.
qualitystringautoauto, standard, hd, etc.Image quality tier, model-dependent.
response_formatstringModel defaulturl, b64_jsonImage response format.
backgroundstring / objectModel defaulttransparent, opaqueBackground configuration.
output_formatstringModel defaultpng, jpeg, webpOutput image format.
output_compressionintegerModel default0 to 100Compression quality, supported by some formats.
streambooleanfalsetrue / falseStream progress or partial images where supported.
metadata / extra fieldsobjectNoneProvider-specificVendor-specific passthrough parameters.

Embedding and rerank parameters

ParameterTypeDefaultRange / exampleMeaning
inputstring / arrayNoneText or text arrayText to embed.
modelstringNoneEmbedding model nameEmbedding model.
encoding_formatstringfloatfloat, base64Vector encoding format.
dimensionsintegerModel defaultPositive integerOutput vector dimensions, if supported.
querystringNoneQuery textQuery for reranking.
documentsarrayNoneCandidate documentsDocuments to rerank. Field names may vary by model or provider.

Audio parameters

ParameterTypeDefaultRange / exampleMeaning
modelstringNoneAudio model nameSpeech model to call.
inputstringNoneText to speak or processTTS or audio task input.
voicestringModel defaultalloy, nova, etc.Voice name, depending on model support.
instructionsstringNoneStyle or tone instructionsSpeech generation guidance.
response_formatstringModel defaultmp3, wav, json, etc.Response format.
speednumber1Usually 0.25 to 4Speech speed, depending on model support.
stream_formatstringNonesseStreaming audio format.
metadataobjectNoneCustom business fieldsBusiness tracing or vendor extensions.
ParameterTypeDefaultPlatform behaviorMeaning
storebooleanUpstream defaultPassed through by default; can be disabled by channel settingsControls whether upstream may store request or output.
safety_identifierstringNoneFiltered by default unless a channel explicitly allows itUpstream safety identifier. Use carefully because it may identify users.
stream_options.include_obfuscationbooleanUpstream defaultFiltered by default unless explicitly allowedControls streaming obfuscation behavior.
metadataobjectNoneMay be logged or passed throughCustom metadata. Do not put API keys, passwords, or personal sensitive data here.

Recommendations

  • For a first call, send only model plus messages or input.
  • If you are unsure, adjust only one sampling parameter first, usually temperature.
  • Set max_tokens or max_output_tokens when cost or response length matters.
  • For tool calling, start with a simple schema before adding complex fields.
  • Do not put API keys, database URLs, identity numbers, or other sensitive data in metadata or prompts.