OpenAI
openaiToolkit for OpenAI APIs: manage Assistants, Threads/Messages; upload/list/delete Files; list/retrieve Models (including vision/multimodal); and view fine-tune listings and events.
Acciones disponibles (14)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create AssistantOPENAI_CREATE_ASSISTANTAcciónTool to create a new assistant with specified parameters. use after finalizing model, tools, and instructions.
OPENAI_CREATE_ASSISTANTAcciónTool to create a new assistant with specified parameters. use after finalizing model, tools, and instructions.
Parámetros de entrada
namestringUser-friendly name for the assistant
modelstringObligatorioID of the model to use for this assistant
toolsobject[]List of tools the assistant can invoke
file_idsstring[]List of file IDs the assistant may access
metadataobjectArbitrary JSON metadata to attach to the assistant
descriptionstringBrief description of the assistant's purpose
instructionsstringSystem-level instructions guiding assistant behavior
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create MessageOPENAI_CREATE_MESSAGEAcciónTool to create a new message in a specific thread. use when adding messages to an existing conversation after confirming the thread id.
OPENAI_CREATE_MESSAGEAcciónTool to create a new message in a specific thread. use when adding messages to an existing conversation after confirming the thread id.
Parámetros de entrada
rolestringObligatorioenumRole of the message sender: 'user' or 'assistant'
userassistantcontentstringObligatorioMessage content as a string or list of structured parts
metadataobjectUp to 16 key-value pairs of metadata (keys ≤64 chars, values ≤512 chars)
thread_idstringObligatorioID of the thread to create the message in
attachmentsobject[]Optional files to attach to the message
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ThreadOPENAI_CREATE_THREADAcciónTool to create a new thread. use when initializing a conversation with optional starter messages.
OPENAI_CREATE_THREADAcciónTool to create a new thread. use when initializing a conversation with optional starter messages.
Parámetros de entrada
messagesobject[]Optional initial messages to start the thread with
metadataobjectOptional metadata key-value pairs to attach to the thread
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete assistantOPENAI_DELETE_ASSISTANTAcciónTool to delete a specific assistant by its id. use when you need to remove an assistant after confirming its id.
OPENAI_DELETE_ASSISTANTAcciónTool to delete a specific assistant by its id. use when you need to remove an assistant after confirming its id.
Parámetros de entrada
assistant_idstringObligatorioIdentifier of the assistant to delete (path parameter)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete fileOPENAI_DELETE_FILEAcciónTool to delete a file. use when you need to remove an uploaded file by its id after confirming the target.
OPENAI_DELETE_FILEAcciónTool to delete a file. use when you need to remove an uploaded file by its id after confirming the target.
Parámetros de entrada
file_idstringObligatorioID of the file to delete (path parameter)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List filesOPENAI_LIST_FILESAcciónTool to retrieve a list of files. use when you need to view all files uploaded to your organization.
OPENAI_LIST_FILESAcciónTool to retrieve a list of files. use when you need to view all files uploaded to your organization.
Parámetros de entrada
limitintegerNumber of files to retrieve
Parámetros de salida
dataobject[]ObligatorioList of file objects
errorstringError if any occurred during the execution of the action
objectstringObligatorioObject type, always 'list'
successfulbooleanObligatorioWhether or not the action execution was successful or not
List fine-tunesOPENAI_LIST_FINE_TUNESAcciónTool to list your organization's fine-tuning jobs. use when you need to review all fine-tune runs.
OPENAI_LIST_FINE_TUNESAcciónTool to list your organization's fine-tuning jobs. use when you need to review all fine-tune runs.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioArray of fine-tune job objects.
errorstringError if any occurred during the execution of the action
objectstringObligatorioThe type of this object, always 'list'.
successfulbooleanObligatorioWhether or not the action execution was successful or not
List modelsOPENAI_LIST_MODELSAcciónTool to list available models. use when you need to discover which models you can call. use after confirming your api key is valid.
OPENAI_LIST_MODELSAcciónTool to list available models. use when you need to discover which models you can call. use after confirming your api key is valid.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioArray of model objects returned by the API.
errorstringError if any occurred during the execution of the action
objectstringObligatorioThe type of this object, always 'list'.
successfulbooleanObligatorioWhether or not the action execution was successful or not
List run stepsOPENAI_LIST_RUN_STEPSAcciónTool to retrieve all steps of a specific run. use when you need to inspect each step's details after initiating a run.
OPENAI_LIST_RUN_STEPSAcciónTool to retrieve all steps of a specific run. use when you need to inspect each step's details after initiating a run.
Parámetros de entrada
afterstringReturn steps after this step ID
limitintegerMaximum number of steps to return (1-100)
orderstringenumSort order by step creation time
ascdescbeforestringReturn steps before this step ID
run_idstringObligatorioID of the run to list steps for
include[]string[]Additional fields to include in the response. Supported value: 'step_details.tool_calls[*].file_search.results[*].content'
thread_idstringObligatorioID of the thread that the run belongs to
Parámetros de salida
dataobject[]ObligatorioArray of run step objects
errorstringError if any occurred during the execution of the action
objectstringObligatorioThe type of this object, always 'list'
last_idstringObligatorioID of the last run step in this list
first_idstringObligatorioID of the first run step in this list
has_morebooleanObligatorioWhether more run steps are available after this list
successfulbooleanObligatorioWhether or not the action execution was successful or not
Modify threadOPENAI_MODIFY_THREADAcciónTool to modify an existing thread's metadata. use after obtaining the thread id when you need to update metadata.
OPENAI_MODIFY_THREADAcciónTool to modify an existing thread's metadata. use after obtaining the thread id when you need to update metadata.
Parámetros de entrada
metadataobjectArbitrary JSON metadata to attach to the thread
thread_idstringObligatorioID of the thread to modify
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve assistantOPENAI_RETRIEVE_ASSISTANTAcciónTool to retrieve details of a specific assistant. use when you need to confirm assistant metadata before performing further operations.
OPENAI_RETRIEVE_ASSISTANTAcciónTool to retrieve details of a specific assistant. use when you need to confirm assistant metadata before performing further operations.
Parámetros de entrada
assistant_idstringObligatorioIdentifier of the assistant to retrieve (path parameter)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve modelOPENAI_RETRIEVE_MODELAcciónTool to retrieve details of a specific model. use when you have a model id and need to confirm its metadata before using it.
OPENAI_RETRIEVE_MODELAcciónTool to retrieve details of a specific model. use when you have a model id and need to confirm its metadata before using it.
Parámetros de entrada
modelstringObligatorioIdentifier of the model to retrieve (path parameter)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve threadOPENAI_RETRIEVE_THREADAcciónTool to retrieve details of a specific thread by its id. use when you need to fetch thread metadata before listing messages.
OPENAI_RETRIEVE_THREADAcciónTool to retrieve details of a specific thread by its id. use when you need to fetch thread metadata before listing messages.
Parámetros de entrada
thread_idstringObligatorioIdentifier of the thread to retrieve (path parameter)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upload fileOPENAI_UPLOAD_FILEAcciónTool to upload a file for use across openai endpoints. use before referencing the file in tasks like fine-tuning.
OPENAI_UPLOAD_FILEAcciónTool to upload a file for use across openai endpoints. use before referencing the file in tasks like fine-tuning.
Parámetros de entrada
filestringObligatoriobinaryBinary content of the file to upload. E.g., open('data.jsonl','rb').read().
purposestringObligatorioIntended purpose of the uploaded file. Currently only 'fine-tune' is supported.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not