Pular para o conteúdo principal
GET
/
api
/
v1
/
llm
/
responses
/
{response_id}
Python (SDK)
from mka1 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
}

Documentation Index

Fetch the complete documentation index at: https://docs.mka1.com/llms.txt

Use this file to discover all available pages before exploring further.

Autorizações

​
Authorization
string
header
obrigatório

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>.

Cabeçalhos

​
X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Parâmetros de caminho

​
response_id
string
obrigatório

O identificador único da resposta, formatado como 'resp_' ou 'resp-' seguido por caracteres alfanuméricos.

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

Parâmetros de consulta

​
include
enum<string>[]

Campos adicionais a serem incluídos na resposta. Permite solicitar dados específicos aninhados, como fontes de busca na web, saídas de interpretadores de código, capturas de tela do computador, resultados de busca de arquivos, imagens de entrada, logprobs de saída ou conteúdo de raciocínio. Esses campos podem ter implicações de desempenho ou custo.

Opções disponíveis:
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
Exemplo:
[
  "file_search_call.results",
  "message.output_text.logprobs"
]
​
include_obfuscation
boolean

Quando verdadeiro, a ofuscação de fluxos será ativada para fins de privacidade e segurança.

Exemplo:

false

​
starting_after
integer

O número da sequência do evento após o qual iniciar a transmissão. Usado para retomar a transmissão de um ponto específico.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
Exemplo:

42

​
stream
boolean

Se definido como verdadeiro, os dados da resposta do modelo serão transmitidos usando Eventos Enviados pelo Servidor (SSE) para atualizações em tempo real à medida que o agente gera a resposta.

Exemplo:

false

Resposta

Resposta bem-sucedida - retorna eventos de streaming (SSE) quando stream=true ou um objeto de resposta completo (JSON) quando stream=false ou omitido.

​
id
string
obrigatório
​
object
any
obrigatório
​
created_at
number
obrigatório
​
completed_at
number | null
obrigatório
​
status
enum<string>
obrigatório

O status geral da geração de resposta. 'completo' significa finalizado com sucesso, 'falhou' significa que ocorreu um erro, 'em_andamento' significa atualmente em processamento, 'cancelado' significa cancelado pelo usuário, 'na_fila' significa esperando para começar, 'incompleto' significa conclusão parcial.

Opções disponíveis:
completed,
failed,
in_progress,
cancelled,
queued,
incomplete
​
error
object
obrigatório
​
incomplete_details
object
obrigatório
​
background
boolean
obrigatório
​
instructions
obrigatório
​
max_output_tokens
integer | null
obrigatório
Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
Exemplo:

null

​
max_tool_calls
integer | null
obrigatório
Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
​
metadata
object
obrigatório
​
model
string
obrigatório
​
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)[]
obrigatório

Item de mensagem de entrada: Uma mensagem com papel e conteúdo. Use isso para turnos de usuário, assistente, sistema ou desenvolvedor em entradas estruturadas.

​
parallel_tool_calls
boolean
obrigatório
​
previous_response_id
string | null
obrigatório
​
store
boolean
obrigatório
​
text
object
obrigatório
​
tool_choice
obrigatório

Modo de escolha de ferramenta: Seleciona como o modelo decide o uso das ferramentas. Use nenhum, automático ou necessário.

Opções disponíveis:
none,
auto,
required
​
tools
(Function tool definition · object | File search tool definition · object | Computer use tool definition · object | Web search tool definition · object | any | 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 | Sleep tool definition · object | History tool definition · object | null)[]
obrigatório

Definição da ferramenta de função: Define uma ferramenta de função chamável. Forneça um nome de ferramenta e um esquema de parâmetros, com descrição opcional e carregamento diferido.

​
truncation
enum<string>
obrigatório
Opções disponíveis:
auto,
disabled
​
usage
object
obrigatório
​
user
string | null
obrigatório
​
conversation
object
​
output_text
string
​
prompt
object
​
prompt_cache_key
string
​
reasoning
object
​
safety_identifier
string
​
service_tier
enum<string>
Opções disponíveis:
auto,
default,
flex,
priority
​
temperature
number
Intervalo obrigatório: 0 <= x <= 2
​
presence_penalty
number
​
frequency_penalty
number
​
top_logprobs
integer
Intervalo obrigatório: 0 <= x <= 20
​
top_p
number
Intervalo obrigatório: 0 <= x <= 1
​
context_management
object[]