Back to Documentation

Chat Models API Reference

This is the API reference for chat model endpoints. Additional non-chat API groups will be appended later.

Default Base URL: https://api.valueapi.ai/v1
Default Auth: Authorization: Bearer <API_KEY>
Note: Gemini native endpoint uses https://api.valueapi.ai/v1beta/models/....

Model Info (planned)Image (planned)Video (planned)Audio (planned)Music (planned)Realtime (planned)Tools (planned)
POST/v1/chat/completions

Chat API (General)

OpenAI-compatible general chat endpoint.

  • Works across OpenAI/Claude/Gemini style chat models.

Headers

  • Authorization: Bearer <API_KEY>
  • Content-Type: application/json

Full URL

https://api.valueapi.ai/v1/chat/completions

Body Parameters

NameTypeRequiredDescription
modelstringYesModel ID.
messagesarray<object>YesConversation history.
temperaturenumberNoSampling temperature.
top_pnumberNoNucleus sampling control.
max_tokensnumberNoMaximum output tokens.
streambooleanNoSSE streaming switch.
response_formatobjectNoStructured output options.
stopstring | string[]NoStop sequences.
userstringNoEnd-user identifier.

Body demo

{
  "model": "gpt-4o",
  "messages": [
    {
      "role": "user",
      "content": "Hello"
    }
  ],
  "temperature": 0.7,
  "max_tokens": 512,
  "stream": false
}
POST/v1/chat/completions

Chat API (Image Analysis)

Multimodal chat with text + image blocks.

Headers

  • Authorization: Bearer <API_KEY>
  • Content-Type: application/json

Full URL

https://api.valueapi.ai/v1/chat/completions

Body Parameters

NameTypeRequiredDescription
modelstringYesVision-capable model.
messagesarray<object>YesMessage list.
messages[].content[]array<object>YesMixed blocks.
messages[].content[].typestringYestext | image_url.
messages[].content[].textstringNoText prompt.
messages[].content[].image_url.urlstringNoImage URL or base64 data URL.
max_tokensnumberNoMaximum output tokens.

Body demo

{
  "model": "gpt-4o",
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "Describe this image"
        },
        {
          "type": "image_url",
          "image_url": {
            "url": "https://example.com/images/demo.jpg"
          }
        }
      ]
    }
  ],
  "max_tokens": 512
}
POST/v1/chat/completions

Chat API (Function Calling)

OpenAI-style tools/function calling.

Headers

  • Authorization: Bearer <API_KEY>
  • Content-Type: application/json

Full URL

https://api.valueapi.ai/v1/chat/completions

Body Parameters

NameTypeRequiredDescription
modelstringYesModel ID.
messagesarray<object>YesConversation messages.
toolsarray<object>YesTool definitions list.
tools[].typestringYesMust be function.
tools[].function.namestringYesFunction name.
tools[].function.parametersobjectYesJSON schema for arguments.
tools[].function.strictbooleanNoStrict schema mode.

Body demo

{
  "model": "gpt-4o",
  "messages": [
    {
      "role": "user",
      "content": "What's weather in Paris?"
    }
  ],
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "get_weather",
        "description": "Get current weather by location",
        "parameters": {
          "type": "object",
          "properties": {
            "location": {
              "type": "string"
            }
          },
          "required": ["location"]
        }
      }
    }
  ],
  "tool_choice": "auto"
}
POST/v1/chat/completions

Chat API (o1-o3 Models)

Special request shape for o1/o3 style models.

  • Source note: o1 stream is currently unsupported.

Headers

  • Authorization: Bearer <API_KEY>
  • Content-Type: application/json

Full URL

https://api.valueapi.ai/v1/chat/completions

Body Parameters

NameTypeRequiredDescription
modelstringYesExample: o1-mini.
messagesarray<object>YesConversation messages.
max_completion_tokensnumberNoMax generated tokens.
streambooleanNoUse false.

Body demo

{
  "model": "o1-mini",
  "messages": [
    {
      "role": "user",
      "content": "Explain this code"
    }
  ],
  "max_completion_tokens": 1024,
  "stream": false
}
POST/v1/chat/completions

gpt-4o-all File Analysis

Model alias for image/file/web-capable use cases.

Headers

  • Authorization: Bearer <API_KEY>
  • Content-Type: application/json

Full URL

https://api.valueapi.ai/v1/chat/completions

Body Parameters

NameTypeRequiredDescription
modelstringYesUse gpt-4o-all.
messagesarray<object>YesConversation messages.
messages[].contentstringYesSupports file_url + space + question.
max_tokensnumberNoMaximum output tokens.
temperaturenumberNoSampling temperature.

Body demo

{
  "model": "gpt-4o-all",
  "messages": [
    {
      "role": "user",
      "content": "https://example.com/files/api-doc.pdf Summarize this file"
    }
  ],
  "max_tokens": 1024,
  "temperature": 0.2
}
POST/v1/chat/completions

gpt-4-all File Analysis

GPT-4 based alias with file-analysis style input.

Headers

  • Authorization: Bearer <API_KEY>
  • Content-Type: application/json

Full URL

https://api.valueapi.ai/v1/chat/completions

Body Parameters

NameTypeRequiredDescription
modelstringYesUse gpt-4-all.
messagesarray<object>YesConversation messages.
messages[].contentstringYesSupports file_url + space + question.
max_tokensnumberNoMaximum output tokens.
temperaturenumberNoSampling temperature.

Body demo

{
  "model": "gpt-4-all",
  "messages": [
    {
      "role": "user",
      "content": "https://example.com/files/api-doc.pdf Summarize this file"
    }
  ],
  "max_tokens": 1024,
  "temperature": 0.2
}
POST/v1/completions

Legacy Text Completions

Classic prompt-completion endpoint.

Headers

  • Authorization: Bearer <API_KEY>
  • Content-Type: application/json

Full URL

https://api.valueapi.ai/v1/completions

Body Parameters

NameTypeRequiredDescription
modelstringYesExample: gpt-3.5-turbo-instruct.
promptstringYesInput prompt text.
max_tokensnumberNoMaximum output tokens.
temperaturenumberNoSampling temperature.
top_pnumberNoNucleus sampling control.
frequency_penaltynumberNoFrequency penalty.
presence_penaltynumberNoPresence penalty.
logprobsnumberNoTop token probabilities count.

Body demo

{
  "model": "gpt-3.5-turbo-instruct",
  "prompt": "The weather is good",
  "max_tokens": 100,
  "temperature": 0.7,
  "top_p": 1
}
POST/v1/chat/completions

Claude (OpenAI Format)

Claude via OpenAI-compatible payload, including PDF/image-style blocks.

  • Source note: use native format for prompt caching behavior.

Headers

  • Authorization: Bearer <API_KEY>
  • Content-Type: application/json

Full URL

https://api.valueapi.ai/v1/chat/completions

Body Parameters

NameTypeRequiredDescription
modelstringYesClaude model ID.
messagesarray<object>YesConversation messages.
messages[].content[]array<object>NoSupports text/file/file_url/image_url blocks.
max_tokensnumberNoMaximum output tokens.
streambooleanNoStreaming switch.
thinkingobjectNoThinking config for supported Claude models.

Body demo

{
  "model": "claude-3-5-sonnet-20241022",
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "Summarize this PDF"
        },
        {
          "type": "file_url",
          "file_url": {
            "url": "https://example.com/files/api-doc.pdf"
          }
        }
      ]
    }
  ],
  "max_tokens": 1024,
  "stream": false
}
POST/v1/messages

Claude (Native Format)

Claude native endpoint with native content blocks and cache controls.

Headers

  • Authorization: Bearer <API_KEY>
  • Content-Type: application/json

Full URL

https://api.valueapi.ai/v1/messages

Body Parameters

NameTypeRequiredDescription
modelstringYesNative-capable model ID.
messagesarray<object>YesConversation messages.
messages[].content[]array<object>Notext/image/document blocks.
messages[].content[].sourceobjectNobase64 or url source object.
messages[].content[].cache_controlobjectNoOptional cache config.
max_tokensnumberNoMaximum output tokens.
thinkingobjectNoThinking config on supported models.

Body demo

{
  "model": "claude-3-5-sonnet-20240620",
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "Summarize this PDF"
        },
        {
          "type": "document",
          "source": {
            "type": "url",
            "url": "https://example.com/files/api-doc.pdf"
          }
        }
      ]
    }
  ],
  "max_tokens": 1024
}
POST/v1/chat/completions

Gemini (OpenAI Format)

Gemini via OpenAI format with file analysis and search-style options.

Headers

  • Authorization: Bearer <API_KEY>
  • Content-Type: application/json

Full URL

https://api.valueapi.ai/v1/chat/completions

Body Parameters

NameTypeRequiredDescription
modelstringYesGemini model ID.
messagesarray<object>YesConversation messages.
messages[].content[]array<object>Notext/file/file_url/image_url blocks.
max_tokensnumberNoMaximum output tokens.
toolsarray<object>NoFunction tools (e.g. googleSearch).
reasoning_effortstringNolow | medium | high for compatible models.
extra_body.google.thinking_configobjectNoGemini thinking controls.

Body demo

{
  "model": "gemini-2.5-pro",
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "Summarize this"
        },
        {
          "type": "file",
          "file": {
            "filename": "api-doc.pdf",
            "file_data": "data:application/pdf;base64,JVBER..."
          }
        }
      ]
    }
  ],
  "reasoning_effort": "medium",
  "max_tokens": 1024
}
POST/v1beta/models/{model}:{action}

Gemini (Native Format)

Gemini native endpoint using generateContent / streamGenerateContent.

  • Source note: prefer lowerCamelCase field names.

Headers

  • Content-Type: application/json
  • x-goog-api-key: <API_KEY> (or Bearer auth)

Full URL

https://api.valueapi.ai/v1beta/models/{model}:{action}

Body Parameters

NameTypeRequiredDescription
contentsarray<object>YesConversation content list.
contents[].rolestringYesRole, e.g. user.
contents[].partsarray<object>YesParts array.
contents[].parts[].textstringYesText content.

Body demo

{
  "contents": [
    {
      "role": "user",
      "parts": [
        {
          "text": "Hello"
        }
      ]
    }
  ],
  "generationConfig": {
    "temperature": 0.7
  }
}
POST/v1/chat/completions

GPTs

Call GPTs by model naming pattern gpt-4-gizmo-(gizmo_id).

Headers

  • Authorization: Bearer <API_KEY>
  • Content-Type: application/json

Full URL

https://api.valueapi.ai/v1/chat/completions

Body Parameters

NameTypeRequiredDescription
modelstringYesFormat: gpt-4-gizmo-(id).
messagesarray<object>YesConversation messages.
max_tokensnumberNoMaximum output tokens.
temperaturenumberNoSampling temperature.
streambooleanNoStreaming switch.

Body demo

{
  "model": "gpt-4-gizmo-g-bo0FiWLY7",
  "messages": [
    {
      "role": "user",
      "content": "What is quantum computing potential?"
    }
  ],
  "max_tokens": 512,
  "stream": false
}