# MKA1: Brazilian Portuguese Referência da API ## Referência da API - [Brazilian Portuguese / Referência da API / Tools and sandbox (63 pages)](https://docs.mka1.com/_llms/pt-br/referencia-da-api/tools-and-sandbox.txt): Documentation for Brazilian Portuguese / Referência da API / Tools and sandbox. - [Brazilian Portuguese / Referência da API / Evals and feedback (55 pages)](https://docs.mka1.com/_llms/pt-br/referencia-da-api/evals-and-feedback.txt): Documentation for Brazilian Portuguese / Referência da API / Evals and feedback. - [Brazilian Portuguese / Referência da API / Organizations and access (65 pages)](https://docs.mka1.com/_llms/pt-br/referencia-da-api/organizations-and-access.txt): Documentation for Brazilian Portuguese / Referência da API / Organizations and access. ### Responses and conversations #### Responses - [Crie uma resposta impulsionada por agente com suporte de ferramentas](https://docs.mka1.com/api-reference/responses/crie-uma-resposta-impulsionada-por-agente-com-suporte-de-ferramentas.md): Cria uma nova resposta de agente de IA usando modelos de linguagem avançados com capacidades de uso autônomo de ferramentas. - [Liste todas as respostas com paginação](https://docs.mka1.com/api-reference/responses/liste-todas-as-respostas-com-paginação.md): Recupera uma lista paginada de todas as respostas dos agentes para o usuário autenticado. - [Recuperar resposta por ID com status e resultados](https://docs.mka1.com/api-reference/responses/recuperar-resposta-por-id-com-status-e-resultados.md): Recupera uma resposta de agente previamente criada pelo seu ID exclusivo. Quando stream=true, retorna Eventos Enviados pelo Servidor para atualizações em tempo real sobre respostas em andamento. - [Atualizar uma resposta](https://docs.mka1.com/api-reference/responses/atualizar-uma-resposta.md): Atualizar os metadados de uma resposta. - [Excluir permanentemente uma resposta e seus dados](https://docs.mka1.com/api-reference/responses/excluir-permanentemente-uma-resposta-e-seus-dados.md): Exclui permanentemente uma resposta de agente e todos os dados associados. - [Cancelar uma resposta em progresso em segundo plano](https://docs.mka1.com/api-reference/responses/cancelar-uma-resposta-em-progresso-em-segundo-plano.md): Cancela uma resposta de agente que está atualmente sendo processada em segundo plano. - [Despertar uma resposta em segundo plano adormecida](https://docs.mka1.com/api-reference/responses/despertar-uma-resposta-em-segundo-plano-adormecida.md): Interrompe uma chamada de ferramenta de sono curto em uma resposta em andamento em segundo plano, fornecendo uma entrada de acompanhamento. A entrega de ativação é verificada pelo agente em sono e pode levar até um segundo. - [Liste os itens de entrada paginados para uma resposta](https://docs.mka1.com/api-reference/responses/liste-os-itens-de-entrada-paginados-para-uma-resposta.md): Recupera uma lista paginada de todos os itens de entrada fornecidos ao criar a resposta do agente especificado. - [Resumir uma conversa](https://docs.mka1.com/api-reference/responses/resumir-uma-conversa.md): Cria um resumo compactado do histórico de conversas para uma resposta, reduzindo o tamanho do contexto enquanto preserva informações essenciais. Retorna um objeto de resposta compactado. #### Conversations - [Criar uma conversa](https://docs.mka1.com/api-reference/conversations/criar-uma-conversa.md): Crie uma conversa para armazenar e recuperar o estado da conversa em chamadas da API de Resposta. - [Listar conversas](https://docs.mka1.com/api-reference/conversations/listar-conversas.md): Liste todas as conversas do usuário autenticado com suporte a paginação. - [Recuperar uma conversa](https://docs.mka1.com/api-reference/conversations/recuperar-uma-conversa.md): Obtenha uma conversa pelo ID. - [Atualizar uma conversa](https://docs.mka1.com/api-reference/conversations/atualizar-uma-conversa.md): Atualizar os metadados de uma conversa. - [Excluir uma conversa](https://docs.mka1.com/api-reference/conversations/excluir-uma-conversa.md): Excluir uma conversa. Itens na conversa não serão excluídos. - [Listar itens de conversa](https://docs.mka1.com/api-reference/conversations/listar-itens-de-conversa.md): Liste todos os itens para uma conversa com o ID fornecido. - [Criar itens de conversa](https://docs.mka1.com/api-reference/conversations/criar-itens-de-conversa.md): Crie itens em uma conversa com o ID fornecido. - [Excluir vários itens de conversa](https://docs.mka1.com/api-reference/conversations/excluir-vários-itens-de-conversa.md): Excluir múltiplos itens de uma conversa com o ID fornecido. - [Recuperar um item de conversa](https://docs.mka1.com/api-reference/conversations/recuperar-um-item-de-conversa.md): Obtenha um único item de uma conversa com os IDs fornecidos. - [Excluir um item de conversa](https://docs.mka1.com/api-reference/conversations/excluir-um-item-de-conversa.md): Excluir um item de uma conversa com o ID fornecido. ### Models and routing #### Models - [Listar modelos disponíveis](https://docs.mka1.com/api-reference/models/listar-modelos-disponíveis.md): Lista os modelos disponíveis atualmente. Fornece informações básicas sobre cada modelo, incluindo seu ID e proprietário. - [Recuperar um modelo](https://docs.mka1.com/api-reference/models/recuperar-um-modelo.md): Recupera uma instância de modelo, fornecendo informações básicas sobre o modelo, como o proprietário e as capacidades suportadas. - [Ler a cota de tokens de um modelo](https://docs.mka1.com/api-reference/models/ler-a-cota-de-tokens-de-um-modelo.md): Leia os limites de token aplicáveis sem consumir tokens ou iniciar uma janela. Os limites da organização podem ser compartilhados entre modelos. Use um modelo ativo concreto, não auto. Omita seletores para o contexto do chamador autenticado, incluindo seu usuário externo delegado. Sessões humanas po… - [Obter a cota de tokens de uma organização](https://docs.mka1.com/api-reference/models/obter-a-cota-de-tokens-de-uma-organização.md): Leitura de cluster-admin da política agregada de tokens em todos os modelos. Uma cota ausente ou desativada retorna enabled: false com limit e period nulos. Não requer um modelo nem altera a organização ativa. - [Definir a cota de tokens de uma organização](https://docs.mka1.com/api-reference/models/definir-a-cota-de-tokens-de-uma-organização.md): Administradores do cluster podem criar ou substituir a permissão de token por minuto/dia/mês, ou desativá-la com enabled: false. As alterações se aplicam a novas admissões em até 10 segundos; as solicitações já admitidas são concluídas. Mudanças de limite preservam o uso. Mudanças de período usam o… - [Liste a reversão de execução do orçamento de cada organização](https://docs.mka1.com/api-reference/models/liste-a-reversão-de-execução-do-orçamento-de-cada-organização.md): Inventário para administradores de cluster das organizações que possuem uma substituição de imposição de orçamento, com o padrão do cluster e o modo efetivo de cada uma — o que revisar antes de alterar o padrão do cluster e onde procurar quando uma organização está sendo recusada com `budget_check_u… - [Obter a configuração de aplicação do orçamento de uma organização](https://docs.mka1.com/api-reference/models/obter-a-configuração-de-aplicação-do-orçamento-de-uma-organização.md): O que a trava de gastos faz para as solicitações faturáveis desta organização quando a verificação de orçamento não pode ser realizada (orçamento indisponível ou degradado): `allow` as admite, `block` as recusa com 503 `budget_check_unavailable`. Retorna a configuração própria da organização (null =… - [Definir a configuração de aplicação do orçamento de uma organização](https://docs.mka1.com/api-reference/models/definir-a-configuração-de-aplicação-do-orçamento-de-uma-organização.md): Escolha `block` para recusar as solicitações cobradas desta organização sempre que a verificação de orçamento estiver indisponível (fail closed), `allow` para aceitá-las (fail open), ou `null` para herdar novamente o padrão do cluster. Aplica-se a novas admissões em até 10 segundos em cada réplica d… - [Liste o catálogo de modelos da organização](https://docs.mka1.com/api-reference/models/liste-o-catálogo-de-modelos-da-organização.md): Lista todas as definições de BYO, serviço e acesso ao cluster com estado de ativação, bloqueador, integridade e prévia de preço. - [Defina um modelo de catálogo BYO](https://docs.mka1.com/api-reference/models/defina-um-modelo-de-catálogo-byo.md): Cria uma definição BYO de propriedade da API sem ativar seu nome. - [Atualizar um modelo de catálogo BYO](https://docs.mka1.com/api-reference/models/atualizar-um-modelo-de-catálogo-byo.md): Atualiza uma definição BYO de propriedade da API; entradas de origem yaml são gerenciadas por arquivo e imutáveis por meio desta API. - [Remover um modelo de catálogo BYO](https://docs.mka1.com/api-reference/models/remover-um-modelo-de-catálogo-byo.md): Revoga uma definição BYO e a desativa apenas quando o nome ativo é originado dessa linhagem BYO. - [Verifique a integridade de um modelo de catálogo BYO](https://docs.mka1.com/api-reference/models/verifique-a-integridade-de-um-modelo-de-catálogo-byo.md): Verifica uma definição BYO disponível, esteja ela ativa ou não. Uma definição sem uma verificação de integridade não tem nada para sondar e retorna `status: unknown`. - [Liste o acesso ao modelo de cluster de uma organização](https://docs.mka1.com/api-reference/models/liste-o-acesso-ao-modelo-de-cluster-de-uma-organização.md): Visão do operador do cluster dos catálogos de cluster disponíveis de uma organização e seu estado de ativação. - [Adicionar acesso ao modelo de cluster para uma organização](https://docs.mka1.com/api-reference/models/adicionar-acesso-ao-modelo-de-cluster-para-uma-organização.md): Adiciona disponibilidade de forma idempotente sem revogar nenhum nome de modelo. Defina activate como true para também ativar todos os modelos solicitados da fonte do cluster na organização de destino. Concessões e ativações são atômicas por solicitação; um nome ativo de outra fonte retorna 409 sem… - [Substituir o acesso ao modelo de cluster de uma organização](https://docs.mka1.com/api-reference/models/substituir-o-acesso-ao-modelo-de-cluster-de-uma-organização.md): Substituição completa serializável; os nomes de clusters ativos revogados são desativados e suas linhas de preço da organização são encerradas. - [Listar organizações com acesso a um modelo de cluster](https://docs.mka1.com/api-reference/models/listar-organizações-com-acesso-a-um-modelo-de-cluster.md): Consulta reversa do operador de cluster mostrando disponibilidade e ativação para um ID de catálogo de um cluster. - [Liste o registro de modelos ativo da organização](https://docs.mka1.com/api-reference/models/liste-o-registro-de-modelos-ativo-da-organização.md): Visão única de gerenciamento de cada nome ativo com definição qualificada pela origem, saúde, preço e detalhes de auditoria de ativação. - [Ativar uma entrada do catálogo](https://docs.mka1.com/api-reference/models/ativar-uma-entrada-do-catálogo.md): Reivindica um nome de modelo de uma fonte de catálogo. A reativação da mesma fonte é idempotente; um detentor diferente retorna 409. - [Desativar um nome de registro de modelo](https://docs.mka1.com/api-reference/models/desativar-um-nome-de-registro-de-modelo.md): Remove de forma idempotente o nome ativo e encerra suas linhas de preço no escopo da organização sem tocar na definição do catálogo. - [Liste as substituições de modelo automático desta organização.](https://docs.mka1.com/api-reference/models/liste-as-substituições-de-modelo-automático-desta-organização.md): Retorna todos os pontos finais para os quais esta organização definiu seu próprio alvo `"auto"`. Pontos finais não listados recaem nos padrões YAML do operador. - [Defina a política automática desta organização para um endpoint](https://docs.mka1.com/api-reference/models/defina-a-política-automática-desta-organização-para-um-endpoint.md): Armazena o alias direto existente `{ endpoint → model_id }` ou uma política de juiz com modelos candidatos. O roteamento por juiz é suportado para respostas, conclusões, transcrições e TTS. O juiz deve ser um LLM de texto sem raciocínio. Todos os modelos configurados devem estar ativos quando gravad… - [Clear this org's auto-model override for an endpoint](https://docs.mka1.com/api-reference/models/clear-this-orgs-auto-model-override-for-an-endpoint.md): Removes the per-org override for the endpoint. Subsequent `model: "auto"` requests fall through to the operator's YAML default again. - [Obtenha a moeda do cluster](https://docs.mka1.com/api-reference/models/obtenha-a-moeda-do-cluster.md): Retorna o código de moeda ISO-4217 para todo o cluster (nulo se não estiver definido). - [Defina a moeda do cluster](https://docs.mka1.com/api-reference/models/defina-a-moeda-do-cluster.md): Define a moeda para todo o cluster. Alterá-la não converte automaticamente os preços existentes. - [Listar preços do modelo padrão de cluster](https://docs.mka1.com/api-reference/models/listar-preços-do-modelo-padrão-de-cluster.md): Sem `model`, lista o preço padrão atual de cada modelo. Com `model`, retorna o histórico completo datado daquele modelo. - [Definir um preço de modelo padrão do cluster](https://docs.mka1.com/api-reference/models/definir-um-preço-de-modelo-padrão-do-cluster.md): Atualiza o preço padrão do cluster para um modelo como uma nova versão datada. `rates` é um mapa flexível de métrica→taxa; métricas omitidas não são cobradas. - [Limpar o preço do modelo cluster-default](https://docs.mka1.com/api-reference/models/limpar-o-preço-do-modelo-cluster-default.md): Encerra o preço padrão do cluster. A linhagem ativa do cluster então usa uma substituição da organização ou passa a não ter preço ($0). - [Liste as substituições de preço de uma organização](https://docs.mka1.com/api-reference/models/liste-as-substituições-de-preço-de-uma-organização.md): Sem `model`, lista as substituições atuais da organização. Com `model`, retorna o histórico datado dessa substituição. - [Defina uma superação de preço da organização](https://docs.mka1.com/api-reference/models/defina-uma-superação-de-preço-da-organização.md): Faz upsert de um preço datado por organização. A linhagem do cluster recai para o padrão do cluster; a linhagem BYO e de serving fica sem preço quando não existe uma linha da organização. - [Limpar uma sobreposição de preço da organização](https://docs.mka1.com/api-reference/models/limpar-uma-sobreposição-de-preço-da-organização.md): Fecha um preço por organização. Somente a linhagem de cluster ativa pode então recorrer ao padrão do cluster. - [Liste os preços efetivos dos modelos do chamador](https://docs.mka1.com/api-reference/models/liste-os-preços-efetivos-dos-modelos-do-chamador.md): Para cada modelo ativo, retorna seu preço com reconhecimento do registro: uma linha da organização, um padrão do cluster para a linhagem do cluster, ou sem preço ($0). Também lista o alias de roteamento `auto`, precificado pelo máximo por métrica em todos os modelos pelos quais ele pode ser cobrado… #### Embeddings - [Listar modelos de embedding disponíveis](https://docs.mka1.com/api-reference/embeddings/listar-modelos-de-embedding-disponíveis.md): Retorna uma lista de modelos de embedding disponíveis com seus limites. Use este endpoint para descobrir quais modelos estão disponíveis e suas restrições (tamanho do lote, comprimento de entrada) antes de fazer solicitações de embedding. - [Criar embeddings de texto](https://docs.mka1.com/api-reference/embeddings/criar-embeddings-de-texto.md): Gera embeddings vetoriais para entradas de texto únicas ou múltiplas. Retorna vetores em ponto flutuante juntamente com estatísticas de uso de token. #### Text Classification - [Classificar texto em categorias pré-definidas](https://docs.mka1.com/api-reference/text-classification/classificar-texto-em-categorias-pré-definidas.md): Classifica o conteúdo do texto em uma das etiquetas pré-definidas fornecidas. ### Images and audio #### Images - [Gerar imagens a partir de descrições em texto](https://docs.mka1.com/api-reference/images/gerar-imagens-a-partir-de-descrições-em-texto.md): Cria imagens geradas por IA a partir de descrições em texto. #### Speech - [Transcrição de fala para texto](https://docs.mka1.com/api-reference/speech/transcrição-de-fala-para-texto.md): Converta áudio em texto usando reconhecimento de fala avançado. - [Texto para fala](https://docs.mka1.com/api-reference/speech/texto-para-fala.md): Converta texto em fala com detecção automática de idioma. - [Texto de streaming para fala](https://docs.mka1.com/api-reference/speech/texto-de-streaming-para-fala.md): Converta texto em fala com entrega de áudio em streaming em tempo real. - [Gerar token de sala LiveKit](https://docs.mka1.com/api-reference/speech/gerar-token-de-sala-livekit.md): Gera um token de acesso LiveKit para entrar em uma sala de voz em tempo real. O token inclui credenciais criptografadas e configuração de modelo para o agente de voz. - [Lista do histórico de texto para fala](https://docs.mka1.com/api-reference/speech/lista-do-histórico-de-texto-para-fala.md): Liste as gerações de texto para fala armazenadas para o usuário autenticado, do mais recente para o mais antigo por padrão. - [Recuperar item do histórico de texto para fala](https://docs.mka1.com/api-reference/speech/recuperar-item-do-histórico-de-texto-para-fala.md): Retorna metadados para uma geração de texto para fala armazenada. - [Excluir item do histórico de texto para fala](https://docs.mka1.com/api-reference/speech/excluir-item-do-histórico-de-texto-para-fala.md): Exclui uma geração de texto para fala armazenada. O blob de áudio é endereçado por conteúdo e pode ser compartilhado, por isso fica armazenado. - [Recuperar áudio de texto para fala](https://docs.mka1.com/api-reference/speech/recuperar-áudio-de-texto-para-fala.md): Retorna o áudio armazenado para uma geração de texto para fala como uma resposta binária. - [Listar histórico de fala para texto](https://docs.mka1.com/api-reference/speech/listar-histórico-de-fala-para-texto.md): Liste as transcrições armazenadas para o usuário autenticado, sendo as mais recentes aparecendo primeiro por padrão. - [Recuperar item de histórico de conversão de fala para texto](https://docs.mka1.com/api-reference/speech/recuperar-item-de-histórico-de-conversão-de-fala-para-texto.md): Retorna metadados para uma transcrição armazenada. - [Excluir item do histórico de reconhecimento de voz](https://docs.mka1.com/api-reference/speech/excluir-item-do-histórico-de-reconhecimento-de-voz.md): Excluir uma transcrição armazenada. O blob de áudio é endereçado por conteúdo e pode ser compartilhado, portanto, é mantido no armazenamento. - [Recuperar áudio de fala para texto](https://docs.mka1.com/api-reference/speech/recuperar-áudio-de-fala-para-texto.md): Retorna o áudio de entrada armazenado para uma transcrição como uma resposta binária. ### Files and retrieval #### Files - [Carregar arquivo](https://docs.mka1.com/api-reference/files/carregar-arquivo.md): Faça o upload de um arquivo que pode ser usado com Assistentes, Armazenamentos de Vetores e outros recursos. Os arquivos são enviados para o S3 para armazenamento durável. - [Listar arquivos](https://docs.mka1.com/api-reference/files/listar-arquivos.md): Retorna uma lista de arquivos que foram enviados. - [Recuperar arquivo](https://docs.mka1.com/api-reference/files/recuperar-arquivo.md): Retorna informações sobre um arquivo específico. - [Excluir arquivo](https://docs.mka1.com/api-reference/files/excluir-arquivo.md): Exclui um arquivo do armazenamento. Primeiro, o arquivo é removido de todos os armazenamentos vetoriais aos quais está associado, incluindo os embeddings, para que ele não apareça mais nos resultados de busca do armazenamento vetorial ou de `file_search`. Se isso não puder ser concluído, o arquivo é… - [Recuperar conteúdo do arquivo](https://docs.mka1.com/api-reference/files/recuperar-conteúdo-do-arquivo.md): Retorna o conteúdo binário bruto do arquivo especificado com o cabeçalho Content-Type apropriado. #### Vector Stores - [Criar um armazenamento de vetores](https://docs.mka1.com/api-reference/vector-stores/criar-um-armazenamento-de-vetores.md): Cria um novo armazenamento vetorial para armazenar e pesquisar embeddings de documentos. Com file_ids, dois arquivos com o mesmo conteúdo na solicitação são recusados com 409 antes que o armazenamento seja criado. - [Listar armazéns de vetores](https://docs.mka1.com/api-reference/vector-stores/listar-armazéns-de-vetores.md): Recupera uma lista paginada de todos os armazenamentos de vetores para o usuário autenticado. - [Recuperar um repositório de vetores](https://docs.mka1.com/api-reference/vector-stores/recuperar-um-repositório-de-vetores.md): Recupera um armazenamento vetorial pelo seu ID. Retorna 410 quando o armazenamento vetorial tiver expirado. - [Modificar um repositório de vetores](https://docs.mka1.com/api-reference/vector-stores/modificar-um-repositório-de-vetores.md): Atualiza o nome, a descrição, a política de expiração ou os metadados de um vector store existente. O modelo de embedding, as dimensões de embedding, o modo de recuperação, o modelo de extração e o número máximo de saltos são fixados quando um store é criado, e o chunking é definido por arquivo anex… - [Excluir um armazenamento de vetor](https://docs.mka1.com/api-reference/vector-stores/excluir-um-armazenamento-de-vetor.md): Exclui permanentemente um repositório de vetores e suas respectivas incorporações. - [Pesquisar um armazenamento de vetores](https://docs.mka1.com/api-reference/vector-stores/pesquisar-um-armazenamento-de-vetores.md): Realiza uma busca semântica em um armazenamento vetorial para encontrar os trechos de documento mais relevantes para uma consulta. Retorna 410 assim que o armazenamento vetorial tiver expirado. - [Adicionar um arquivo a um repositório de vetores](https://docs.mka1.com/api-reference/vector-stores/adicionar-um-arquivo-a-um-repositório-de-vetores.md): Adiciona um arquivo a um armazenamento vetorial para indexação de busca semântica. Retorna 409 quando o armazenamento já contém um arquivo com o mesmo conteúdo (o erro nomeia esse arquivo; o armazenamento indexa cada conteúdo uma única vez), 410 quando o armazenamento vetorial já expirou. - [Listar arquivos em um armazenamento vetorial](https://docs.mka1.com/api-reference/vector-stores/listar-arquivos-em-um-armazenamento-vetorial.md): Recupera uma lista paginada de todos os arquivos em um armazenamento vetorial específico. Retorna 410 quando o armazenamento vetorial tiver expirado. - [Recuperar um arquivo de loja de vetores](https://docs.mka1.com/api-reference/vector-stores/recuperar-um-arquivo-de-loja-de-vetores.md): Recupera informações detalhadas sobre um arquivo específico dentro de um armazenamento vetorial. Retorna 410 quando o armazenamento vetorial tiver expirado. - [Atualizar atributos de arquivo](https://docs.mka1.com/api-reference/vector-stores/atualizar-atributos-de-arquivo.md): Atualiza os atributos de metadados associados a um arquivo dentro de um repositório vetorial. Retorna 410 quando o repositório vetorial tiver expirado. - [Remover arquivo do armazenamento de vetores](https://docs.mka1.com/api-reference/vector-stores/remover-arquivo-do-armazenamento-de-vetores.md): Remove um arquivo de um armazenamento vetorial e exclui os embeddings associados a ele. Se o arquivo não estiver mais anexado, mas o armazenamento vetorial ainda mantiver embeddings para ele (por exemplo, deixados por uma exclusão anterior do arquivo), esses embeddings são excluídos e a solicitação… - [Recuperar conteúdo do arquivo analisado](https://docs.mka1.com/api-reference/vector-stores/recuperar-conteúdo-do-arquivo-analisado.md): Recupera o conteúdo completo analisado de um arquivo dentro de um armazenamento vetorial. Retorna 410 assim que o armazenamento vetorial tiver expirado. - [Adicionar múltiplos arquivos em lote ao armazenamento vetorial](https://docs.mka1.com/api-reference/vector-stores/adicionar-múltiplos-arquivos-em-lote-ao-armazenamento-vetorial.md): Adiciona vários arquivos a um armazenamento vetorial em uma única operação em lote. Um arquivo com o mesmo conteúdo de um que o armazenamento já contém, ou de um arquivo anterior no lote, faz o lote falhar com 409, a menos que skip_duplicates esteja definido; nesse caso, ele é registrado como cancel… - [Recuperar status de lote de arquivo](https://docs.mka1.com/api-reference/vector-stores/recuperar-status-de-lote-de-arquivo.md): Recupera o status de uma operação específica de lote de arquivos dentro de um armazenamento vetorial. Retorna 410 assim que o armazenamento vetorial tiver expirado. - [Cancelar o processamento do arquivo em lote](https://docs.mka1.com/api-reference/vector-stores/cancelar-o-processamento-do-arquivo-em-lote.md): Cancela uma operação de lote de arquivos em andamento. Retorna 410 quando o armazenamento vetorial tiver expirado. - [Listar arquivos em um lote](https://docs.mka1.com/api-reference/vector-stores/listar-arquivos-em-um-lote.md): Recupera uma lista paginada de todos os arquivos dentro de uma operação de lote específica. Retorna 410 quando o armazenamento vetorial tiver expirado. - [Listar permissões do armazenamento de vetores](https://docs.mka1.com/api-reference/vector-stores/listar-permissões-do-armazenamento-de-vetores.md): Lista quem possui uma função no armazenamento vetorial: seu proprietário, depois sua equipe quando essa permissão estiver definida, e então os principais individuais. Qualquer pessoa que possa ler o armazenamento pode listar suas permissões. Os administradores da organização da equipe do armazenamen… - [Conceder permissão a um armazenamento vetorial](https://docs.mka1.com/api-reference/vector-stores/conceder-permissão-a-um-armazenamento-vetorial.md): Concede `reader` ou `writer` no armazenamento vetorial a um único principal, ou a cada membro da equipe do armazenamento (`grantee_type: team`), substituindo qualquer função que esse principal já possuía. Somente o proprietário do armazenamento ou um administrador da organização da sua equipe pode c… - [Recuperar a permissão de um armazenamento vetorial](https://docs.mka1.com/api-reference/vector-stores/recuperar-a-permissão-de-um-armazenamento-vetorial.md): Retorna o papel que um principal efetivamente possui no armazenamento vetorial e de onde ele vem: `owner`, uma permissão concedida a ele (`grant`), a permissão `team` do armazenamento ou `none`. Um principal com `none` ainda pode acessar o armazenamento como um administrador da organização da equipe… - [Remover uma permissão de armazenamento vetorial](https://docs.mka1.com/api-reference/vector-stores/remover-uma-permissão-de-armazenamento-vetorial.md): Remove todos os papéis que o principal possui no armazenamento vetorial, ou a permissão `team`. Somente o proprietário do armazenamento ou um administrador da organização da sua equipe pode remover permissões (403 caso contrário); a própria permissão do proprietário não pode ser removida. Retorna 40… ### Agents #### Agents - [Listar ferramentas de funções reutilizáveis](https://docs.mka1.com/api-reference/agents/listar-ferramentas-de-funções-reutilizáveis.md) - [Criar uma ferramenta de função reutilizável](https://docs.mka1.com/api-reference/agents/criar-uma-ferramenta-de-função-reutilizável.md) - [Obtenha uma ferramenta de função reutilizável](https://docs.mka1.com/api-reference/agents/obtenha-uma-ferramenta-de-função-reutilizável.md) - [Substitua uma definição de função reutilizável](https://docs.mka1.com/api-reference/agents/substitua-uma-definição-de-função-reutilizável.md): As atualizações se aplicam a cada agente anexado na próxima execução. Os snapshots de execução existentes são imutáveis. - [Excluir uma ferramenta de função reutilizável](https://docs.mka1.com/api-reference/agents/excluir-uma-ferramenta-de-função-reutilizável.md): Agentes vinculados falham até que a referência indisponível seja removida. As capturas de execução existentes permanecem utilizáveis. - [Liste os conjuntos de ferramentas OpenAPI importados](https://docs.mka1.com/api-reference/agents/liste-os-conjuntos-de-ferramentas-openapi-importados.md) - [Importar um documento OpenAPI como um conjunto de ferramentas](https://docs.mka1.com/api-reference/agents/importar-um-documento-openapi-como-um-conjunto-de-ferramentas.md): Analisa um documento OpenAPI 3.0 ou 3.1 (JSON ou YAML, enviado no corpo; ele nunca é obtido de uma URL) e armazena suas operações compatíveis como ferramentas que um agente pode chamar. Operações que não podem ser chamadas com fidelidade são listadas em `skipped_operations`; selecionar uma delas em… - [Obtenha um conjunto de ferramentas OpenAPI importado](https://docs.mka1.com/api-reference/agents/obtenha-um-conjunto-de-ferramentas-openapi-importado.md) - [Substitua um conjunto de ferramentas OpenAPI por uma nova importação](https://docs.mka1.com/api-reference/agents/substitua-um-conjunto-de-ferramentas-openapi-por-uma-nova-importação.md): Aplica-se a todos os agentes anexados em sua próxima execução. As capturas de execução existentes são imutáveis. - [Excluir um conjunto de ferramentas OpenAPI](https://docs.mka1.com/api-reference/agents/excluir-um-conjunto-de-ferramentas-openapi.md): Agentes vinculados falham até que a referência indisponível seja removida. As capturas de execução existentes permanecem utilizáveis. - [Listar agentes](https://docs.mka1.com/api-reference/agents/listar-agentes.md) - [Criar um agente](https://docs.mka1.com/api-reference/agents/criar-um-agente.md) - [Recuperar um agente](https://docs.mka1.com/api-reference/agents/recuperar-um-agente.md) - [Atualizar um agente](https://docs.mka1.com/api-reference/agents/atualizar-um-agente.md) - [Exclua logicamente um agente](https://docs.mka1.com/api-reference/agents/exclua-logicamente-um-agente.md): Preserva versões de configuração e histórico de execução para auditoria. O prazo final de restauração é definido usando AGENT_RETENTION_DAYS na exclusão. - [Restaurar um agente excluído temporariamente](https://docs.mka1.com/api-reference/agents/restaurar-um-agente-excluído-temporariamente.md): Restaura a configuração original e o histórico antes de retention_expires_at. Requer write:agents na tenancy original da mutação. Os agendamentos permanecem pausados. #### Agent Versions - [Listar versões do agente](https://docs.mka1.com/api-reference/agent-versions/listar-versões-do-agente.md): Lista o histórico de configuração de um agente. Cada alteração confirmada (criação, atualização, reversão) adiciona uma versão. - [Recuperar uma versão do agente](https://docs.mka1.com/api-reference/agent-versions/recuperar-uma-versão-do-agente.md) - [Reverter um agente para uma versão](https://docs.mka1.com/api-reference/agent-versions/reverter-um-agente-para-uma-versão.md): Restaura a configuração da versão de destino como uma nova versão atual. O histórico é preservado: a restauração é adicionada como uma nova versão em vez de excluir as versões posteriores. #### Agent Runs - [Lista de execuções para um agente](https://docs.mka1.com/api-reference/agent-runs/lista-de-execuções-para-um-agente.md) - [Iniciar uma execução de agente salva](https://docs.mka1.com/api-reference/agent-runs/iniciar-uma-execução-de-agente-salva.md): Inicia uma execução assíncrona em segundo plano para um agente salvo e retorna o registro da execução enfileirada. Use o endpoint de recuperação da execução para consultar o status ou o endpoint de eventos para transmitir o progresso. Quando o agente já estiver executando o número máximo de execuçõe… - [Eventos de execução do agente de streaming](https://docs.mka1.com/api-reference/agent-runs/eventos-de-execução-do-agente-de-streaming.md): Transmitir Eventos Enviados pelo Servidor para a resposta do gateway vinculada a esta execução de agente. Execuções de terminal emitem um único evento de terminal e encerram. - [Cancelar a execução de um agente salvo](https://docs.mka1.com/api-reference/agent-runs/cancelar-a-execução-de-um-agente-salvo.md): Cancela uma execução em espera ou na fila localmente antes do despacho, ou encaminha o cancelamento para sua resposta de gateway vinculada. Execuções vinculadas falhadas localmente com um snapshot de gateway ativo ou ausente são verificadas a montante antes do cancelamento; trabalhos terminais genuí… - [Acorde um agente adormecido execute](https://docs.mka1.com/api-reference/agent-runs/acorde-um-agente-adormecido-execute.md): Interrompe uma chamada de ferramenta de sono curto em uma execução em segundo plano, encaminhando a entrada de acompanhamento para a resposta do gateway. - [Aprovar ou negar uma chamada de ferramenta MCP pendente](https://docs.mka1.com/api-reference/agent-runs/aprovar-ou-negar-uma-chamada-de-ferramenta-mcp-pendente.md): Cria uma execução de continuação para uma mcp_approval_request emitida pela execução de origem. O gateway vincula a decisão de uso único ao servidor, ferramenta e argumentos originais; negar nunca invoca a ferramenta MCP remota. - [Recuperar uma execução de agente](https://docs.mka1.com/api-reference/agent-runs/recuperar-uma-execução-de-agente.md) #### Agent Connectors - [Listar conectores para um agente](https://docs.mka1.com/api-reference/agent-connectors/listar-conectores-para-um-agente.md): Lista os conectores de canal de mensagens configurados para o agente. As credenciais do conector nunca são retornadas. - [Criar um conector](https://docs.mka1.com/api-reference/agent-connectors/criar-um-conector.md): Conecta o agente a um bot do Telegram ou a um número de telefone do WhatsApp Business, valida as credenciais do provedor e registra o webhook do agente. O suporte ao conector do WhatsApp está em beta. Texto, fotos e documentos compatíveis com o gateway podem invocar o agente; mídia de entrada adicio… - [Configure um webhook do aplicativo WhatsApp (Beta)](https://docs.mka1.com/api-reference/agent-connectors/configure-um-webhook-do-aplicativo-whatsapp-beta.md): Beta. Retorna a URL de callback em nível de aplicativo e o token de verificação que devem ser salvos na Meta antes que o primeiro conector de telefone do WhatsApp seja criado. O chamador deve ter permissão para gerenciar o agente. O token de verificação estável é retornado apenas nesta resposta sem… - [Recuperar um conector](https://docs.mka1.com/api-reference/agent-connectors/recuperar-um-conector.md): Recupera a configuração e o status do conector sem expor credenciais. - [Excluir um conector](https://docs.mka1.com/api-reference/agent-connectors/excluir-um-conector.md): Cancela o webhook do provedor específico do conector e exclui as credenciais do conector armazenadas. As atualizações pendentes do Telegram são descartadas; a exclusão do WhatsApp remove apenas o callback do número de telefone e não cancela a assinatura de outros números na conta empresarial. Exclui… - [Ativar um conector](https://docs.mka1.com/api-reference/agent-connectors/ativar-um-conector.md): Revalida as credenciais de provedor armazenadas e registra o webhook do provedor. Use isso para tentar novamente um conector que tenha ficado em estado de erro. É necessária autenticação por chave de API com todos os escopos listados; autenticação por sessão é rejeitada, e a chave deve pertencer ao… #### Agent Schedules - [Listar horários para um agente](https://docs.mka1.com/api-reference/agent-schedules/listar-horários-para-um-agente.md) - [Criar um cronograma de agentes](https://docs.mka1.com/api-reference/agent-schedules/criar-um-cronograma-de-agentes.md): Cria um agendamento único, de intervalo ou cron com suporte temporal que inicia execuções normais de agentes salvos. - [Recuperar um cronograma de agente](https://docs.mka1.com/api-reference/agent-schedules/recuperar-um-cronograma-de-agente.md) - [Atualizar a programação de um agente](https://docs.mka1.com/api-reference/agent-schedules/atualizar-a-programação-de-um-agente.md) - [Excluir um cronograma de agente](https://docs.mka1.com/api-reference/agent-schedules/excluir-um-cronograma-de-agente.md) - [Pausar um agendamento de agente](https://docs.mka1.com/api-reference/agent-schedules/pausar-um-agendamento-de-agente.md) - [Retomar a programação de um agente](https://docs.mka1.com/api-reference/agent-schedules/retomar-a-programação-de-um-agente.md) #### Memory Stores - [Criar loja de memória](https://docs.mka1.com/api-reference/memory-stores/criar-loja-de-memória.md): Cria um armazenamento de memória para anotações persistentes do agente. Os armazenamentos são privados por padrão e podem ser compartilhados entre o espaço de trabalho. - [Lista de armazéns de memória](https://docs.mka1.com/api-reference/memory-stores/lista-de-armazéns-de-memória.md) - [Recuperar armazenamento de memória](https://docs.mka1.com/api-reference/memory-stores/recuperar-armazenamento-de-memória.md) - [Atualizar armazenamento de memória](https://docs.mka1.com/api-reference/memory-stores/atualizar-armazenamento-de-memória.md) - [Excluir armazenamento de memória](https://docs.mka1.com/api-reference/memory-stores/excluir-armazenamento-de-memória.md) - [Criar entrada de memória](https://docs.mka1.com/api-reference/memory-stores/criar-entrada-de-memória.md) - [Listar entradas de memória](https://docs.mka1.com/api-reference/memory-stores/listar-entradas-de-memória.md) - [Recuperar entrada de memória](https://docs.mka1.com/api-reference/memory-stores/recuperar-entrada-de-memória.md) - [Atualizar entrada de memória](https://docs.mka1.com/api-reference/memory-stores/atualizar-entrada-de-memória.md) - [Excluir entrada de memória](https://docs.mka1.com/api-reference/memory-stores/excluir-entrada-de-memória.md) ### Compute #### Compute Jobs - [Listar trabalhos](https://docs.mka1.com/api-reference/compute-jobs/listar-trabalhos.md) - [Criar uma vaga](https://docs.mka1.com/api-reference/compute-jobs/criar-uma-vaga.md) - [Conseguir um emprego](https://docs.mka1.com/api-reference/compute-jobs/conseguir-um-emprego.md) - [Listar eventos de trabalho](https://docs.mka1.com/api-reference/compute-jobs/listar-eventos-de-trabalho.md) - [Listar instâncias de trabalhos observadas](https://docs.mka1.com/api-reference/compute-jobs/listar-instâncias-de-trabalhos-observadas.md) - [Listar logs de trabalho](https://docs.mka1.com/api-reference/compute-jobs/listar-logs-de-trabalho.md) - [Finalizar uma tarefa](https://docs.mka1.com/api-reference/compute-jobs/finalizar-uma-tarefa.md) #### Compute Services - [Listar serviços](https://docs.mka1.com/api-reference/compute-services/listar-serviços.md) - [Criar um serviço](https://docs.mka1.com/api-reference/compute-services/criar-um-serviço.md) - [Obter um serviço](https://docs.mka1.com/api-reference/compute-services/obter-um-serviço.md) - [Listar eventos de serviço](https://docs.mka1.com/api-reference/compute-services/listar-eventos-de-serviço.md) - [Lista de instâncias de serviço observadas](https://docs.mka1.com/api-reference/compute-services/lista-de-instâncias-de-serviço-observadas.md) - [Listar logs de serviço](https://docs.mka1.com/api-reference/compute-services/listar-logs-de-serviço.md) - [Substituir uma política de dimensionamento de serviço](https://docs.mka1.com/api-reference/compute-services/substituir-uma-política-de-dimensionamento-de-serviço.md) - [Encerrar um serviço](https://docs.mka1.com/api-reference/compute-services/encerrar-um-serviço.md) #### Compute Catalog - [Lista de aceleradores](https://docs.mka1.com/api-reference/compute-catalog/lista-de-aceleradores.md) - [Obtenha um acelerador](https://docs.mka1.com/api-reference/compute-catalog/obtenha-um-acelerador.md) - [Listar ofertas de provedores](https://docs.mka1.com/api-reference/compute-catalog/listar-ofertas-de-provedores.md): Administradores de cluster podem sempre ler esta rota. Administradores da organização podem lê-la apenas quando o anonimato do provedor está desativado. - [Listar saúde do provedor](https://docs.mka1.com/api-reference/compute-catalog/listar-saúde-do-provedor.md): Administradores de cluster podem sempre ler esta rota. Administradores da organização podem lê-la apenas quando o anonimato do provedor está desativado. - [Criar uma cotação](https://docs.mka1.com/api-reference/compute-catalog/criar-uma-cotação.md) #### Compute Secrets - [Listar segredos](https://docs.mka1.com/api-reference/compute-secrets/listar-segredos.md) - [Criar um segredo](https://docs.mka1.com/api-reference/compute-secrets/criar-um-segredo.md) - [Excluir um segredo](https://docs.mka1.com/api-reference/compute-secrets/excluir-um-segredo.md) - [Obter um segredo](https://docs.mka1.com/api-reference/compute-secrets/obter-um-segredo.md) - [Girar um segredo](https://docs.mka1.com/api-reference/compute-secrets/girar-um-segredo.md): Substitui cada valor do segredo sob o mesmo ID e incrementa sua versão. Recursos que o referenciam leem os novos valores em sua próxima inicialização, nova tentativa ou reinicialização; cargas de trabalho em execução mantêm os valores com os quais foram iniciadas. As novas chaves devem incluir todas… #### Compute Volumes - [Listar volumes da organização](https://docs.mka1.com/api-reference/compute-volumes/listar-volumes-da-organização.md): Lista os volumes da organização, do mais recente para o mais antigo. Volumes excluídos são omitidos, a menos que `status` seja `deleted`; um volume excluído também continua legível pelo id. - [Crie um volume compartilhado independente](https://docs.mka1.com/api-reference/compute-volumes/crie-um-volume-compartilhado-independente.md) - [Excluir permanentemente um volume independente](https://docs.mka1.com/api-reference/compute-volumes/excluir-permanentemente-um-volume-independente.md): A exclusão ignora a habilitação do tenant e as barreiras de orçamento, mas é recusada enquanto existirem anexos não terminais. - [Obtenha um volume independente](https://docs.mka1.com/api-reference/compute-volumes/obtenha-um-volume-independente.md) - [Listar anexos de volume](https://docs.mka1.com/api-reference/compute-volumes/listar-anexos-de-volume.md) #### Compute Usage - [Obter uso](https://docs.mka1.com/api-reference/compute-usage/obter-uso.md) #### Compute Tenants - [Listar inquilinos](https://docs.mka1.com/api-reference/compute-tenants/listar-inquilinos.md): Somente administrador do cluster. - [Obter um locatário](https://docs.mka1.com/api-reference/compute-tenants/obter-um-locatário.md): Somente administrador do cluster. - [Atualizar um inquilino](https://docs.mka1.com/api-reference/compute-tenants/atualizar-um-inquilino.md): Upsert idempotente apenas para administrador do cluster. #### Compute Pricing - [Obtenha o preço de armazenamento contratado mais recente](https://docs.mka1.com/api-reference/compute-pricing/obtenha-o-preço-de-armazenamento-contratado-mais-recente.md): A versão mais recente pode estar agendada para a próxima hora UTC. Antes de a primeira versão ser gravada, esta rota retorna pricing_not_configured. - [Criar uma versão imutável do preço de armazenamento](https://docs.mka1.com/api-reference/compute-pricing/criar-uma-versão-imutável-do-preço-de-armazenamento.md): Somente administradores do cluster. If-Match: 0 executa o bootstrap explícito. Cada versão é ativada no próximo limite de hora UTC; a repetição idempotente equivalente precede a comparação de versões. #### Tracking Experiments - [Criar](https://docs.mka1.com/api-reference/tracking-experiments/criar.md): Crie um experimento com namespace. As localizações dos artefatos são gerenciadas pelo serviço. Requer `write:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [Buscar](https://docs.mka1.com/api-reference/tracking-experiments/buscar.md): Requiere `read:tracking`. Los resultados están restringidos a la organización y el equipo de la clave de API. - [Obter](https://docs.mka1.com/api-reference/tracking-experiments/obter.md): Requer `read:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [ObterPorNome](https://docs.mka1.com/api-reference/tracking-experiments/obterpornome.md): Requer `read:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [Excluir](https://docs.mka1.com/api-reference/tracking-experiments/excluir.md): Requer `write:tracking`. Os resultados são restritos à organização e à equipe da chave de API. #### Tracking Runs - [Criar](https://docs.mka1.com/api-reference/tracking-runs/criar.md): Requer `write:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [Obter](https://docs.mka1.com/api-reference/tracking-runs/obter.md): Requer `read:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [Buscar](https://docs.mka1.com/api-reference/tracking-runs/buscar.md): Se requieren IDs de experimento explícitos; cada experimento debe pertenecer al llamador. Requiere `read:tracking`. Los resultados están restringidos a la organización y al equipo de la clave de API. - [Atualização](https://docs.mka1.com/api-reference/tracking-runs/atualização.md): Requer `write:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [Excluir](https://docs.mka1.com/api-reference/tracking-runs/excluir.md): Requer `write:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [Restaurar](https://docs.mka1.com/api-reference/tracking-runs/restaurar.md): Requiere `write:tracking`. Los resultados están restringidos a la organización y al equipo de la clave de API. - [LogMetric](https://docs.mka1.com/api-reference/tracking-runs/logmetric.md): Requiere `write:tracking`. Los resultados están restringidos a la organización y al equipo de la clave de API. - [Parâmetro de log](https://docs.mka1.com/api-reference/tracking-runs/parâmetro-de-log.md): Requer `write:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [DefinirTag](https://docs.mka1.com/api-reference/tracking-runs/definirtag.md): Requer `write:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [ExcluirTag](https://docs.mka1.com/api-reference/tracking-runs/excluirtag.md): Requer `write:tracking`. Os resultados são restritos à organização e à equipe da chave de API. - [LogBatch](https://docs.mka1.com/api-reference/tracking-runs/logbatch.md): Requires `write:tracking`. Results are restricted to the API key organization and team. - [LogInputs](https://docs.mka1.com/api-reference/tracking-runs/loginputs.md): Requires `write:tracking`. Results are restricted to the API key organization and team. - [ObterHistóricoDeMétricas](https://docs.mka1.com/api-reference/tracking-runs/obterhistóricodemétricas.md): Requer `read:tracking`. Os resultados são restritos à organização e à equipe da chave de API. ### Repositories #### Repositories - [Liste os repositórios da organização do chamador](https://docs.mka1.com/api-reference/repositories/liste-os-repositórios-da-organização-do-chamador.md): Retorna todos os repositórios da organização do chamador (apenas para proprietário/admin da organização). Somente leitura. Com `kind`, apenas repositórios desse tipo; um repositório sem tipo (legado, `kind: null`) aparece na listagem sem filtro apenas. - [Criar um repositório](https://docs.mka1.com/api-reference/repositories/criar-um-repositório.md): Provisiona um repositório (apenas proprietário/admin da organização); uma provisionamento com falha é revertido da melhor forma possível (veja o `502`). O repositório pertence à organização do chamador. `kind` indica o que ele conterá e, por padrão, é `repo` (um repositório git simples); ele decide… - [Excluir um repositório](https://docs.mka1.com/api-reference/repositories/excluir-um-repositório.md): Remove um repositório; somente proprietário/admin da organização. A exclusão é autoritativa; o conteúdo é limpo da melhor forma possível. - [Obter um repositório](https://docs.mka1.com/api-reference/repositories/obter-um-repositório.md): Lê um único repositório após a verificação de acesso por org+função (apenas proprietário/admin da org do repositório). - [Atualizar os rótulos de um repositório](https://docs.mka1.com/api-reference/repositories/atualizar-os-rótulos-de-um-repositório.md): Aplica uma atualização somente de rótulo (nome/descrição/tipo); apenas proprietário/admin da organização. O ID do repositório é estável, então uma renomeação não afeta nenhum conteúdo. Os campos omitidos permanecem inalterados. #### Image tags - [Liste as tags de um repositório de imagens](https://docs.mka1.com/api-reference/repositories/liste-as-tags-de-um-repositório-de-imagens.md): Lista as tags de imagens de contêiner que um repositório contém, mais recentes movidas primeiro, cada uma com o manifesto ao qual aponta, o tipo de mídia do manifesto, o tamanho declarado da imagem e quando a tag foi movida pela última vez. A mesma verificação de acesso usada para ler o repositório… - [Excluir uma tag de imagem](https://docs.mka1.com/api-reference/repositories/excluir-uma-tag-de-imagem.md): Remove uma tag; somente o proprietário/admin da organização (`write:repos` para uma chave). O mesmo desassociar da tag que o `DELETE /v2/{org}/{name}/manifests/{tag}` do registry: o nome desaparece e a imagem permanece, acessível pelo digest e por qualquer outra tag que a referencie. ### Dataset generations #### Gerações - [Lista de gerações](https://docs.mka1.com/api-reference/generations/lista-de-gerações.md) - [Criar Geração](https://docs.mka1.com/api-reference/generations/criar-geração.md): A sequência de components.md §6 D.1, em sua ordem: uma credencial é emitida antes de qualquer coisa ser gasta e revogada antes de a resposta sair, nada é escrito antes de o digest ser fixado, e o fluxo de trabalho só começa depois que a linha é confirmada. - [Obter geração](https://docs.mka1.com/api-reference/generations/obter-geração.md) - [Obter Logs](https://docs.mka1.com/api-reference/generations/obter-logs.md) - [Obter eventos](https://docs.mka1.com/api-reference/generations/obter-eventos.md) - [Cancelar geração](https://docs.mka1.com/api-reference/generations/cancelar-geração.md): api.md §3: `cancelling` é escrito aqui, então o sinal; uma linha `cancelling` cujo sinal foi perdido (o caso de nova tentativa) é sinalizada novamente. #### Geradores - [Geradores de Lista](https://docs.mka1.com/api-reference/generators/geradores-de-lista.md) - [Obter gerador](https://docs.mka1.com/api-reference/generators/obter-gerador.md) - [Gerador de Citações](https://docs.mka1.com/api-reference/generators/gerador-de-citações.md) #### Formatos - [Formatos de lista](https://docs.mka1.com/api-reference/formats/formatos-de-lista.md) - [Obter formato](https://docs.mka1.com/api-reference/formats/obter-formato.md) ### Usage and budgets #### Usage - [Obter uso de completions](https://docs.mka1.com/api-reference/usage/obter-uso-de-completions.md): Recupere métricas de uso para conclusões de chat, agregadas da tabela ChatCompletion. - [Obter uso de respostas](https://docs.mka1.com/api-reference/usage/obter-uso-de-respostas.md): Recuperar métricas de uso para as respostas dos agentes, agregadas da tabela de Respostas. - [Obter uso de conversas](https://docs.mka1.com/api-reference/usage/obter-uso-de-conversas.md): Recuperar métricas de uso para operações de conversa. - [Obter uso de embeddings](https://docs.mka1.com/api-reference/usage/obter-uso-de-embeddings.md): Recuperar métricas de uso para operações de incorporação. - [Obter uso de rerank](https://docs.mka1.com/api-reference/usage/obter-uso-de-rerank.md): Recuperar métricas de uso para chamadas de rerank feitas por buscas em armazenamentos vetoriais (o `ranker`). - [Obter uso de extrato](https://docs.mka1.com/api-reference/usage/obter-uso-de-extrato.md): Recuperar métricas de uso para operações de extração. - [Obter uso de classificação](https://docs.mka1.com/api-reference/usage/obter-uso-de-classificação.md): Recupere métricas de uso para operações de classificação. - [Obter uso de armazéns de vetores](https://docs.mka1.com/api-reference/usage/obter-uso-de-armazéns-de-vetores.md): Recupere métricas de uso para operações de armazenamento vetorial. - [Obter uso de arquivos](https://docs.mka1.com/api-reference/usage/obter-uso-de-arquivos.md): Recupere bytes de arquivos criados por período a partir de eventos de criação de arquivos duráveis. Isso não reflete o armazenamento retido atual, os buckets continuam contados após a exclusão de arquivos, e os resultados agrupados são colapsados pelas dimensões de saída solicitadas em vez de uma li… - [Obter custo por modelo](https://docs.mka1.com/api-reference/usage/obter-custo-por-modelo.md): Agrega o gasto por modelo ao longo de um intervalo de tempo, precificado na moeda do cluster a partir da tabela de preços do modelo. Com escopo de organização: administradores da org veem sua própria org; administradores do cluster podem passar `org_id`. Inclui trabalho faturável sem uma linha de us… - [Custo agregado por dimensão](https://docs.mka1.com/api-reference/usage/custo-agregado-por-dimensão.md): Soma o custo por entrada armazenado ao longo de [start_time, end_time), agrupado por qualquer um de service, task_type, model, api_key_id, team_id, user_id, external_user_id, org_id. Correto no ponto no tempo para chargeback/showback. #### Budgets - [Listar orçamentos](https://docs.mka1.com/api-reference/budgets/listar-orçamentos.md): Admins de cluster veem todos os orçamentos; administradores da organização veem os orçamentos da sua organização (incluindo orçamentos de membros e orçamentos padrão por membro) além dos orçamentos nas chaves de API da sua organização. - [Listar orçamentos organizacionais](https://docs.mka1.com/api-reference/budgets/listar-orçamentos-organizacionais.md): Retorna os orçamentos da organização (orçamento próprio e/ou teto) com o indicador de gasto em tempo real de cada um. Direciona-se à própria organização do solicitante (inferida da chave de API ou da sessão), a menos que o parâmetro de consulta opcional org_id especifique outra organização — apenas… - [Definir um orçamento da organização](https://docs.mka1.com/api-reference/budgets/definir-um-orçamento-da-organização.md): Cria ou atualiza um orçamento para a organização. Um orçamento por (escopo, proprietário); a edição reavalia em relação aos gastos em tempo real. Aplica-se à própria organização do solicitante (inferida a partir da chave de API ou da sessão), a menos que o parâmetro opcional de consulta org_id espec… - [Excluir um orçamento da organização](https://docs.mka1.com/api-reference/budgets/excluir-um-orçamento-da-organização.md): Remove o orçamento da organização para o proprietário informado; a aplicação e os alertas são interrompidos. Destina-se à própria organização do chamador (inferida a partir da chave de API ou da sessão), a menos que o parâmetro de consulta opcional org_id informe outra organização — apenas administr… - [Listar eventos orçamentários da organização](https://docs.mka1.com/api-reference/budgets/listar-eventos-orçamentários-da-organização.md): Retorna eventos recentes de alerta de limite e bloqueio para os orçamentos da organização. Destina-se à própria organização do solicitante (inferida da chave da API ou da sessão), a menos que o parâmetro opcional de consulta org_id especifique outra organização — apenas administradores de cluster. - [Listar orçamentos de apikey](https://docs.mka1.com/api-reference/budgets/listar-orçamentos-de-apikey.md): Retorna os orçamentos da chave de API (orçamento próprio e/ou teto) com o indicador de gasto em tempo real de cada um. Chamável por administradores do cluster, ou por administradores da organização para chaves de API em sua própria organização. - [Definir um orçamento de chave de API](https://docs.mka1.com/api-reference/budgets/definir-um-orçamento-de-chave-de-api.md): Cria ou atualiza um orçamento para a chave de API. Um orçamento por (escopo, proprietário); a edição reavalia com base no gasto em tempo real. Chamável por administradores do cluster, ou administradores da organização para chaves de API em sua própria organização. - [Excluir um orçamento de chave de API](https://docs.mka1.com/api-reference/budgets/excluir-um-orçamento-de-chave-de-api.md): Remove o orçamento da apikey do proprietário informado; a aplicação e os alertas são interrompidos. Pode ser chamado por administradores do cluster ou administradores da organização para chaves de API na sua própria organização. - [Liste eventos de orçamento da chave de API](https://docs.mka1.com/api-reference/budgets/liste-eventos-de-orçamento-da-chave-de-api.md): Retorna eventos recentes de alerta de limite e bloqueio para os orçamentos da chave de API. Chamável por administradores de cluster ou administradores da organização para chaves de API em sua própria organização. - [Listar orçamentos do usuário](https://docs.mka1.com/api-reference/budgets/listar-orçamentos-do-usuário.md): Retorna os orçamentos do usuário na organização de destino (orçamento próprio e/ou teto) com o indicador de gasto em tempo real de cada um. Destina-se à própria organização do solicitante (inferida a partir da chave de API ou da sessão), a menos que o parâmetro de consulta opcional org_id especifiqu… - [Definir um orçamento do usuário](https://docs.mka1.com/api-reference/budgets/definir-um-orçamento-do-usuário.md): Cria ou atualiza um orçamento para o usuário na organização de destino. Um orçamento por (escopo, proprietário); a edição reavalia com base nos gastos em tempo real. Um orçamento explícito do usuário substitui o orçamento padrão por usuário da organização, com o mesmo proprietário e período, para es… - [Excluir um orçamento de usuário](https://docs.mka1.com/api-reference/budgets/excluir-um-orçamento-de-usuário.md): Remove o orçamento do usuário para o proprietário fornecido; o orçamento padrão por usuário da organização (se houver) volta a se aplicar a ele. Destina-se à própria organização do chamador (inferida da chave de API ou da sessão), a menos que o parâmetro de consulta opcional org_id nomeie outra orga… - [Listar eventos de orçamento do usuário](https://docs.mka1.com/api-reference/budgets/listar-eventos-de-orçamento-do-usuário.md): Retorna os eventos recentes de alerta de limite e de bloqueio para os orçamentos do usuário na organização de destino. Tem como alvo a própria organização do chamador (inferida a partir da chave de API ou da sessão), a menos que o parâmetro de consulta opcional org_id informe outra organização — ape… - [Listar orçamentos da equipe](https://docs.mka1.com/api-reference/budgets/listar-orçamentos-da-equipe.md): Retorna os orçamentos da equipe na organização de destino (orçamento próprio e/ou teto) com o indicador de gasto ao vivo de cada um. Aponta para a própria organização do solicitante (inferida a partir da chave de API ou da sessão), a menos que o parâmetro de consulta opcional org_id informe outra or… - [Definir um orçamento da equipe](https://docs.mka1.com/api-reference/budgets/definir-um-orçamento-da-equipe.md): Cria ou atualiza um orçamento para a equipe na organização de destino. Um orçamento por (escopo, proprietário); a edição reavalia com base no gasto em tempo real. Um orçamento explícito de equipe substitui o orçamento padrão por equipe da organização com o mesmo proprietário e período para essa equi… - [Excluir um orçamento da equipe](https://docs.mka1.com/api-reference/budgets/excluir-um-orçamento-da-equipe.md): Remove o orçamento da equipe para o proprietário especificado; o orçamento padrão por equipe da organização (se houver) volta a se aplicar a ele. Tem como alvo a própria organização do chamador (inferida da chave de API ou da sessão), a menos que o parâmetro de consulta opcional org_id informe outra… - [Listar eventos do orçamento da equipe](https://docs.mka1.com/api-reference/budgets/listar-eventos-do-orçamento-da-equipe.md): Retorna os eventos recentes de alerta de limite e bloqueio para os orçamentos da equipe na organização de destino. Destina-se à própria organização do chamador (inferida a partir da chave de API ou da sessão), a menos que o parâmetro de consulta opcional org_id especifique outra organização — apenas… - [Listar orçamentos de usuários externos](https://docs.mka1.com/api-reference/budgets/listar-orçamentos-de-usuários-externos.md): Retorna os orçamentos do usuário externo na organização de destino (autoorçamento e/ou limite) com o indicador de gasto em tempo real de cada um. Direciona-se à própria organização do chamador (inferida a partir da chave de API ou da sessão), a menos que o parâmetro de consulta opcional org_id nomei… - [Definir um orçamento externo do usuário](https://docs.mka1.com/api-reference/budgets/definir-um-orçamento-externo-do-usuário.md): Cria ou atualiza um orçamento para o usuário externo na organização de destino. Um orçamento por (escopo, proprietário); a edição reavalia em relação ao gasto em tempo real. Um orçamento explícito de usuário externo substitui o orçamento padrão da organização por usuário externo com o mesmo propriet… - [Excluir um orçamento de usuário externo](https://docs.mka1.com/api-reference/budgets/excluir-um-orçamento-de-usuário-externo.md): Remove o orçamento do usuário externo para o proprietário informado; o orçamento padrão por usuário externo da organização (se houver) volta a ser aplicado a ele. Tem como alvo a própria organização do chamador (inferida da chave de API ou da sessão), a menos que o parâmetro opcional de consulta org… - [Listar eventos de orçamento de usuários externos](https://docs.mka1.com/api-reference/budgets/listar-eventos-de-orçamento-de-usuários-externos.md): Retorna eventos recentes de alerta de limite e de bloqueio para os orçamentos do usuário externo na organização de destino. Tem como alvo a própria organização do solicitante (inferida a partir da chave de API ou da sessão), a menos que o parâmetro opcional de consulta org_id especifique outra organ… - [Listar orçamentos padrão por usuário](https://docs.mka1.com/api-reference/budgets/listar-orçamentos-padrão-por-usuário.md): Retorna os orçamentos padrão por usuário da organização (definidos pelo próprio usuário e/ou teto definido pelo operador). Um orçamento padrão se aplica a todos os usuários da organização em relação ao próprio contador de gastos de cada usuário, a menos que exista para eles um orçamento explícito do… - [Definir um orçamento padrão por usuário](https://docs.mka1.com/api-reference/budgets/definir-um-orçamento-padrão-por-usuário.md): Cria ou atualiza o orçamento padrão por usuário da organização: um limite aplicado a CADA usuário da organização individualmente (não em conjunto), a menos que exista para ele um orçamento de usuário explícito com o mesmo proprietário e período. Alertas de limite e bloqueios são acionados por usuári… - [Excluir um orçamento padrão por usuário](https://docs.mka1.com/api-reference/budgets/excluir-um-orçamento-padrão-por-usuário.md): Remove o orçamento padrão por usuário da organização para o proprietário informado; apenas os orçamentos explícitos do usuário permanecem. Destina-se à própria organização do chamador (inferida pela chave da API ou pela sessão), a menos que o parâmetro opcional de consulta org_id nomeie outra organi… - [Listar eventos de orçamento padrão por usuário](https://docs.mka1.com/api-reference/budgets/listar-eventos-de-orçamento-padrão-por-usuário.md): Retorna eventos recentes de alerta de limite e de bloqueio para os orçamentos padrão por usuário da organização. O target_id de cada evento indica o usuário para o qual ele foi acionado. Destina-se à própria organização do solicitante (inferida pela chave de API ou sessão), a menos que o parâmetro o… - [Lista de orçamentos padrão por equipe](https://docs.mka1.com/api-reference/budgets/lista-de-orçamentos-padrão-por-equipe.md): Retorna os orçamentos padrão por equipe da organização (definidos pela própria equipe e/ou teto do operador). Um orçamento padrão se aplica a todas as equipes da organização em relação ao próprio contador de gastos de cada equipe, a menos que exista um orçamento explícito da equipe com o mesmo propr… - [Defina um orçamento padrão por equipe](https://docs.mka1.com/api-reference/budgets/defina-um-orçamento-padrão-por-equipe.md): Cria ou atualiza o orçamento padrão por equipe da organização: um limite aplicado a CADA equipe na organização individualmente (não em conjunto), a menos que exista para ela um orçamento explícito da mesma titularidade e período. Alertas de limite e bloqueios são acionados por equipe. Destina-se à o… - [Excluir um orçamento padrão por equipe](https://docs.mka1.com/api-reference/budgets/excluir-um-orçamento-padrão-por-equipe.md): Remove o orçamento padrão por equipe da organização para o proprietário informado; apenas os orçamentos explícitos das equipes permanecem. Tem como alvo a própria organização do solicitante (inferida da chave de API ou da sessão), a menos que o parâmetro de consulta opcional org_id especifique outra… - [Listar eventos de orçamento padrão por equipe](https://docs.mka1.com/api-reference/budgets/listar-eventos-de-orçamento-padrão-por-equipe.md): Retorna os eventos recentes de alerta de limite e bloqueio dos orçamentos padrão por equipe da organização. O target_id de cada evento indica o time para o qual ele foi acionado. Direciona-se à própria organização do solicitante (inferida pela chave da API ou pela sessão), a menos que o parâmetro de… - [Liste os orçamentos padrão por usuário externo](https://docs.mka1.com/api-reference/budgets/liste-os-orçamentos-padrão-por-usuário-externo.md): Retorna os orçamentos padrão por usuário externo da organização (definidos pelo próprio usuário e/ou teto do operador). Um orçamento padrão se aplica a todos os usuários externos da organização em relação ao próprio contador de gastos desse usuário externo, a menos que exista para eles um orçamento… - [Definir um orçamento padrão por usuário externo](https://docs.mka1.com/api-reference/budgets/definir-um-orçamento-padrão-por-usuário-externo.md): Cria ou atualiza o orçamento padrão por usuário externo da organização: um limite aplicado a CADA usuário externo na organização individualmente (não em conjunto), a menos que exista para ele um orçamento explícito de usuário externo com o mesmo proprietário e período. Alertas de limite e bloqueios… - [Excluir um orçamento padrão por usuário externo](https://docs.mka1.com/api-reference/budgets/excluir-um-orçamento-padrão-por-usuário-externo.md): Remove o orçamento padrão por usuário externo da organização para o proprietário informado; apenas os orçamentos explícitos de usuários externos permanecem. Aplica-se à própria organização do chamador (inferida pela chave de API ou sessão), a menos que o parâmetro de consulta opcional org_id especif… - [Listar eventos padrão de orçamento por usuário externo](https://docs.mka1.com/api-reference/budgets/listar-eventos-padrão-de-orçamento-por-usuário-externo.md): Retorna os eventos recentes de alerta de limite e bloqueio para os orçamentos padrão por usuário externo da organização. O target_id de cada evento nomeia o usuário externo para o qual ele foi disparado. Destina-se à própria organização do solicitante (inferida da chave da API ou da sessão), a menos… #### Settings - [Obter moeda de exibição](https://docs.mka1.com/api-reference/settings/obter-moeda-de-exibição.md) - [Definir moeda de exibição](https://docs.mka1.com/api-reference/settings/definir-moeda-de-exibição.md): Código ISO 4217 usado para exibição em orçamentos e relatórios de custos. Nenhuma conversão é realizada em lugar nenhum. ### Application utilities #### Batches - [Criar um lote](https://docs.mka1.com/api-reference/batches/criar-um-lote.md): Cria e executa um lote a partir de um arquivo JSONL enviado contendo requisições. Cada linha deve ter os campos custom_id, method, url e body. Lotes de texto também exigem write:responses. - [Listar lotes](https://docs.mka1.com/api-reference/batches/listar-lotes.md): Devuelve una lista paginada de lotes propiedad del usuario autenticado. - [Obter um lote](https://docs.mka1.com/api-reference/batches/obter-um-lote.md): Recupera um lote pelo seu ID. - [Cancelar um lote](https://docs.mka1.com/api-reference/batches/cancelar-um-lote.md): Cancela um lote em andamento. O status do lote muda para cancelando, e as solicitações restantes não serão processadas. #### Extract - [Extrair dados estruturados com JSON Schema embutido](https://docs.mka1.com/api-reference/extract/extrair-dados-estruturados-com-json-schema-embutido.md): Extrai dados estruturados de arquivos usando um esquema JSON inline personalizado. - [Criar modelo de esquema de extração reutilizável](https://docs.mka1.com/api-reference/extract/criar-modelo-de-esquema-de-extração-reutilizável.md): Cria e armazena um modelo de esquema JSON reutilizável para extração de dados estruturados. - [Obter esquema de extração por ID](https://docs.mka1.com/api-reference/extract/obter-esquema-de-extração-por-id.md): Recupere um esquema de extração armazenado e seus metadados. - [Atualizar esquema de extração por ID](https://docs.mka1.com/api-reference/extract/atualizar-esquema-de-extração-por-id.md): Atualizar um esquema de extração existente e seus metadados. - [Excluir o esquema de extração pelo ID](https://docs.mka1.com/api-reference/extract/excluir-o-esquema-de-extração-pelo-id.md): Remover um esquema de extração armazenado. - [Extrair dados usando o modelo de esquema salvo](https://docs.mka1.com/api-reference/extract/extrair-dados-usando-o-modelo-de-esquema-salvo.md): Extrai dados estruturados de arquivos usando um modelo de esquema de extração previamente salvo. #### Guardrails - [Obtenha guardrails eficazes](https://docs.mka1.com/api-reference/guardrails/obtenha-guardrails-eficazes.md): Recupere as regras de proteção que se aplicam às solicitações do chamador. guardrails contém a política de toda a organização seguida pela política da equipe do chamador; cluster_default lista as regras padrão do cluster aplicadas abaixo delas, sem a configuração. Todas são aplicadas. As políticas s… - [Atualizar política de diretrizes](https://docs.mka1.com/api-reference/guardrails/atualizar-política-de-diretrizes.md): Substitua uma política de guardrails. Os modelos classificadores devem estar ativos e declarar suporte a saída estruturada; substitua o ID do modelo de exemplo por um modelo adequado da sua organização. Omita team_id para definir a política em toda a organização (somente admin da organização); forne… - [Excluir política de diretrizes](https://docs.mka1.com/api-reference/guardrails/excluir-política-de-diretrizes.md): Excluir uma política de guardrails. Omitir team_id para excluir a política de toda a organização (somente admin da organização); fornecer team_id para excluir a política dessa equipe (admins da organização podem direcionar qualquer equipe em sua organização, outros chamadores apenas sua própria equi… - [Listar políticas de guardrail](https://docs.mka1.com/api-reference/guardrails/listar-políticas-de-guardrail.md): Liste as políticas de guardrails armazenadas visíveis ao chamador: administradores da organização veem todas as políticas em sua organização (a política em nível da organização tem team_id null, além da política adicional de cada equipe); outros chamadores veem a política em nível da organização e a… - [Teste de conteúdo contra barreiras de proteção](https://docs.mka1.com/api-reference/guardrails/teste-de-conteúdo-contra-barreiras-de-proteção.md): Teste um trecho de conteúdo em relação aos guardrails efetivos do chamador (padrão do cluster, política de toda a organização e política da equipe) sem gerar uma resposta. Os guardrails de classificador chamam o modelo configurado e incorrem em uso de inferência, portanto as chaves de API também exi… - [Obter os guardrails padrão do cluster](https://docs.mka1.com/api-reference/guardrails/obter-os-guardrails-padrão-do-cluster.md): Visão do operador de cluster dos guardrails padrão aplicados abaixo das políticas da organização e da equipe de todas as organizações inscritas. Até que um operador salve um, o padrão integrado é aplicado: ativado, sem regras, então nada é aplicado. - [Atualizar as proteções padrão do cluster](https://docs.mka1.com/api-reference/guardrails/atualizar-as-proteções-padrão-do-cluster.md): Substitua as proteções padrão aplicadas a todas as organizações inscritas e ative-as ou desative-as para todo o cluster. Os administradores da organização podem adicionar regras além do padrão do cluster, mas não podem enfraquecê-lo ou removê-lo. Os modelos classificadores devem estar ativos no regi… - [Redefinir as proteções padrão do cluster](https://docs.mka1.com/api-reference/guardrails/redefinir-as-proteções-padrão-do-cluster.md): Exclua o cluster padrão salvo para que o padrão integrado volte a ser aplicado: ativado, sem regras, então nada é imposto. Para parar de impor um cluster padrão, atualize-o definindo enabled como false em vez disso. - [Obter o registro padrão do cluster de uma organização](https://docs.mka1.com/api-reference/guardrails/obter-o-registro-padrão-do-cluster-de-uma-organização.md): Se uma organização está inscrita nas diretrizes padrão do cluster e se elas estão sendo aplicadas a ela agora. Organizações criadas antes de o padrão do cluster existir não são inscritas até que um administrador do cluster as inscreva. - [Inscrever uma organização no cluster padrão](https://docs.mka1.com/api-reference/guardrails/inscrever-uma-organização-no-cluster-padrão.md): Inscreva uma organização nas guardrails padrão do cluster, ou remova-a. Idempotente. Organizações inscritas são verificadas em relação ao padrão do cluster sempre que a opção do cluster estiver ativada. - [Obtenha uma política de guardrails de recurso](https://docs.mka1.com/api-reference/guardrails/obtenha-uma-política-de-guardrails-de-recurso.md): Guardrails adicionais anexados a um agente salvo na equipe ativa ou a um endpoint de modelo de catálogo em toda a organização. As políticas de cluster, organização e equipe também são sempre aplicadas. Os aliases de modelo são resolvidos para IDs canônicos de modelo; auto não é um endpoint que possa… - [Definir uma política de guardrails de recursos](https://docs.mka1.com/api-reference/guardrails/definir-uma-política-de-guardrails-de-recursos.md): Guardrails adicionais anexados a um agente salvo na equipe ativa ou a um endpoint de modelo de catálogo em toda a organização. As políticas de cluster, organização e equipe também são sempre aplicadas. Os aliases de modelo são resolvidos para IDs canônicos de modelo; auto não é um endpoint que possa… - [Remover uma política de proteções de recursos](https://docs.mka1.com/api-reference/guardrails/remover-uma-política-de-proteções-de-recursos.md): Guardrails adicionais anexados a um agente salvo na equipe ativa ou a um endpoint de modelo de catálogo em toda a organização. As políticas de cluster, organização e equipe também são sempre aplicadas. Os aliases de modelo são resolvidos para IDs canônicos de modelo; auto não é um endpoint que possa… #### Prompts - [Crie um prompt](https://docs.mka1.com/api-reference/prompts/crie-um-prompt.md): Cria um novo prompt com sua primeira versão. O modelo suporta espaços reservados {{variável}}. - [Listar solicitações](https://docs.mka1.com/api-reference/prompts/listar-solicitações.md): Retorna uma lista paginada de prompts pertencentes ao usuário autenticado. - [Obter um prompt](https://docs.mka1.com/api-reference/prompts/obter-um-prompt.md): Recupera um prompt pelo seu ID, incluindo o modelo ativo. Passe `version` para obter o modelo de uma versão específica. Passe `variables` como um mapa codificado em JSON para renderizar o modelo com substituições. - [Atualizar um prompt](https://docs.mka1.com/api-reference/prompts/atualizar-um-prompt.md): Atualiza os metadados do prompt. Para atualizar o conteúdo do modelo, crie uma nova versão em vez disso. - [Excluir um prompt](https://docs.mka1.com/api-reference/prompts/excluir-um-prompt.md): Remove um prompt e todas as suas versões. - [Criar uma nova versão](https://docs.mka1.com/api-reference/prompts/criar-uma-nova-versão.md): Cria uma nova versão de um prompt. A nova versão automaticamente se torna a versão ativa. Os campos não fornecidos são mantidos da versão anterior. - [Listar versões](https://docs.mka1.com/api-reference/prompts/listar-versões.md): Retorna o histórico de versões de um prompt, ordenado pelo número da versão. - [Obter uma versão específica](https://docs.mka1.com/api-reference/prompts/obter-uma-versão-específica.md): Recupera uma versão específica de um prompt pelo número da versão. - [Reverter para uma versão](https://docs.mka1.com/api-reference/prompts/reverter-para-uma-versão.md): Define a versão ativa de um prompt para uma versão anterior. Isso não exclui versões mais recentes — apenas altera qual versão está ativa. ### Analytics #### Projetos - [Create a project](https://docs.mka1.com/api-reference/analyticsprojects/criar-um-projeto-de-análise.md): Crie um projeto na organização do chamador. Sem team_id, o projeto pertence à equipe autenticada. Proprietários e administradores da organização podem criar um projeto para qualquer equipe em sua organização, incluindo equipes das quais não sejam membros, ou passar team_id: null para um projeto no n… - [List projects](https://docs.mka1.com/api-reference/analyticsprojects/listar-projetos-de-análise-acessíveis.md): Proprietários e administradores da organização veem todos os projetos na sua organização: todos os projetos das equipes e os projetos no nível da organização, independentemente da equipe ativa. Isso também se aplica às chaves de API e aos JWTs trocados de um proprietário ou administrador, independen… - [Get a project](https://docs.mka1.com/api-reference/analyticsprojects/obter-um-projeto-de-análise.md) - [Update a project](https://docs.mka1.com/api-reference/analyticsprojects/renomear-um-projeto-de-análise-ativo.md): Renomeie um projeto ativo. A propriedade do projeto não pode ser alterada. - [Archive a project](https://docs.mka1.com/api-reference/analyticsprojects/arquivar-um-projeto-de-análises.md): Interrompa novas capturas e consultas para este projeto. Eventos aceitos anteriormente continuam sendo processados. O arquivamento não exclui os eventos armazenados. #### Chaves de captura - [Create a capture key](https://docs.mka1.com/api-reference/analyticskeys/criar-uma-chave-de-captura-e-retornar-seu-segredo-uma-única-vez.md): Crie uma chave que possa enviar eventos para este projeto. Salve a chave desta resposta; o segredo dela é retornado apenas uma vez. Chaves de captura não podem ler analytics nem gerenciar projetos. - [List capture keys](https://docs.mka1.com/api-reference/analyticskeys/listar-metadados-principais-de-captura.md) - [Revoke a capture key](https://docs.mka1.com/api-reference/analyticskeys/revogar-uma-chave-de-captura.md) #### Eventos - [Capture events](https://docs.mka1.com/api-reference/analytics/aceitar-permanentemente-um-lote-de-eventos.md): Envie um lote de eventos usando o cabeçalho X-Analytics-Key do projeto. Uma resposta 202 confirma que o lote foi armazenado; os eventos ficam disponíveis para consultas após o processamento em segundo plano. Tente novamente com a mesma idempotency_key e os eventos inalterados se você não receber uma… - [Query events](https://docs.mka1.com/api-reference/analytics/consultar-contagens-de-eventos-ou-visitantes-únicos.md): Conte eventos ou visitantes únicos em um intervalo de tempo. Opcionalmente, filtre por nome do evento ou propriedades, agrupe por uma propriedade e divida os resultados em intervalos de hora, dia ou semana que começam no horário de um fuso horário IANA, UTC por padrão. Cada intervalo é retornado com… #### Busca de eventos - [Search events](https://docs.mka1.com/api-reference/analyticsevents/pesquisar-eventos-em-um-intervalo-de-tempo.md): Liste eventos individuais em um intervalo de tempo, do mais recente para o mais antigo, com suas propriedades. Opcionalmente, filtre por nome do evento, propriedades do evento ou pelo distinct_id de um visitante. O intervalo inclui o valor inicial e exclui o final, e IDs de eventos duplicados são re… #### Busca de visitantes - [Search visitors](https://docs.mka1.com/api-reference/analyticsvisitors/pesquisar-visitantes-em-um-intervalo-de-tempo.md): Liste visitantes com eventos correspondentes em um intervalo de tempo, em ordem de atividade mais recente primeiro. Cada visitante é um distinct_id com os timestamps do primeiro e do último evento correspondente e a contagem de eventos ao longo de todo o intervalo; assim, para um intervalo que não r… ### Legacy APIs #### Chat Completions - [[Obsoleto] Conclusões de chat para uso do SDK/client da OpenAI](https://docs.mka1.com/api-reference/chat-completions/[obsoleto]-conclusões-de-chat-para-uso-do-sdkclient-da-openai.md): **Deprecado: Use a API de Respostas (`/api/v1/llm/responses`) em vez disso.** Endpoint de conclusão de chat compatível com OpenAI, projetado para uso com as bibliotecas cliente oficiais da OpenAI (Python, Node.js, etc.). Suporta tanto solicitações em streaming quanto não em streaming configurando o… - [[Deprecado] Completações de chat por streaming para uso de SDK gerado](https://docs.mka1.com/api-reference/chat-completions/[deprecado]-completações-de-chat-por-streaming-para-uso-de-sdk-gerado.md): **Obsoleto: Use a API de Respostas (`/api/v1/llm/responses`) em vez disso.** Endpoint de conclusão de chat em streaming projetado para uso com o SDK gerado em TypeScript/JavaScript da especificação OpenAPI. Este endpoint utiliza streaming nativo do ORPC através de geradores assíncronos e retorna Eve… #### Fine-Tuning - [[Obsoleto] Criar um job de fine-tuning](https://docs.mka1.com/api-reference/fine-tuning/[obsoleto]-criar-um-job-de-fine-tuning.md): **Obsoleto: use jobs de Compute (`/api/v1/compute/jobs`) em vez disso.** Cria um job de fine-tuning que inicia o processo de treinamento de um novo modelo a partir de um conjunto de dados fornecido. - [[Descontinuado] Listar jobs de ajuste fino](https://docs.mka1.com/api-reference/fine-tuning/[descontinuado]-listar-jobs-de-ajuste-fino.md): **Obsoleto: use trabalhos de computação (`/api/v1/compute/jobs`) em vez disso.** Liste os trabalhos de fine-tuning da sua organização. - [[Obsoleto] Recuperar um trabalho de ajuste fino](https://docs.mka1.com/api-reference/fine-tuning/[obsoleto]-recuperar-um-trabalho-de-ajuste-fino.md): **Obsoleto: use trabalhos de computação (`/api/v1/compute/jobs`) em vez disso.** Obtenha informações sobre um trabalho de ajuste fino. - [[Obsoleto] Cancelar um trabalho de ajuste fino](https://docs.mka1.com/api-reference/fine-tuning/[obsoleto]-cancelar-um-trabalho-de-ajuste-fino.md): **Obsoleto: use jobs de compute (`/api/v1/compute/jobs`) em vez disso.** Cancele imediatamente um job de fine-tuning. - [[Obsoleto] Pausar um trabalho de fine-tuning](https://docs.mka1.com/api-reference/fine-tuning/[obsoleto]-pausar-um-trabalho-de-fine-tuning.md): **Obsoleto: use jobs de computação (`/api/v1/compute/jobs`) em vez disso.** Pause um job de fine-tuning em execução. - [[Obsoleto] Retomar um job de ajuste fino](https://docs.mka1.com/api-reference/fine-tuning/[obsoleto]-retomar-um-job-de-ajuste-fino.md): **Obsoleto: use jobs de Compute (`/api/v1/compute/jobs`) em vez disso.** Retome um job de fine-tuning pausado. - [[Obsoleto] Listar eventos de fine-tuning](https://docs.mka1.com/api-reference/fine-tuning/[obsoleto]-listar-eventos-de-fine-tuning.md): **Obsoleto: use trabalhos de computação (`/api/v1/compute/jobs`) em vez disso.** Obtenha atualizações de status para um trabalho de ajuste fino. - [[Depreciado] Listar checkpoints de ajuste fino](https://docs.mka1.com/api-reference/fine-tuning/[depreciado]-listar-checkpoints-de-ajuste-fino.md): **Obsoleto: use jobs de computação (`/api/v1/compute/jobs`) em vez disso.** Liste os checkpoints de um job de fine-tuning. ### Additional APIs #### Audit - [Obter um rastreamento da solicitação](https://docs.mka1.com/api-reference/audit/obter-um-rastreamento-da-solicitação.md): Retorna o trace ponta a ponta de uma solicitação de API: seu tempo de resposta no gateway da API, cada resposta que ela criou (incluindo os agentes que chamou) e as invocações de modelo e chamadas de ferramentas de cada resposta, com suas durações. Consulte pelo `X-Request-ID` retornado em cada resp… - [Exportar casos de auditoria](https://docs.mka1.com/api-reference/audit/exportar-casos-de-auditoria.md): Os casos de auditoria da organização: uma linha por resposta do modelo. - [Exportar um caso de auditoria](https://docs.mka1.com/api-reference/audit/exportar-um-caso-de-auditoria.md): Um caso. json e html retornam o caso com sua linha do tempo e artefatos; csv e ndjson retornam suas entradas de livro-razão. - [Exportar solicitações do gateway](https://docs.mka1.com/api-reference/audit/exportar-solicitações-do-gateway.md): As solicitações de API da organização, conforme registradas pelo gateway: uma linha por solicitação. - [Exportar resultados de uso indevido](https://docs.mka1.com/api-reference/audit/exportar-resultados-de-uso-indevido.md): As constatações de uso indevido da organização, da mais recente para a mais antiga. - [Exportar uma constatação de uso indevido](https://docs.mka1.com/api-reference/audit/exportar-uma-constatação-de-uso-indevido.md): Uma descoberta com suas ações e eventos do livro-razão, em CSV. #### Tool Policy - [Obter a política da ferramenta](https://docs.mka1.com/api-reference/tool-policy/obter-a-política-da-ferramenta.md): Recupere a política de ferramentas da sua organização: as regras que negam tipos de ferramentas ou retêm suas chamadas para aprovação, em toda solicitação de Responses na organização, incluindo execuções de agentes salvas. Quando a organização não tem uma política, rules está vazio e updated_at é nu… - [Substituir a política da ferramenta](https://docs.mka1.com/api-reference/tool-policy/substituir-a-política-da-ferramenta.md): Substitua a política de ferramentas da sua organização (somente administrador da organização). Cada regra nomeia um tipo de ferramenta e uma ação: deny recusa solicitações que configuram a ferramenta, e require_approval retém cada chamada até que ela seja aprovada. As regras MCP podem ser limitadas… - [Excluir a política da ferramenta](https://docs.mka1.com/api-reference/tool-policy/excluir-a-política-da-ferramenta.md): Excluir a política de ferramentas da sua organização (somente administrador da organização), removendo todas as restrições que ela definiu. Idempotente: ao excluir quando não há política, retorna deleted: false. #### OAuth - [Ler a configuração pública nativa do cliente OAuth](https://docs.mka1.com/api-reference/oauth/ler-a-configuração-pública-nativa-do-cliente-oauth.md): Retorna o registro interno de Código, ou o cliente nativo público selecionado. Disponível quando o OAuth está habilitado. Não registra clientes nem concede acesso. - [Ler o usuário OAuth autenticado e o workspace](https://docs.mka1.com/api-reference/oauth/ler-o-usuário-oauth-autenticado-e-o-workspace.md): Requer um token de acesso à API OAuth para este recurso do emissor. Verifica novamente a sessão pai, a política do cliente e a associação ao workspace, retornando os escopos atuais efetivos da API. Cookies do navegador, chaves de API e tokens de ID não podem autenticar este endpoint. Nenhum escopo d… #### Sandbox Connectors - [Lista de conectores](https://docs.mka1.com/api-reference/sandbox-connectors/lista-de-conectores.md): Enumera los conectores que puedes conectar y tu conexión con cada uno, o `null` cuando no tengas ninguno. `status` es `needs_login` cuando el conector debe volver a conectarse. `tool_allowlist` establecido en `null` significa que las sesiones pueden llamar a todas las herramientas que el conector en… - [Iniciar login do conector](https://docs.mka1.com/api-reference/sandbox-connectors/iniciar-login-do-conector.md): Comece a conectar um conector OAuth à sua conta. Envie o usuário para o `authorize_url` retornado. O conector redireciona de volta para a página de callback da plataforma com um `code` e o mesmo `state`, que ele encaminha para `POST /connectors/oauth/connections` antes que `expires_in_seconds` expir… - [Concluir login do conector](https://docs.mka1.com/api-reference/sandbox-connectors/concluir-login-do-conector.md): Troque o `code` e o `state` do redirecionamento do conector por uma conexão armazenada. Chame isso como o mesmo usuário conectado que iniciou o login. O serviço sandbox mantém o token criptografado e nunca o retorna. - [Definir chave da API do conector](https://docs.mka1.com/api-reference/sandbox-connectors/definir-chave-da-api-do-conector.md): Conecte um conector de chave de API. A chave é verificada com o conector antes de ser armazenada (422 quando o conector a rejeita) e nunca é retornada. - [Desconectar conector](https://docs.mka1.com/api-reference/sandbox-connectors/desconectar-conector.md): Elimine su conexión a un conector y revoque su token en el conector cuando admita la revocación. La conexión se elimina incluso si el conector no confirma la revocación. - [Lista de Ferramentas do Conector](https://docs.mka1.com/api-reference/sandbox-connectors/lista-de-ferramentas-do-conector.md): Liste agora as ferramentas do conector, com indicação se cada uma é somente leitura, sua lista de अनुमति de ferramentas e `allowed`: as ferramentas que uma sessão pode chamar. 409 quando o conector precisar ser reconectado. - [Definir lista de permissões da ferramenta Conector](https://docs.mka1.com/api-reference/sandbox-connectors/definir-lista-de-permissões-da-ferramenta-conector.md): Escolha quais sessões das ferramentas do conector podem chamar. Envie uma lista de nomes de ferramentas, ou `null` para اجازه a todas as ferramentas listadas pelo conector, de leitura ou escrita. #### Billing - [Get apiv1budgetingbillingorg](https://docs.mka1.com/api-reference/billing/get-apiv1budgetingbillingorg.md): Leer la facturación de la organización. Las claves de API requieren read:billing y además un propietario o administrador humano, o una cuenta de servicio delegada. Las claves están vinculadas a su organización; las lecturas entre organizaciones requieren un administrador humano del clúster con read:… - [Put apiv1budgetingbillingorgenabled](https://docs.mka1.com/api-reference/billing/put-apiv1budgetingbillingorgenabled.md): Habilita o deshabilita la facturación de la organización. Requiere un administrador humano del clúster. Las claves API requieren tanto el permiso write:billing como el alcance write:cluster, que solo está disponible durante el arranque. Las claves de cuenta de servicio no pueden habilitar ni deshabi… - [Put apiv1budgetingbillingorgprofile](https://docs.mka1.com/api-reference/billing/put-apiv1budgetingbillingorgprofile.md): Actualiza el perfil de facturación de la organización vinculada. Las claves de API requieren write:billing y, además, un propietario o administrador humano o una cuenta de servicio delegada. La organización se resuelve a partir de la clave de API. - [Post apiv1budgetingbillingorgsetup session](https://docs.mka1.com/api-reference/billing/post-apiv1budgetingbillingorgsetup-session.md): Cree una sesión de configuración del proveedor de pagos para la organización vinculada. Las claves de API requieren write:billing y un propietario/admin humano o una cuenta de servicio delegada. La organización se resuelve a partir de la clave de API. - [Post apiv1budgetingbillingorgportal session](https://docs.mka1.com/api-reference/billing/post-apiv1budgetingbillingorgportal-session.md): Crear una sesión del portal del proveedor de pagos para la organización vinculada. Las claves de API requieren write:billing y bien un propietario/admin humano o una cuenta de servicio delegada. La organización se resuelve a partir de la clave de API. - [Get apiv1budgetingbillingorginvoices](https://docs.mka1.com/api-reference/billing/get-apiv1budgetingbillingorginvoices.md): Listar facturas de una organización. Las claves de API requieren read:billing y, además, un propietario/admin humano o una cuenta de servicio delegada. Las lecturas entre organizaciones requieren un administrador humano del clúster con read:cluster. #### Feature Flags - [Lista de sinalizadores](https://docs.mka1.com/api-reference/feature-flags/lista-de-sinalizadores.md): Cada flag com um resumo por ambiente do seu estado. - [Criar uma bandeira](https://docs.mka1.com/api-reference/feature-flags/criar-uma-bandeira.md): A flag começa desativada em todos os ambientes e pertence ao Default quando project_id é omitido. - [Listar projetos](https://docs.mka1.com/api-reference/feature-flags/listar-projetos.md) - [Criar um projeto](https://docs.mka1.com/api-reference/feature-flags/criar-um-projeto.md) - [Excluir um projeto vazio](https://docs.mka1.com/api-reference/feature-flags/excluir-um-projeto-vazio.md): O padrão não pode ser excluído. Mova ou exclua todas as bandeiras antes de excluir outro projeto. - [Obter um projeto](https://docs.mka1.com/api-reference/feature-flags/obter-um-projeto.md) - [Renomear um projeto](https://docs.mka1.com/api-reference/feature-flags/renomear-um-projeto.md) - [Liste as entradas de auditoria, da mais recente para a mais antiga](https://docs.mka1.com/api-reference/feature-flags/liste-as-entradas-de-auditoria-da-mais-recente-para-a-mais-antiga.md) - [Listar ambientes](https://docs.mka1.com/api-reference/feature-flags/listar-ambientes.md) - [Criar um ambiente](https://docs.mka1.com/api-reference/feature-flags/criar-um-ambiente.md): Todos os sinalizadores existentes ganham um estado desativado no novo ambiente. - [Excluir um ambiente e todas as configurações de sinalizador nele](https://docs.mka1.com/api-reference/feature-flags/excluir-um-ambiente-e-todas-as-configurações-de-sinalizador-nele.md) - [Renomear um ambiente](https://docs.mka1.com/api-reference/feature-flags/renomear-um-ambiente.md) - [Avalie cada sinalizador para uma identidade](https://docs.mka1.com/api-reference/feature-flags/avalie-cada-sinalizador-para-uma-identidade.md): Resolve todas as flags não arquivadas do ambiente para um chamador anônimo, ou para a identidade fornecida na consulta. Envia um ETag e responde 304 a um If-None-Match correspondente após autenticar a chave de avaliação do ambiente. - [Avalie cada sinalizador para uma identidade com características](https://docs.mka1.com/api-reference/feature-flags/avalie-cada-sinalizador-para-uma-identidade-com-características.md) - [Revogar uma chave de avaliação de ambiente](https://docs.mka1.com/api-reference/feature-flags/revogar-uma-chave-de-avaliação-de-ambiente.md): A revogação é idempotente enquanto o ambiente existir. - [Gerar ou substituir uma chave de avaliação de ambiente](https://docs.mka1.com/api-reference/feature-flags/gerar-ou-substituir-uma-chave-de-avaliação-de-ambiente.md): Retorna a nova chave em texto simples apenas uma vez. Apenas seu digest SHA-256 e uma dica de exibição são armazenados; gerar outra chave substitui imediatamente a credencial anterior nesta réplica. - [Excluir um sinalizador e suas configurações em todos os ambientes](https://docs.mka1.com/api-reference/feature-flags/excluir-um-sinalizador-e-suas-configurações-em-todos-os-ambientes.md) - [Obtenha uma bandeira](https://docs.mka1.com/api-reference/feature-flags/obtenha-uma-bandeira.md) - [Atualize o nome, a descrição, o valor padrão ou o projeto de um flag](https://docs.mka1.com/api-reference/feature-flags/atualize-o-nome-a-descrição-o-valor-padrão-ou-o-projeto-de-um-flag.md) - [Arquivar uma sinalização](https://docs.mka1.com/api-reference/feature-flags/arquivar-uma-sinalização.md): Flags arquivadas são excluídas da avaliação em todos os ambientes; suas configurações são mantidas. - [Substituir as configurações de uma flag em um ambiente](https://docs.mka1.com/api-reference/feature-flags/substituir-as-configurações-de-uma-flag-em-um-ambiente.md) - [Restaurar uma bandeira arquivada](https://docs.mka1.com/api-reference/feature-flags/restaurar-uma-bandeira-arquivada.md) #### Service Status - [Obter o status do serviço](https://docs.mka1.com/api-reference/service-status/obter-o-status-do-serviço.md): O status atual de cada serviço e os incidentes ativos. Qualquer chamador autenticado pode lê-lo. - [Listar incidentes](https://docs.mka1.com/api-reference/service-status/listar-incidentes.md): Incidentes, começando pelos mais recentes. - [Obter um incidente](https://docs.mka1.com/api-reference/service-status/obter-um-incidente.md): Um incidente com sua linha do tempo completa de atualizações. #### Support Cases - [Listar casos de suporte](https://docs.mka1.com/api-reference/support-cases/listar-casos-de-suporte.md): Casos de suporte visíveis para o chamador, atualizados mais recentemente primeiro. Requer `read:support`. - [Abra um chamado de suporte](https://docs.mka1.com/api-reference/support-cases/abra-um-chamado-de-suporte.md): Requer `write:support`. - [Obter um chamado de suporte](https://docs.mka1.com/api-reference/support-cases/obter-um-chamado-de-suporte.md): Um caso de suporte com sua linha do tempo. Requer `read:support`. - [Comentar em um caso de suporte](https://docs.mka1.com/api-reference/support-cases/comentar-em-um-caso-de-suporte.md): Adiciona um comentário. Um comentário em um caso que está aguardando você ou que foi resolvido o reabre. Requer `write:support`. - [Resolver um caso de suporte](https://docs.mka1.com/api-reference/support-cases/resolver-um-caso-de-suporte.md): Marca o caso como resolvido, com um comentário de encerramento opcional. Requer `write:support`. ## OpenAPI Specs - [speakeasy](https://apigw.mka1.com/speakeasy.json?language=pt-BR) - [speakeasy](https://apigw.mka1.com/speakeasy.json) - [speakeasy](https://apigw.mka1.com/speakeasy.json?language=es)