Structured Output

Before copying a curl example, choose your Cloud region. For authenticated calls, it must be the same region as your key. The examples below use MIROBODY_API_BASE:

export MIROBODY_API_BASE="https://api.mirobody.ai/v1"   # Global account
# export MIROBODY_API_BASE="https://api.mirobody.cn/v1" # China account: use this instead

For SDK examples with a literal Global URL, use the matching China URL when your account is in China. See Regions. Use text.format on POST /v1/responses to request JSON output. It follows the OpenAI Responses text.format shape and is available only in backbone mode (mode:"model").

text.format requires mode:"model". On the default agent mode it returns 400 unsupported_parameter (param: "text"). The Answers API (/v1/chat/completions) likewise rejects response_format with 400.

`json_object`

Constrains the output to a syntactically valid JSON object (no schema):

{
  "model": "mirobody-flash",
  "mode": "model",
  "input": "Reply with a JSON object having keys a and b.",
  "text": { "format": { "type": "json_object" } }
}

The message text is a JSON string you parse yourself:

{ "output_text": "{\"a\":1,\"b\":2}", "status": "completed", ... }

`json_schema`

Requests output that follows a schema you supply. strict: true is forwarded to providers that support native JSON Schema:

curl "$MIROBODY_API_BASE/responses" \
  -H "Authorization: Bearer $MIROBODY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "model": "mirobody-flash",
        "mode": "model",
        "input": "Give me a manifest for apples with count 3.",
        "text": {
          "format": {
            "type": "json_schema",
            "name": "manifest",
            "strict": true,
            "schema": {
              "type": "object",
              "properties": {
                "item":  { "type": "string" },
                "count": { "type": "integer" }
              },
              "required": ["item", "count"],
              "additionalProperties": false
            }
          }
        }
      }'

from openai import OpenAI

client = OpenAI(api_key="mb_live_...", base_url="https://api.mirobody.ai/v1")

resp = client.responses.create(
    model="mirobody-flash",
    extra_body={"mode": "model"},
    input="Give me a manifest for apples with count 3.",
    text={
        "format": {
            "type": "json_schema",
            "name": "manifest",
            "strict": True,
            "schema": {
                "type": "object",
                "properties": {"item": {"type": "string"}, "count": {"type": "integer"}},
                "required": ["item", "count"],
                "additionalProperties": False,
            },
        }
    },
)
print(resp.output_text)   # {"item":"apples","count":3}

Provider fallback

text.format passes through to the underlying model. If the provider rejects native json_schema, Mirobody retries once as json_object with the schema included in the system prompt. That fallback targets the requested shape but does not validate the returned object against your schema. Parse and validate output_text yourself before using it.

​json_object

​json_schema

​Provider fallback

​See also

`json_object`

`json_schema`

Provider fallback

See also