Skip to main content

Creates a chat completion agent

POST 
/api/v2/agent/chat

Creates a chat completion agent

Request​

Query Parameters

    culture string

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

Body

The system agent creation request containing details.

    general

    object

    required

    name stringrequired

    Possible values: non-empty and <= 64 characters

    code stringrequired

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[a-zA-Z0-9\-]*$

    subtenantCode stringnullable

    Possible values: <= 128 characters, Value must match regular expression ^[A-Za-z0-9_-]+$

    description stringnullable

    Possible values: <= 2000 characters

    instructions

    object

    required

    systemDefinition stringrequired

    Possible values: non-empty and <= 40000 characters

    responseFormatType stringnullable
    responseFormat stringnullable

    Possible values: <= 4000 characters

    model

    object

    required

    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

  • ]

    • datasetSources uuid[]nullable

    List of dataset ids to be integrated as knowledge sources

    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

    skills

    object[]

    nullable

    List of skills to be added to the agent.

  • Array [

    • oneOf

    Request model for creating or updating an Agent Executor skill within an agent.

    type stringrequired

    Possible values: non-empty, [AgentExecutor]

    The skill type identifier. Always "AgentExecutor" for agent executor skills.

    settings

    object

    required

    agentCode stringrequired

    Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9\-]*$

    The code of the agent to execute when this skill is invoked.

    agentVersion int32nullable

    The version of the agent to use for this skill.

    code stringrequired

    Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$

    The unique code for this skill configuration.

    description stringnullable

    Possible values: <= 4000 characters

    The description of this skill configuration.

    includeInAgentResult boolean

    When set to true, the skill result will be returned within the agent result.

    reuseOutput boolean

    When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.

    active boolean

    Only active skills will be imported during agent execution.

  • ]

Responses​

System agent created successfully.

Loading...