Skip to main content

Updates an existing activity agent

PUT 
/api/v2/agent/activity/:agentCode

Updates an existing activity agent

Request​

Path Parameters

    agentCode stringrequired

    The code of the system agent to update.

Query Parameters

    culture string

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

Body

The system agent update request containing details.

    general

    object

    name stringrequired

    Possible values: non-empty and <= 64 characters

    description stringnullable

    Possible values: <= 2000 characters

    instructions

    object

    systemDefinition stringrequired

    Possible values: non-empty and <= 40000 characters

    responseFormatType stringnullable
    responseFormat stringnullable

    Possible values: <= 4000 characters

    model

    object

    main

    object

    id uuidrequired

    knowledge

    object

    knowledgeSources

    object[]

    nullable

    List of files to be integrated

  • Array [

    • id uuidnullable
    fileId uuidnullable
    url stringnullable

    metadata

    object

    description stringnullable

    Possible values: <= 1000 characters

    tags stringnullable

    Possible values: <= 1021 characters

  • ]

    • advancedSettings

    object

    integrationMode stringnullable

    The mode of knowledge integration, which determines how the knowledge is integrated into the agent's context. If not provided, default values will be set

    embeddingModelId uuidrequired

    The model used to generate the embeddings IF changed, all files will be reprocessed.

    relevance doublenullable

    Possible values: <= 1

    The relevance score of the knowledge If not provided, default values will be set

    sectionsToRetrieve int32nullable

    Possible values: >= 1 and <= 100

    Sets a limit on the number of sections to retrieve If not provided, default values will be set

Responses​

System agent updated successfully.

Loading...