Skip to main content

Updates the AI model associated with an agent version.

PATCH 
/api/v2/AgentVersion/:agentCode/:agentVersion/model

Updates the AI model associated with an agent version.

Request​

Path Parameters

    agentCode stringrequired

    The code of the agent.

    agentVersion int32required

    The version number of the agent.

Query Parameters

    culture string

    Use this param to override the culture of the response. Options: - en (default) - es

Body

The AI model update request.

    main

    object

    required

    id uuidnullable
    modelCode stringnullable

    The model code associated with the AI model to be used by the agent. Required if Id is not provided.

    vendor stringnullable

    The vendor associated with the AI model to be used by the agent. Required if Id is not provided.

    parameters

    object

    Request DTO for configuring AI model execution parameters.

    frequencyPenalty floatnullable

    A float value between -2 and 2 that penalizes the likelihood of an agent reusing similar completions.

    logitBIAS stringnullable

    A JSON object that maps tokens to an associated bias value from -100 to 100.

    maxTotalTokens int64nullable

    The maximum number of tokens shared between the Prompt and the Output.

    maxOutputTokens int32nullable

    The maximum number of tokens that can be generated by the AI in the response.

    presencePenalty floatnullable

    A float value between -2 and 2 that penalizes the likelihood of an agent reusing phrases already present in the input.

    reasoningEffort stringnullable

    The reasoning level of the agent's response (e.g., "low", "medium", "high").

    stopSequences string[]nullable

    Defines sequences of tokens upon which the agent should stop generating completions.

    temperature floatnullable

    A float value between 0 and 2 that determines the randomness of the agent's responses.

    topK floatnullable

    A float value that specifies the Top-K sampling parameter.

    topP floatnullable

    A float value between 0 and 1 that specifies the probability cutoff for generating the response (nucleus sampling).

    useVision boolean

    Defines if the agent should use Vision capabilities.

    usePluginEmulator booleannullable

    Defines if the agent should use Plugin Emulator instead of native tools.

    enableThinking boolean

    Defines if the agent should use extended thinking (Alibaba Cloud and DeepSeek only).

    main

Responses​

AI model updated successfully.

Loading...