注册

创建结构化输出

Structured Output

POST https://api.quickrouter.ai/v1/chat/completions 在线调试 →
Authorization

在 Header 添加参数 Authorization,其值为 Bearer 之后拼接 Token

示例: Authorization: Bearer ********************

请求参数

Header 参数
Content-Type string
必需
示例: application/json
Authorization string
必需
示例: Bearer $OPENAI_API_KEY
Body 参数 application/json
model string
必需
要使用的模型的 ID,如 gpt-4.1-2025-04-14。
messages array [object]
必需
至今为止对话所包含的消息列表。
response_format object
必需
指定模型必须输出的格式,使用 json_schema 启用结构化输出。
temperature number
可选
使用什么采样温度,介于 0 和 2 之间。
max_tokens integer
可选
生成的最大标记数。
stream boolean
可选
设置为 true 启用流式输出。
示例
{
    "model": "gpt-4.1-2025-04-14",
    "messages": [
        {
            "role": "system",
            "content": "Determine if the user input violates specific guidelines and explain if they do."
        },
        {
            "role": "user",
            "content": "How do I prepare for a job interview?"
        }
    ],
    "response_format": {
        "type": "json_schema",
        "json_schema": {
            "name": "content_compliance",
            "description": "Determines if content is violating specific moderation rules",
            "schema": {
                "type": "object",
                "properties": {
                    "is_violating": {
                        "type": "boolean",
                        "description": "Indicates if the content is violating guidelines"
                    },
                    "category": {
                        "type": ["string", "null"],
                        "description": "Type of violation, if the content is violating guidelines. Null otherwise.",
                        "enum": ["violence", "sexual", "self_harm"]
                    },
                    "explanation_if_violating": {
                        "type": ["string", "null"],
                        "description": "Explanation of why the content is violating"
                    }
                },
                "required": ["is_violating", "category", "explanation_if_violating"],
                "additionalProperties": false
            },
            "strict": true
        }
    }
}

请求示例代码

curl --location --request POST 'https://api.quickrouter.ai/v1/chat/completions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "gpt-4.1-2025-04-14",
    "messages": [
        {
            "role": "system",
            "content": "Determine if the user input violates specific guidelines and explain if they do."
        },
        {
            "role": "user",
            "content": "How do I prepare for a job interview?"
        }
    ],
    "response_format": {
        "type": "json_schema",
        "json_schema": {
            "name": "content_compliance",
            "description": "Determines if content is violating specific moderation rules",
            "schema": {
                "type": "object",
                "properties": {
                    "is_violating": {
                        "type": "boolean",
                        "description": "Indicates if the content is violating guidelines"
                    },
                    "category": {
                        "type": ["string", "null"],
                        "description": "Type of violation, if the content is violating guidelines. Null otherwise.",
                        "enum": ["violence", "sexual", "self_harm"]
                    },
                    "explanation_if_violating": {
                        "type": ["string", "null"],
                        "description": "Explanation of why the content is violating"
                    }
                },
                "required": ["is_violating", "category", "explanation_if_violating"],
                "additionalProperties": false
            },
            "strict": true
        }
    }
}'
var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer <token>");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "model": "gpt-4.1-2025-04-14",
   "messages": [
      {
         "role": "system",
         "content": "Determine if the user input violates specific guidelines and explain if they do."
      },
      {
         "role": "user",
         "content": "How do I prepare for a job interview?"
      }
   ],
   "response_format": {
      "type": "json_schema",
      "json_schema": {
         "name": "content_compliance",
         "description": "Determines if content is violating specific moderation rules",
         "schema": {
            "type": "object",
            "properties": {
               "is_violating": {
                  "type": "boolean",
                  "description": "Indicates if the content is violating guidelines"
               },
               "category": {
                  "type": ["string", "null"],
                  "description": "Type of violation, if the content is violating guidelines. Null otherwise.",
                  "enum": ["violence", "sexual", "self_harm"]
               },
               "explanation_if_violating": {
                  "type": ["string", "null"],
                  "description": "Explanation of why the content is violating"
               }
            },
            "required": ["is_violating", "category", "explanation_if_violating"],
            "additionalProperties": false
         },
         "strict": true
      }
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.quickrouter.ai/v1/chat/completions", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));
import http.client
import json

conn = http.client.HTTPSConnection("api.quickrouter.ai")
payload = json.dumps({
   "model": "gpt-4.1-2025-04-14",
   "messages": [
      {
         "role": "system",
         "content": "Determine if the user input violates specific guidelines and explain if they do."
      },
      {
         "role": "user",
         "content": "How do I prepare for a job interview?"
      }
   ],
   "response_format": {
      "type": "json_schema",
      "json_schema": {
         "name": "content_compliance",
         "description": "Determines if content is violating specific moderation rules",
         "schema": {
            "type": "object",
            "properties": {
               "is_violating": {
                  "type": "boolean",
                  "description": "Indicates if the content is violating guidelines"
               },
               "category": {
                  "type": ["string", "null"],
                  "description": "Type of violation, if the content is violating guidelines. Null otherwise.",
                  "enum": ["violence", "sexual", "self_harm"]
               },
               "explanation_if_violating": {
                  "type": ["string", "null"],
                  "description": "Explanation of why the content is violating"
               }
            },
            "required": ["is_violating", "category", "explanation_if_violating"],
            "additionalProperties": False
         },
         "strict": True
      }
   }
})
headers = {
   'Authorization': 'Bearer <token>',
   'Content-Type': 'application/json'
}
conn.request("POST", "/v1/chat/completions", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

返回响应

响应参数 🟢 200 OK · application/json
id string
必需
object string
必需
choices array [object]
必需
usage object
必需
示例
{
    "id": "chatcmpl-123",
    "object": "chat.completion",
    "created": 1677652288,
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "\n\nHello there, how may I assist you today?"
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 9,
        "completion_tokens": 12,
        "total_tokens": 21
    }
}