Saltar al contenido principal
GET
/
api
/
v1
/
llm
/
responses
/
{response_id}
Python (SDK)
from openapi import SDK


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.llm.responses.get(response_id="resp_get123", include=[
        "file_search_call.results",
        "message.output_text.logprobs",
    ], include_obfuscation=False, starting_after=42, stream=False)

    with res as event_stream:
        for event in event_stream:
            # handle event
            print(event, flush=True)
{
  "id": "resp_get123",
  "object": "response",
  "created_at": 1735689600,
  "completed_at": 1735689601,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "background": false,
  "instructions": null,
  "max_output_tokens": null,
  "max_tool_calls": 30,
  "metadata": {},
  "model": "meetkai:functionary-urdu-mini-pak",
  "output": [
    {
      "type": "message",
      "id": "msg_abc123",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "The capital of France is Paris.",
          "annotations": []
        }
      ],
      "status": "completed"
    }
  ],
  "output_text": "The capital of France is Paris.",
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "service_tier": "auto",
  "store": true,
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "medium"
  },
  "tool_choice": "auto",
  "tools": [],
  "truncation": "auto",
  "usage": {
    "input_tokens": 8,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 7,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 15
  },
  "user": null
}

Autorizaciones

Authorization
string
header
requerido

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Parámetros de ruta

response_id
string
requerido

El identificador único de la respuesta, formateado como 'resp_' o 'resp-' seguido de caracteres alfanuméricos.

Pattern: ^resp[-_][a-zA-Z0-9]+$

Parámetros de consulta

include
enum<string>[]

Campos adicionales para incluir en la respuesta. Permite solicitar datos anidados específicos como fuentes de búsqueda web, salidas del intérprete de código, capturas de pantalla de la computadora, resultados de búsqueda de archivos, imágenes de entrada, logprobs de salida o contenido de razonamiento. Estos campos pueden tener implicaciones en el rendimiento o en los costos.

Opciones disponibles:
web_search_call.action.sources,
code_interpreter_call.outputs,
computer_call_output.output.image_url,
file_search_call.results,
message.input_image.image_url,
message.output_text.logprobs,
reasoning.encrypted_content
Ejemplo:
[
"file_search_call.results",
"message.output_text.logprobs"
]
include_obfuscation
boolean

Cuando es verdadero, la ofuscación del flujo estará habilitada por razones de privacidad y seguridad.

Ejemplo:

false

starting_after
integer

El número de secuencia del evento después del cual comenzar a transmitir. Se utiliza para reanudar la transmisión desde un punto específico.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
Ejemplo:

42

stream
boolean

Si se establece en verdadero, los datos de respuesta del modelo se transmitirán utilizando Eventos enviadas por el servidor (SSE) para actualizaciones en tiempo real a medida que el agente genera la respuesta.

Ejemplo:

false

Respuesta

Respuesta exitosa: devuelve eventos de transmisión (SSE) cuando stream=true o un objeto de respuesta completo (JSON) cuando stream=false u omitido.

id
string
requerido
object
any
requerido
created_at
number
requerido
completed_at
number | null
requerido
status
enum<string>
requerido

El estado general de la generación de respuestas. 'completado' significa finalizado con éxito, 'fallido' significa que ocurrió un error, 'en_proceso' significa que se está procesando actualmente, 'cancelado' significa cancelado por el usuario, 'en_colas' significa esperando para comenzar, 'incompleto' significa finalización parcial.

Opciones disponibles:
completed,
failed,
in_progress,
cancelled,
queued,
incomplete
error
object
requerido
incomplete_details
object
requerido
background
boolean
requerido
instructions
requerido
max_output_tokens
integer | null
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
Ejemplo:

null

max_tool_calls
integer | null
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
metadata
object
requerido
model
string
requerido
output
(Input message item · object | Output message item · object | Output audio item · object | File search call item · object | Computer call item · object | Computer call output item · object | Web search call item · object | Function call item · object | Function call output item · object | Reasoning item · object | Image generation call item · object | Code interpreter call item · object | Local shell call item · object | Local shell call output item · object | Shell call item · object | Shell call output item · object | MCP list tools item · object | MCP approval request item · object | MCP approval response item · object | MCP call item · object | Custom tool call item · object | Custom tool call output item · object | Item reference item · object | Compaction item · object)[]
requerido

Elemento de mensaje de entrada: Un mensaje con rol y contenido. Utiliza esto para turnos de usuario, asistente, sistema o desarrollador en entradas estructuradas.

parallel_tool_calls
boolean
requerido
previous_response_id
string | null
requerido
store
boolean
requerido
text
object
requerido
tool_choice
requerido

Modo de elección de herramienta: Selecciona cómo el modelo decide el uso de herramientas. Usa ninguno, automático o requerido.

Opciones disponibles:
none,
auto,
required
tools
(Function tool definition · object | File search tool definition · object | Computer use tool definition · object | Web search tool definition · object | MCP tool definition · object | Code interpreter tool definition · object | Image generation tool definition · object | Local shell tool definition · object | Shell tool definition · object | Custom tool definition · object | Web search preview tool definition · object | Hosted tool definition · object | History tool definition · object)[]
requerido

Definición de herramienta de función: Define una herramienta de función callable. Proporcione un nombre de herramienta y un esquema de parámetros, con descripción opcional y carga diferida.

truncation
enum<string>
requerido
Opciones disponibles:
auto,
disabled
usage
object
requerido
user
string | null
requerido
conversation
object
output_text
string
prompt
object
prompt_cache_key
string
reasoning
object
safety_identifier
string
service_tier
enum<string>
Opciones disponibles:
auto,
default,
flex,
priority
temperature
number
Rango requerido: 0 <= x <= 2
presence_penalty
number
frequency_penalty
number
top_logprobs
integer
Rango requerido: 0 <= x <= 20
top_p
number
Rango requerido: 0 <= x <= 1
context_management
object[]