Jump to

• Request
• Response

Send an asynchronous request

post

/orchestrator/agent/v2/{workflowCode}/invokeAsync

Initiates an asynchronous request to the AI agent team to process user query and generate the response from the LLM. The response contains the job ID and the initial status of the agent team.

Request

Path Parameters

• workflowCode(required): string

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• agentCodes: array agentCodes
• architecture: string
• conversational: boolean
• conversationId: string
• invocationMode: string
• jobId: string
• message: string
• parameters: object parameters
  Additional Properties Allowed: additionalProperties
• progressMessage: boolean
• resumeNodeInput: object resumeNodeInput
• status: string
• streamOutput: boolean
• toolCodes: array toolCodes
• version: integer (int32)
• workflowName: string

{
    "properties":{
        "message":{
            "type":"string"
        },
        "conversational":{
            "type":"boolean"
        },
        "conversationId":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "invocationMode":{
            "type":"string"
        },
        "version":{
            "format":"int32",
            "type":"integer"
        },
        "status":{
            "type":"string"
        },
        "workflowName":{
            "type":"string"
        },
        "architecture":{
            "type":"string"
        },
        "parameters":{
            "additionalProperties":{
            },
            "type":"object"
        },
        "agentCodes":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "toolCodes":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "resumeNodeInput":{
            "type":"object"
        },
        "streamOutput":{
            "type":"boolean"
        },
        "progressMessage":{
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : agentCodes

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

{
    "additionalProperties":{
    },
    "type":"object"
}

Nested Schema : resumeNodeInput

Type: object

Nested Schema : toolCodes

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Security

• bearerAuth: http
  Type: http

Back to Top

Response

200 Response

OK

Back to Top