HyphenHyphen
HomeConsole
  • Get Started
  • Connect your coding agent
  • Build with Hyphen
  • Chat UIs & automation
  • Recipes
  • Guides
  • API Reference
Information
Chat
    Create a chat completionpost
Responses
    Create a model response (Responses API)post
Messages
    Create a message (Anthropic Messages API)post
Models
    List available modelsget
Schemas
powered by Zudoku
Hyphen Gateway API
Hyphen Gateway API

Schemas


Model

string · enum
Enum values:
minimax-m3
minimax-m2.7
minimax-m2.7-highspeed
minimax-m2.5
minimax-m2.5-highspeed
minimax-m2.1
minimax-m2.1-highspeed
minimax-m2

A model ID from the current catalog — real provider model names, all MiniMax. The core tiers are minimax-m3 (flagship), minimax-m2.7 (balanced daily driver) and minimax-m2.5 (fast); the -highspeed variants are latency-tuned versions of their standard siblings at roughly 2x the price; minimax-m2.1 and minimax-m2 are older M-series generations; minimax-m2-her is role-play/dialogue chat tuning; minimax-text-01 is the long-context text model. There are no invented aliases; any other ID returns an error. The catalog can change with notice.

ChatMessage

role
​string · enum · required

Who authored this message. system sets behavior, user asks, assistant answers (or requests tool calls), tool returns a tool result.

Enum values:
system
user
assistant
tool
content
​string | null

The message text. May be null on an assistant message that only carries tool_calls.

name
​string

Optional participant name to disambiguate same-role messages.

​ToolCall[]

Tool calls requested by the assistant (assistant messages only).

tool_call_id
​string

Required when role is tool — the id of the tool call this message responds to.

Tool

A function tool the model may call.
type
​string · enum · required

Only function tools are supported.

Enum values:
function
​object · required

ToolCall

A tool invocation requested by the model.
id
​string

Identifier to echo back in the tool role reply as tool_call_id.

type
​string · enum
Enum values:
function
​object

ChatCompletionRequest

model
​Model · enum · required

A model ID from the current catalog — real provider model names, all MiniMax. The core tiers are minimax-m3 (flagship), minimax-m2.7 (balanced daily driver) and minimax-m2.5 (fast); the -highspeed variants are latency-tuned versions of their standard siblings at roughly 2x the price; minimax-m2.1 and minimax-m2 are older M-series generations; minimax-m2-her is role-play/dialogue chat tuning; minimax-text-01 is the long-context text model. There are no invented aliases; any other ID returns an error. The catalog can change with notice.

Enum values:
minimax-m3
minimax-m2.7
minimax-m2.7-highspeed
minimax-m2.5
minimax-m2.5-highspeed
minimax-m2.1
minimax-m2.1-highspeed
minimax-m2
​ChatMessage[] · required

The conversation so far — an array of role/content messages, oldest first.

max_tokens
​integer · min: 1

Maximum number of tokens to generate in the completion.

temperature
​number · min: 0 · max: 2

Sampling temperature. Lower is more deterministic, higher is more creative. Alter this or top_p, not both.

Default: 1
top_p
​number · min: 0 · max: 1

Nucleus sampling — only tokens in the top top_p probability mass are considered. Alter this or temperature, not both.

Default: 1
n
​integer · min: 1

Number of completion choices to generate per request.

Default: 1
stream
​boolean

Set true for a Server-Sent Events stream of deltas.

Default: false
​

Up to 4 sequences where generation stops (string or array).

Example: ["\n\n"]
frequency_penalty
​number · min: -2 · max: 2

Penalize tokens by how often they already appeared — positive values reduce verbatim repetition.

Default: 0
presence_penalty
​number · min: -2 · max: 2

Penalize tokens that appeared at all — positive values push toward new topics.

Default: 0
​Tool[]

Function tools the model may call. Supported — the gateway passes tool definitions and tool-call turns through to the upstream model.

​

Controls tool use. auto (the default) and none are honoured by the M-series. required and the named-function object are accepted by the API but ignored by the model, which decides for itself. Tested 2026-07-26. Design for a model that chooses, and always handle a turn with no tool call.

ChatCompletionResponse

id
​string
object
​string
created
​integer

Unix timestamp (seconds).

model
​string

The model that actually served the request. During a provider incident this may be a smaller model of the same family as the one you requested.

​object[]

One entry per requested choice (n).

​Usage

Token usage in Chat Completions shape.

ResponsesRequest

model
​Model · enum · required

A model ID from the current catalog — real provider model names, all MiniMax. The core tiers are minimax-m3 (flagship), minimax-m2.7 (balanced daily driver) and minimax-m2.5 (fast); the -highspeed variants are latency-tuned versions of their standard siblings at roughly 2x the price; minimax-m2.1 and minimax-m2 are older M-series generations; minimax-m2-her is role-play/dialogue chat tuning; minimax-text-01 is the long-context text model. There are no invented aliases; any other ID returns an error. The catalog can change with notice.

Enum values:
minimax-m3
minimax-m2.7
minimax-m2.7-highspeed
minimax-m2.5
minimax-m2.5-highspeed
minimax-m2.1
minimax-m2.1-highspeed
minimax-m2
​required

The input — a plain string, or a list of typed input items (e.g. {"role": "user", "content": "..."}).

instructions
​string

System-style instructions for the model.

max_output_tokens
​integer · min: 1

Maximum number of tokens to generate in the response.

stream
​boolean

Set true for a Server-Sent Events stream of response events.

Default: false

ResponsesResponse

id
​string
object
​string
model
​string

The model that actually served the request. During a provider incident this may be a smaller model of the same family as the one you requested.

status
​string

completed, incomplete, or failed.

​object[]

Output items — for text generation, one assistant message.

​ResponsesUsage

Token usage in Responses-API shape.

ResponsesUsage

Token usage in Responses-API shape.
input_tokens
​integer
output_tokens
​integer
total_tokens
​integer

MessagesRequest

model
​Model · enum · required

A model ID from the current catalog — real provider model names, all MiniMax. The core tiers are minimax-m3 (flagship), minimax-m2.7 (balanced daily driver) and minimax-m2.5 (fast); the -highspeed variants are latency-tuned versions of their standard siblings at roughly 2x the price; minimax-m2.1 and minimax-m2 are older M-series generations; minimax-m2-her is role-play/dialogue chat tuning; minimax-text-01 is the long-context text model. There are no invented aliases; any other ID returns an error. The catalog can change with notice.

Enum values:
minimax-m3
minimax-m2.7
minimax-m2.7-highspeed
minimax-m2.5
minimax-m2.5-highspeed
minimax-m2.1
minimax-m2.1-highspeed
minimax-m2
max_tokens
​integer · min: 1 · required

Maximum number of tokens to generate. Required by the Anthropic Messages format.

​object[] · required

Alternating user / assistant turns, oldest first.

system
​string

Optional system prompt — a top-level field here, not a message role.

temperature
​number · min: 0 · max: 1

Sampling temperature, 0–1 in the Anthropic format. Lower is more deterministic.

stream
​boolean

Set true for a Server-Sent Events stream of message events.

Default: false
stop_sequences
​string[]

Custom sequences that stop generation.

MessagesResponse

id
​string
type
​string
role
​string
model
​string

The model that actually served the request. During a provider incident this may be a smaller model of the same family as the one you requested.

​object[]

Content blocks — for text generation, one text block.

stop_reason
​string

end_turn, max_tokens, or stop_sequence.

stop_sequence
​string | null

Which stop_sequences entry matched, if any.

​object

ModelList

object
​string
​object[]

Usage

Token usage in Chat Completions shape.
prompt_tokens
​integer
completion_tokens
​integer
total_tokens
​integer

Error

Error envelope returned by every non-2xx response.
​object
On this page
  • Model
  • ChatMessage
  • Tool
  • ToolCall
  • ChatCompletionRequest
  • ChatCompletionResponse
  • ResponsesRequest
  • ResponsesResponse
  • ResponsesUsage
  • MessagesRequest
  • MessagesResponse
  • ModelList
  • Usage
  • Error