NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

OpenAI

openai

Toolkit for OpenAI APIs: manage Assistants, Threads/Messages; upload/list/delete Files; list/retrieve Models (including vision/multimodal); and view fine-tune listings and events.

Artificial IntelligenceAI ModelsAI Content GenerationWeb del proveedor
Acciones
14
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool to create a new assistant with specified parameters. use after finalizing model, tools, and instructions.

Parámetros de entrada

  • namestring

    User-friendly name for the assistant

  • modelstringObligatorio

    ID 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

  • metadataobject

    Arbitrary JSON metadata to attach to the assistant

  • descriptionstring

    Brief description of the assistant's purpose

  • instructionsstring

    System-level instructions guiding assistant behavior

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create MessageOPENAI_CREATE_MESSAGEAcción

Tool 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

  • rolestringObligatorioenum

    Role of the message sender: 'user' or 'assistant'

    userassistant
  • contentstringObligatorio

    Message content as a string or list of structured parts

  • metadataobject

    Up to 16 key-value pairs of metadata (keys ≤64 chars, values ≤512 chars)

  • thread_idstringObligatorio

    ID of the thread to create the message in

  • attachmentsobject[]

    Optional files to attach to the message

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create ThreadOPENAI_CREATE_THREADAcción

Tool 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

  • metadataobject

    Optional metadata key-value pairs to attach to the thread

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete assistantOPENAI_DELETE_ASSISTANTAcción

Tool 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_idstringObligatorio

    Identifier of the assistant to delete (path parameter)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete fileOPENAI_DELETE_FILEAcción

Tool 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_idstringObligatorio

    ID of the file to delete (path parameter)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List filesOPENAI_LIST_FILESAcción

Tool to retrieve a list of files. use when you need to view all files uploaded to your organization.

Parámetros de entrada

  • limitinteger

    Number of files to retrieve

Parámetros de salida

  • dataobject[]Obligatorio

    List of file objects

  • errorstring

    Error if any occurred during the execution of the action

  • objectstringObligatorio

    Object type, always 'list'

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List fine-tunesOPENAI_LIST_FINE_TUNESAcción

Tool 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[]Obligatorio

    Array of fine-tune job objects.

  • errorstring

    Error if any occurred during the execution of the action

  • objectstringObligatorio

    The type of this object, always 'list'.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List modelsOPENAI_LIST_MODELSAcción

Tool 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[]Obligatorio

    Array of model objects returned by the API.

  • errorstring

    Error if any occurred during the execution of the action

  • objectstringObligatorio

    The type of this object, always 'list'.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List run stepsOPENAI_LIST_RUN_STEPSAcción

Tool 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

  • afterstring

    Return steps after this step ID

  • limitinteger

    Maximum number of steps to return (1-100)

  • orderstringenum

    Sort order by step creation time

    ascdesc
  • beforestring

    Return steps before this step ID

  • run_idstringObligatorio

    ID 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_idstringObligatorio

    ID of the thread that the run belongs to

Parámetros de salida

  • dataobject[]Obligatorio

    Array of run step objects

  • errorstring

    Error if any occurred during the execution of the action

  • objectstringObligatorio

    The type of this object, always 'list'

  • last_idstringObligatorio

    ID of the last run step in this list

  • first_idstringObligatorio

    ID of the first run step in this list

  • has_morebooleanObligatorio

    Whether more run steps are available after this list

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Modify threadOPENAI_MODIFY_THREADAcción

Tool to modify an existing thread's metadata. use after obtaining the thread id when you need to update metadata.

Parámetros de entrada

  • metadataobject

    Arbitrary JSON metadata to attach to the thread

  • thread_idstringObligatorio

    ID of the thread to modify

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve assistantOPENAI_RETRIEVE_ASSISTANTAcción

Tool to retrieve details of a specific assistant. use when you need to confirm assistant metadata before performing further operations.

Parámetros de entrada

  • assistant_idstringObligatorio

    Identifier of the assistant to retrieve (path parameter)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve modelOPENAI_RETRIEVE_MODELAcción

Tool 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

  • modelstringObligatorio

    Identifier of the model to retrieve (path parameter)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve threadOPENAI_RETRIEVE_THREADAcción

Tool 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_idstringObligatorio

    Identifier of the thread to retrieve (path parameter)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Upload fileOPENAI_UPLOAD_FILEAcción

Tool to upload a file for use across openai endpoints. use before referencing the file in tasks like fine-tuning.

Parámetros de entrada

  • filestringObligatoriobinary

    Binary content of the file to upload. E.g., open('data.jsonl','rb').read().

  • purposestringObligatorio

    Intended purpose of the uploaded file. Currently only 'fine-tune' is supported.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not