HypersHub Logo
Idioma
Español
POST

Crear una respuesta del modelo

Cree una respuesta del modelo usando el formato de la API de Responses de OpenAI, compatible con modos streaming y no streaming. Este endpoint solo admite canales compatibles con OpenAI (gpt-5.x etc.) y no admite canales nativos de Claude.

Autenticación

Autentíquese usando un Bearer Token en el encabezado de la solicitud. Puede generar una clave en la página de API Keys en la consola.
AuthorizationstringRequired

Formato: Bearer $HY_API_KEY.

Headers

Al enviar solicitudes POST, especifique el tipo de contenido (la mayoría de clientes HTTP y SDKs lo manejan automáticamente).
Content-TypestringOptional

Generalmente application/json.

Solicitud

Este endpoint acepta un objeto JSON como cuerpo de la solicitud.
modelstringRequired

ID del modelo, solo admite canales compatibles con OpenAI. Ej. gpt-5.4, gpt-5.4-mini, gpt-5.3-chat. Los modelos disponibles dependen de los permisos de su API Key.

inputstring | array of objectsRequired

Entrada del modelo, equivalente a messages en Chat Completions. Una cadena se trata como un solo mensaje de usuario; un array es compatible con el formato messages de Chat Completions (admite role: system / user / assistant / tool).

instructionsstringOptional

Prompt del sistema, equivalente al mensaje role: "system" en el array messages de Chat Completions. Se usa para establecer el rol, comportamiento o contexto de la tarea del modelo.

streambooleanOptional

Streaming vía SSE

max_output_tokensintegerOptional

Máximo de tokens de salida (solo salida visible, excluyendo tokens de razonamiento). Campo específico de la API Responses, corresponde a max_completion_tokens en Chat Completions.

reasoning_effortstringOptional

Profundidad de razonamiento. Los valores oficiales incluyen none, minimal, low, medium, high, xhigh; el conjunto soportado varía por modelo (ej. gpt-5.4 por defecto none, soporta hasta xhigh). Usa none/low para baja latencia; medium/high/xhigh para tareas complejas.

temperaturenumberOptional

No soportado para GPT-5.2 / GPT-5.4 cuando reasoning_effort ≠ none (error de solicitud). Solo válido para uso compatible con versiones anteriores o cuando reasoning_effort es none.

toolsarray of objectsOptional

Definiciones de herramientas para function calling

textobjectOptional

Especifique el formato de salida para el texto de respuesta.

previous_response_idstringOptional

ID de la respuesta anterior, usado para la continuidad de conversación de múltiples turnos. Equivalente a pasar manualmente mensajes históricos en input.

Errores

Los siguientes códigos de estado HTTP pueden devolverse en caso de fallo de la solicitud API:
POST
1import OpenAI from 'openai'
2​
3const client = new OpenAI({
4 apiKey: process.env.HY_API_KEY,
5 baseURL: 'https://apiclaw.cc/v1',
6})
7​
8const response = await client.responses.create({
9 model: 'gpt-5.4',
10 instructions: 'You are a helpful assistant.',
11 input: 'Write a one-sentence product description.',
12 max_output_tokens: 256,
13})
14​
15// 输出第一条文本内容
16for (const item of response.output) {
17 for (const part of item.content ?? []) {
18 if (part.type === 'output_text') {
19 console.log(part.text)
20 }
21 }
22}
POST

Authorization

Obtener API Key →
🔑
REQUEST
1const response = await fetch("https://apiclaw.cc/v1/responses", {
2 method: "POST",
3 headers: {
4 "Authorization": "Bearer YOUR_API_KEY",
5 "Content-Type": "application/json",
6 },
7});
8const data = await response.json();
9console.log(data);
RESPONSE
◎

Haz clic en Send request para ver la respuesta

Response
1{
2 "id": "resp_abc123",
3 "object": "response",
4 "created_at": 1747756800,
5 "status": "completed",
6 "model": "gpt-5.4",
7 "output": [
8 {
9 "id": "msg_xyz456",
10 "type": "message",
11 "role": "assistant",
12 "status": "completed",
13 "content": [
14 {
15 "type": "output_text",
16 "text": "Here is a concise product description.",
17 "annotations": []
18 }
19 ]
20 }
21 ],
22 "usage": {
23 "input_tokens": 22,
24 "output_tokens": 9,
25 "total_tokens": 31
26 }
27}