Referencia de estructuras de datos
Las siguientes estructuras de datos de solicitud / respuesta se generan y sincronizan automáticamente a partir de la especificación OpenAPIOpenAPIEspecificación abierta que describe las REST API (antes Swagger). Las estructuras de datos de Lurus se generan y sincronizan automáticamente a partir de la especificación OpenAPI del gateway.Más información → de newapi (relay.json), y se mantienen siempre coherentes con la implementación del gateway. Consulta la lista completa de endpoints en Resumen de la API y los ejemplos de uso en Chat Completions.
Cómo se actualiza
La zona marcada con <!-- sync:schemas --> de esta página se regenera mediante bun run sync a partir de 2b-svc-newapi/docs/openapi/relay.json; no edites esta zona manualmente.
Total de 35 estructuras de datos (generadas automáticamente a partir de la especificación OpenAPI).
AudioTranscriptionResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
text | string | — |
ChatCompletionRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
model | string | Sí | ID del modelo |
messages | array<Message> | Sí | Lista de mensajes de la conversación |
temperature | number | — | Temperatura de muestreo |
top_p | number | — | Parámetro de muestreo nuclear (nucleus sampling) |
n | integer | — | Cantidad de generaciones |
stream | boolean | — | Si la respuesta es en streaming |
stream_options | object | — | |
stop | string | array<string> | — | Secuencias de parada |
max_tokens | integer | — | Número máximo de tokens generados |
max_completion_tokens | integer | — | Número máximo de tokens de completado |
presence_penalty | number | — | |
frequency_penalty | number | — | |
logit_bias | object | — | |
user | string | — | |
tools | array<Tool> | — | |
tool_choice | string (none / auto / required) | object | — | |
response_format | ResponseFormat | — | |
seed | integer | — | |
reasoning_effort | string (low / medium / high) | — | Intensidad de razonamiento (para modelos con soporte de razonamiento) |
modalities | array<string (text / audio)> | — | |
audio | object | — |
ChatCompletionResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | string | — | |
object | string | — | |
created | integer | — | |
model | string | — | |
choices | array<object> | — | |
usage | Usage | — | |
system_fingerprint | string | — |
ClaudeMessage
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
role | string (user / assistant) | Sí | |
content | string | array<object> | Sí |
ClaudeRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
model | string | Sí | |
messages | array<ClaudeMessage> | Sí | |
system | string | array<object> | — | |
cache_control | object | — | |
inference_geo | string | — | |
max_tokens | integer | Sí | |
temperature | number | — | |
top_p | number | — | |
top_k | integer | — | |
stream | boolean | — | |
stop_sequences | array<string> | — | |
tools | array<object> | — | |
tool_choice | object | — | |
thinking | object | — | |
context_management | object | — | |
output_config | object | — | |
output_format | object | — | |
container | string | object | — | |
mcp_servers | array<object> | — | |
metadata | object | — | |
speed | string (standard / fast) | — | |
service_tier | string (auto / standard_only) | — |
ClaudeResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | string | — | |
type | string | — | |
role | string | — | |
content | array<object> | — | |
model | string | — | |
stop_reason | string (end_turn / max_tokens / stop_sequence / tool_use) | — | |
usage | object | — |
CompletionRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
model | string | Sí | |
prompt | string | array<string> | Sí | |
max_tokens | integer | — | |
temperature | number | — | |
top_p | number | — | |
n | integer | — | |
stream | boolean | — | |
stop | string | array<string> | — | |
suffix | string | — | |
echo | boolean | — |
CompletionResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | string | — | |
object | string | — | |
created | integer | — | |
model | string | — | |
choices | array<object> | — | |
usage | Usage | — |
EmbeddingRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
model | string | Sí | |
input | string | array<string> | Sí | Texto a incrustar (embedding) |
encoding_format | string (float / base64) | — | |
dimensions | integer | — | Dimensión del vector de salida |
EmbeddingResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
object | string | — | |
data | array<object> | — | |
model | string | — | |
usage | object | — |
GeminiModelsResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
models | array<object> | — |
GeminiResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
candidates | array<object> | — | |
usageMetadata | object | — |
ImageResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
created | integer | — | |
data | array<object> | — |
Message
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
role | string (system / user / assistant / tool / developer) | Sí | Rol del mensaje |
content | string | array<MessageContent> | Sí | Contenido del mensaje |
name | string | — | Nombre del remitente |
tool_calls | array<ToolCall> | — | |
tool_call_id | string | — | ID de la llamada a la herramienta (para mensajes con rol tool) |
reasoning_content | string | — | Contenido de razonamiento |
MessageContent
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
type | string (text / image_url / input_audio / file / video_url) | — | |
text | string | — | |
image_url | object | — | |
input_audio | object | — | |
file | object | — | |
video_url | object | — |
Model
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | string | — | ID del modelo |
object | string | — | Tipo de objeto |
created | integer | — | Marca de tiempo de creación |
owned_by | string | — | Propietario del modelo |
ModelsResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
object | string | — | |
data | array<Model> | — |
ModerationRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
input | string | array<string> | Sí | |
model | string | — |
ModerationResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | string | — | |
model | string | — | |
results | array<object> | — |
RerankRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
model | string | Sí | |
query | string | Sí | Texto de la consulta |
documents | array<string | object> | Sí | Lista de documentos a reordenar |
top_n | integer | — | Devolver los N primeros resultados |
return_documents | boolean | — |
RerankResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | string | — | |
results | array<object> | — | |
meta | object | — |
ResponseFormat
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
type | string (text / json_object / json_schema) | — | |
json_schema | object | — | Definición de JSON Schema |
ResponsesCompactionRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
model | string | Sí | |
input | string | array<object> | — | Contenido de entrada; puede ser una cadena o un arreglo de mensajes |
instructions | string | — | |
previous_response_id | string | — |
ResponsesCompactionResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | string | — | |
object | string | — | |
created_at | integer | — | |
output | array<object> | — | |
usage | Usage | — | |
error | object | — |
ResponsesRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
model | string | Sí | |
input | string | array<object> | — | Contenido de entrada; puede ser una cadena o un arreglo de mensajes |
instructions | string | — | |
max_output_tokens | integer | — | |
temperature | number | — | |
top_p | number | — | |
stream | boolean | — | |
tools | array<object> | — | |
tool_choice | string | object | — | |
reasoning | object | — | |
previous_response_id | string | — | |
truncation | string (auto / disabled) | — |
ResponsesResponse
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | string | — | |
object | string | — | |
created_at | integer | — | |
status | string (completed / failed / in_progress / incomplete) | — | |
model | string | — | |
output | array<object> | — | |
usage | Usage | — |
SpeechRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
model | string | Sí | |
input | string | Sí | Texto a convertir |
voice | string (alloy / echo / fable / onyx / nova / shimmer) | Sí | |
response_format | string (mp3 / opus / aac / flac / wav / pcm) | — | |
speed | number | — |
Tool
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
type | string | — | |
function | object | — |
ToolCall
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | string | — | |
type | string | — | |
function | object | — |
Usage
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
prompt_tokens | integer | — | Número de tokens del prompt |
completion_tokens | integer | — | Número de tokens de completado |
total_tokens | integer | — | Número total de tokens |
prompt_tokens_details | object | — | |
completion_tokens_details | object | — |
VideoRequest
Solicitud de generación de video
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
model | string | — | ID del modelo/estilo |
prompt | string | — | Prompt de descripción textual |
image | string | — | Entrada de imagen (URL o Base64) |
duration | number | — | Duración del video (segundos) |
width | integer | — | Ancho del video |
height | integer | — | Alto del video |
fps | integer | — | Cuadros por segundo del video |
seed | integer | — | Semilla aleatoria |
n | integer | — | Cantidad de videos a generar |
response_format | string | — | Formato de la respuesta |
user | string | — | Identificador del usuario |
metadata | object | — | Parámetros extendidos (como negative_prompt, style, quality_level, etc.) |
VideoResponse
Respuesta al envío de una tarea de generación de video
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
task_id | string | — | ID de la tarea |
status | string | — | Estado de la tarea |
VideoTaskError
Información de error de la tarea de video
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | — | Código de error |
message | string | — | Mensaje de error |
VideoTaskMetadata
Metadatos de la tarea de video
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
duration | number | — | Duración real del video generado |
fps | integer | — | Cuadros por segundo reales |
width | integer | — | Ancho real |
height | integer | — | Alto real |
seed | integer | — | Semilla aleatoria utilizada |
VideoTaskResponse
Respuesta a la consulta del estado de la tarea de video
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
task_id | string | — | ID de la tarea |
status | string (queued / in_progress / completed / failed) | — | Estado de la tarea |
url | string | — | URL del recurso de video (cuando tiene éxito) |
format | string | — | Formato del video |
metadata | VideoTaskMetadata | — | |
error | VideoTaskError | — |