OpenAI

Visão geral

A OpenAI é a empresa por trás dos modelos GPT, DALL-E, Whisper e TTS — alguns dos modelos de inteligência artificial mais avançados do mundo. Com a integração da OpenAI no SquadOS, seus agentes podem criar completions de chat, gerar e editar imagens, transcrever áudio, converter texto em fala, gerar embeddings, fazer fine-tuning de modelos, gerenciar assistants, threads e vector stores para RAG, e muito mais.

• Site oficial: https://openai.com/
• Documentação na Composio: docs.composio.dev/toolkits/openai

Autenticação

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
api_key	Sim	Chave de API gerada no painel da OpenAI, usada para autenticar todas as requisições.

Como obter a credencial

1. Acesse platform.openai.com e faça login ou crie uma conta.
2. No menu lateral, clique em API keys.
3. Clique em Create new secret key, dê um nome e copie o valor gerado.
4. Guarde a chave em local seguro — ela não será exibida novamente.

Dica

Use uma chave dedicada para o SquadOS. A OpenAI permite revogar chaves individualmente sem afetar outras integrações. Defina um limite de uso mensal na seção Limits para controlar gastos.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por OpenAI.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Nota

Esta integração expõe 126 ações no total. Abaixo estão as principais; a lista completa está na documentação da Composio.

Criar completion de chat

OPENAI_CREATE_CHAT_COMPLETION

Cria uma resposta de completion de chat usando os modelos da OpenAI. Use para IA conversacional, geração de texto, chamada de funções, tarefas multimodais com visão/áudio e saídas JSON estruturadas. Suporta recursos avançados como modelos de raciocínio, uso de ferramentas e respostas em streaming.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
messages	array	Sim	Lista de mensagens que compõem a conversa até o momento. Cada mensagem tem um papel e conteúdo.
model	string	Sim	ID do modelo a usar. Modelos suportados incluem gpt-4o, gpt-4o-mini, gpt-4-turbo, gpt-3.5-turbo, o1, o1-mini, o3-mini, entre outros.
n	integer	Não	Quantas opções de completion gerar para cada mensagem de entrada. O padrão é 1.
temperature	number	Não	Temperatura de amostragem entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória; valores mais baixos como 0,2 tornam mais focada e determinística. Mutuamente exclusivo com top_p.
tools	array	Não	Lista de ferramentas que o modelo pode chamar. Use para chamada de funções.
response_format	object	Não	Especificação do formato de resposta para saídas estruturadas.
max_completion_tokens	integer	Não	Limite superior para o número de tokens que podem ser gerados, incluindo tokens de raciocínio. Preferível a max_tokens para modelos mais recentes.
stream	boolean	Não	Se verdadeiro, deltas parciais de mensagem serão enviados como eventos server-sent à medida que ficam disponíveis.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar resposta (Responses API)

OPENAI_CREATE_RESPONSE

Gera uma resposta de modelo em uma única chamada via Responses API. Use para análise multimodal (imagem + texto), OCR/extração de texto de imagens ou saídas JSON estruturadas. Para saídas estruturadas, configure text.format com type=‘json_schema’ e seu schema.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
input	string	Sim	Entrada como string para prompts de texto simples, ou array de objetos de mensagem para conversas ou entradas multimodais com imagens.
model	string	Sim	Modelo a usar para a resposta.
tools	array	Não	Lista de ferramentas que o modelo pode chamar. Suporta function, code_interpreter, file_search e web_search.
temperature	number	Não	Temperatura de amostragem entre 0 e 2. Não suportada com modelos de raciocínio.
max_output_tokens	integer	Não	Número máximo de tokens que o modelo pode gerar na resposta.
stream	boolean	Não	Se deve transmitir a resposta via streaming.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Gerar imagem

OPENAI_CREATE_IMAGE

Gera uma imagem via API de Imagens da OpenAI e retorna a URL do ativo hospedado e metadados. Use quando precisar criar imagens a partir de descrições em texto.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
prompt	string	Sim	Descrição em texto da imagem desejada. Comprimento máximo: 32.000 caracteres para modelos GPT image, 4.000 para dall-e-3, 1.000 para dall-e-2.
model	string	Sim	ID do modelo a usar. Modelos suportados incluem: ‘gpt-image-2’ (mais recente), ‘dall-e-3’, ‘dall-e-2’.
size	string	Não	Tamanho da imagem gerada. Ex.: ‘1024x1024’, ‘1792x1024’.
quality	string	Não	Qualidade da imagem. Opções: ‘standard’, ‘hd’, ‘auto’, ‘high’, ‘medium’, ‘low’.
n	integer	Não	Número de imagens a gerar. Para dall-e-3, apenas n=1 é suportado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Editar imagem

OPENAI_CREATE_IMAGE_EDIT

Cria imagens editadas ou estendidas via API de Edição de Imagens da OpenAI. Use quando precisar modificar imagens existentes com base em um prompt de texto, com suporte opcional a máscara para edições direcionadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
images	array	Sim	Referências das imagens de entrada a editar. Para modelos GPT image, é possível fornecer até 16 imagens.
prompt	string	Sim	Descrição em texto da edição desejada. Máximo de 32.000 caracteres.
model	string	Não	Modelo a usar para edição de imagens. Modelos suportados: ‘gpt-image-2’, ‘gpt-image-1.5’ (padrão), ‘dall-e-2’.
size	string	Não	Tamanho da imagem de saída. Ex.: ‘1024x1024’, ‘1024x1536’, ‘auto’.
n	integer	Não	Número de imagens editadas a gerar. O padrão é 1.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Transcrever áudio

OPENAI_CREATE_AUDIO_TRANSCRIPTION

Transcreve arquivos de áudio em texto via API de Transcrições de Áudio da OpenAI. Use quando precisar converter fala em arquivos de áudio para texto escrito, opcionalmente com timestamps ou diarização de falantes.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
model	string	Sim	ID do modelo a usar para transcrição. Opções: ‘whisper-1’, ‘gpt-4o-transcribe’, ‘gpt-4o-mini-transcribe’.
file	object	Não	Arquivo de áudio a transcrever. Formatos suportados: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.
language	string	Não	Idioma do áudio de entrada no formato ISO-639-1 (ex.: ‘pt’ para português, ‘en’ para inglês).
response_format	string	Não	Formato da saída de transcrição. Opções: ‘json’, ‘text’, ‘srt’, ‘vtt’, ‘verbose_json’.
temperature	number	Não	Temperatura de amostragem entre 0 e 1.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Converter texto em fala (TTS)

OPENAI_CREATE_SPEECH

Gera áudio de texto para fala usando a API de Áudio da OpenAI. Use quando precisar converter texto em fala natural com escolha de vozes e modelos. Retorna uma URL de arquivo de áudio hospedado com metadados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
input	string	Sim	Texto a converter em fala. Máximo de 4.096 caracteres.
model	string	Sim	Modelo TTS a usar. Opções: ‘gpt-4o-mini-tts’, ‘tts-1’ (qualidade padrão, mais rápido), ‘tts-1-hd’ (alta qualidade, mais lento).
voice	string	Sim	Voz a usar. Vozes disponíveis: ‘alloy’, ‘ash’, ‘ballad’, ‘coral’, ‘echo’, ‘fable’, ‘onyx’, ‘nova’, ‘sage’, ‘shimmer’, ‘verse’.
response_format	string	Não	Formato do áudio de saída. Opções: ‘mp3’ (padrão), ‘opus’, ‘aac’, ‘flac’, ‘wav’, ‘pcm’.
speed	number	Não	Velocidade de reprodução do áudio. Intervalo: 0,25 a 4,0. O padrão é 1,0.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Gerar embeddings

OPENAI_CREATE_EMBEDDINGS

Gera embeddings de texto via endpoint de embeddings da OpenAI. Use para busca semântica, clusterização, recomendações e fluxos de armazenamento em banco de dados vetorial.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
input	string	Sim	Texto de entrada para gerar embedding. Para múltiplas entradas em uma única requisição, passe um array de strings. O texto não deve exceder 8.192 tokens.
model	string	Sim	ID do modelo a usar. Modelos suportados incluem text-embedding-ada-002, text-embedding-3-small e text-embedding-3-large.
dimensions	integer	Não	Número de dimensões dos embeddings de saída. Suportado apenas em text-embedding-3 e modelos posteriores.
encoding_format	string	Não	Formato para retornar os embeddings. Pode ser ‘float’ ou ‘base64’. O padrão é ‘float’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Classificar conteúdo (moderação)

OPENAI_CREATE_MODERATION

Classifica entradas de texto e/ou imagem para conteúdo potencialmente prejudicial via API de Moderação da OpenAI. Use para verificações de segurança de conteúdo, filtragem de conteúdo gerado por usuários ou monitoramento de violações de política em 13 categorias de dano.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
input	string	Sim	Entrada a classificar. Pode ser uma única string, um array de strings ou um array de objetos de entrada multimodal com texto e imagens.
model	string	Não	Modelo de moderação a usar. Opções incluem: ‘omni-moderation-latest’ (padrão, suporta texto e imagens), ‘text-moderation-latest’ (somente texto).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar assistant

OPENAI_CREATE_ASSISTANT

Cria um assistant da OpenAI. Use quando precisar instanciar um novo assistant com model, instruções, ferramentas e recursos de ferramentas específicos. Necessário antes de criar threads e runs.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
model	string	Sim	ID do modelo a usar.
name	string	Não	Nome do assistant. Comprimento máximo de 256 caracteres.
instructions	string	Não	Instruções do sistema que o assistant usa. Comprimento máximo de 256.000 caracteres.
tools	array	Não	Lista de ferramentas habilitadas no assistant. Pode haver no máximo 128 ferramentas por assistant.
description	string	Não	Descrição do assistant. Comprimento máximo de 512 caracteres.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar thread

OPENAI_CREATE_THREAD

Cria uma nova thread. Use ao inicializar uma conversa com mensagens iniciais opcionais. Retorna um thread_id que deve ser persistido e passado para todas as chamadas subsequentes.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
messages	array	Não	Mensagens iniciais opcionais para começar a thread. Cada mensagem deve incluir ‘role’ (‘user’ ou ‘assistant’) e conteúdo não vazio.
metadata	object	Não	Pares de chave-valor de metadados opcionais para anexar à thread.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar mensagem

OPENAI_CREATE_MESSAGE

Cria uma mensagem em uma thread. Use para adicionar mensagens do usuário (ou do assistant) a uma thread existente antes de criar um run.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
role	string	Sim	Papel da entidade que cria a mensagem. Valores permitidos: ‘user’ ou ‘assistant’.
content	string	Sim	Conteúdo da mensagem. Pode ser uma string de texto ou um array de partes de conteúdo.
thread_id	string	Sim	ID da thread a que pertence esta mensagem.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar run

OPENAI_CREATE_RUN

Cria um run em uma thread com um assistant. Use quando precisar executar um assistant para gerar respostas. Criar uma mensagem sozinha não faz o assistant responder — um run é o primitivo de execução.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
thread_id	string	Sim	ID da thread a executar. Uma thread pode ter apenas um run ativo por vez.
assistant_id	string	Sim	ID do assistant a usar para este run.
model	string	Não	Substituição do modelo usado para este run.
instructions	string	Não	Substituição das instruções do assistant para este run.
stream	boolean	Não	Se verdadeiro, retorna um stream de eventos durante o run.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar thread e run

OPENAI_CREATE_THREAD_AND_RUN

Cria uma thread e a executa em uma única requisição. Use quando precisar iniciar uma nova conversa e imediatamente executar o assistant para gerar uma resposta. Mais eficiente do que chamar create_thread e create_run separadamente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
assistant_id	string	Sim	ID do assistant a usar para este run.
thread	object	Não	Parâmetros para criar a nova thread.
model	string	Não	Substituição do modelo usado para este run.
instructions	string	Não	Substituição das instruções do assistant para este run.
stream	boolean	Não	Se verdadeiro, retorna um stream de eventos durante o run como eventos server-sent.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar mensagens

OPENAI_LIST_MESSAGES

Lista mensagens de uma thread. Use para recuperar todas as mensagens de uma thread após a conclusão de um run, incluindo as respostas do assistant.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
thread_id	string	Sim	ID da thread cujas mensagens serão listadas.
limit	integer	Não	Limite no número de mensagens a retornar (1–100). O padrão é 20.
order	string	Não	Ordem de classificação por timestamp created_at: ‘asc’ para crescente, ‘desc’ para decrescente.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar run

OPENAI_RETRIEVE_RUN

Recupera um run do Assistants por ID para verificar status, erros e uso. Use ao monitorar o status do run até atingir um estado terminal (completed, failed, cancelled, incomplete, expired) antes de ler as mensagens da thread.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
run_id	string	Sim	ID do run a recuperar.
thread_id	string	Sim	ID da thread que foi executada.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Enviar saídas de ferramentas para run

OPENAI_SUBMIT_TOOL_OUTPUTS_TO_RUN

Envia as saídas de chamadas de ferramentas para continuar um run que requer ação. Use quando um run tem status ‘requires_action’ e required_action.type é ‘submit_tool_outputs’. Todas as saídas devem ser enviadas juntas em uma única requisição.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
run_id	string	Sim	ID do run que requer a submissão das saídas.
thread_id	string	Sim	ID da thread à qual este run pertence.
tool_outputs	array	Sim	Lista de ferramentas para as quais as saídas estão sendo enviadas. Todas as saídas devem ser enviadas em uma única requisição.
stream	boolean	Não	Se verdadeiro, retorna um stream de eventos durante a execução do run após enviar as saídas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar vector store

OPENAI_CREATE_VECTOR_STORE

Cria um novo vector store. Use quando precisar criar uma coleção de arquivos processados para ferramentas de busca em arquivos (file_search).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Não	Nome do vector store. Se não fornecido, o vector store não terá nome.
file_ids	array	Não	Lista de IDs de arquivos que o vector store deve usar. Máximo de 500 IDs.
expires_after	object	Não	Política de expiração para o vector store.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar em vector store

OPENAI_SEARCH_VECTOR_STORE

Pesquisa em um vector store por conteúdo relevante. Use para recuperar chunks de texto semânticamente similares à consulta para alimentar contexto em prompts de LLMs.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Sim	Consulta de busca usada para encontrar chunks relevantes no vector store.
vector_store_id	string	Sim	ID do vector store onde buscar.
max_num_results	integer	Não	Número máximo de resultados a retornar. O padrão é 10.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Fazer upload de arquivo

OPENAI_UPLOAD_FILE

Faz upload de um arquivo para uso em endpoints da OpenAI. Use antes de referenciar o arquivo em tarefas como fine-tuning. Retorna um file_id que deve ser passado explicitamente para endpoints como OPENAI_CREATE_ASSISTANT ou OPENAI_CREATE_MESSAGE.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
file	string	Sim	Conteúdo binário do arquivo a fazer upload.
purpose	string	Sim	Finalidade pretendida do arquivo enviado. Atualmente somente ‘fine-tune’ é suportado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar arquivos

OPENAI_LIST_FILES

Lista os arquivos disponíveis na sua conta OpenAI. Use para verificar uploads antes de referenciar file_ids em outras chamadas, ou para identificar arquivos a deletar para liberar cota de armazenamento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
purpose	string	Não	Filtrar por finalidade dos arquivos. Ex.: ‘fine-tune’, ‘assistants’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar job de fine-tuning

OPENAI_CREATE_FINE_TUNING_JOB

Cria um job de fine-tuning que inicia o processo de criar um novo modelo a partir de um dataset fornecido. Use quando precisar iniciar o fine-tuning de um modelo com seus dados de treinamento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
model	string	Sim	Nome do modelo a fazer fine-tuning.
training_file	string	Sim	ID de um arquivo enviado que contém dados de treinamento. O dataset deve ser formatado como um arquivo JSONL e enviado com a finalidade ‘fine-tune’.
validation_file	string	Não	ID de um arquivo enviado que contém dados de validação.
suffix	string	Não	String de até 64 caracteres que será adicionada ao nome do seu modelo fine-tunado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar modelos

OPENAI_LIST_MODELS

Lista os modelos disponíveis na sua conta/organização OpenAI. Use para descobrir quais modelos você pode chamar. Alguns modelos públicos podem estar ausentes devido a permissões.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar modelo

OPENAI_RETRIEVE_MODEL

Recupera os detalhes de um modelo específico, confirmando seus metadados (propriedade, data de criação) e verificando acesso sob sua organização. Um modelo que aparece em OPENAI_LIST_MODELS não garante acesso.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
model	string	Sim	Identificador do modelo a recuperar. Sensível a maiúsculas/minúsculas; use IDs exatos conforme retornados por OPENAI_LIST_MODELS.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar lote (batch)

OPENAI_CREATE_BATCH

Cria e executa um lote a partir de um arquivo enviado de requisições. Use após fazer upload de um arquivo JSONL com finalidade ‘batch’ para processar múltiplas requisições de API em uma única operação em lote.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
endpoint	string	Sim	Endpoint a ser usado para todas as requisições do lote. Endpoints suportados incluem /v1/responses, /v1/chat/completions, /v1/embeddings, /v1/completions, /v1/images/generations.
input_file_id	string	Sim	ID de um arquivo enviado contendo requisições para o lote. O arquivo deve ser formatado como JSONL e enviado com finalidade ‘batch’.
completion_window	string	Sim	Prazo dentro do qual o lote deve ser processado. Atualmente somente ‘24h’ é suportado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Traduzir áudio para inglês

OPENAI_CREATE_AUDIO_TRANSLATION

Traduz arquivos de áudio para texto em inglês via API de Traduções de Áudio da OpenAI. Use quando precisar converter fala em arquivos de áudio (em qualquer idioma) para texto em inglês.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
model	string	Sim	ID do modelo a usar para tradução. Somente ‘whisper-1’ está disponível atualmente.
file	object	Não	Arquivo de áudio a traduzir para inglês. Formatos suportados: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.
prompt	string	Não	Texto opcional para guiar o estilo do modelo. O prompt deve estar em inglês.
response_format	string	Não	Formato da saída da tradução. Opções: ‘json’, ‘text’, ‘srt’, ‘vtt’, ‘verbose_json’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Modificar assistant

OPENAI_MODIFY_ASSISTANT

Modifica um assistant existente. Use quando precisar atualizar a configuração, modelo, instruções, ferramentas ou metadados de um assistant.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
assistant_id	string	Sim	ID do assistant a modificar.
model	string	Não	ID do modelo a usar.
name	string	Não	Nome do assistant. Comprimento máximo de 256 caracteres.
instructions	string	Não	Instruções do sistema que o assistant usa. Comprimento máximo de 256.000 caracteres.
tools	array	Não	Lista de ferramentas habilitadas no assistant. Máximo de 128 ferramentas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar assistant

OPENAI_RETRIEVE_ASSISTANT

Recupera detalhes de um assistant específico. Use quando precisar confirmar metadados do assistant antes de realizar mais operações. Prefira isto a chamadas repetidas de OPENAI_CREATE_ASSISTANT para evitar poluir configurações.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
assistant_id	string	Sim	Identificador do assistant a recuperar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar assistants

OPENAI_LIST_ASSISTANTS

Lista assistants para descobrir o assistant_id correto por nome ou metadados. Use quando o assistant_id for desconhecido para evitar erros 404.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Limite no número de assistants a retornar (1–100). O padrão é 20.
order	string	Não	Ordem de classificação por timestamp created_at: ‘asc’ para crescente, ‘desc’ para decrescente.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.