Jump to

• Request
• Response

Trigger workflow stream

post

<servername>/orchestrator/internal/agent/v1/api/fusion-ai/orchestrator/a2a/v1/{workflowCode}

Trigger an agent workflow and stream the generated response back to the caller.

Request

Path Parameters

• workflowCode(required): string
  Code identifying the workflow to be triggered.

Query Parameters

• caller: string
  Identifier for the caller triggering the workflow.

  Example:

  chatbot

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• agentConfig(required): object agentConfig
  Additional Properties Allowed: true

  Agent configuration used for triggering the workflow.
• llmConfig(required): object llmConfig
  Additional Properties Allowed: true

  Large language model configuration used for triggering the workflow.
• request(required): object InvocationRequest
• toolsConfig(required): object toolsConfig
  Additional Properties Allowed: true

  Tool configuration available to the agent for triggering the workflow.
• workflowConfig(required): object workflowConfig
  Additional Properties Allowed: true

  The configuration used for triggering the workflow.

{
    "required":[
        "workflowConfig",
        "agentConfig",
        "toolsConfig",
        "llmConfig",
        "request"
    ],
    "type":"object",
    "properties":{
        "workflowConfig":{
            "type":"object",
            "description":"The configuration used for triggering the workflow.",
            "additionalProperties":true
        },
        "agentConfig":{
            "type":"object",
            "description":"Agent configuration used for triggering the workflow.",
            "additionalProperties":true
        },
        "toolsConfig":{
            "type":"object",
            "description":"Tool configuration available to the agent for triggering the workflow.",
            "additionalProperties":true
        },
        "llmConfig":{
            "type":"object",
            "description":"Large language model configuration used for triggering the workflow.",
            "additionalProperties":true
        },
        "request":{
            "$ref":"#/components/schemas/InvocationRequest"
        }
    }
}

Nested Schema : agentConfig

Type: object

Additional Properties Allowed: true

Agent configuration used for triggering the workflow.

Nested Schema : llmConfig

Type: object

Additional Properties Allowed: true

Large language model configuration used for triggering the workflow.

Nested Schema : InvocationRequest

Type: object

Show Source

• conversational: boolean
  Indicates whether the trigger should use conversation context or not.
• conversationId: string
  Identifier of the conversation associated with the trigger.
• invocationMode: string
  Allowed Values: [ "ADMIN", "USER" ]

  Trigger mode for the request.
• jobId: string
  Optional job identifier associated with the trigger.
• message(required): string
  User message or query to send to the agent workflow.

{
    "required":[
        "message"
    ],
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"User message or query to send to the agent workflow."
        },
        "conversational":{
            "type":"boolean",
            "description":"Indicates whether the trigger should use conversation context or not."
        },
        "conversationId":{
            "type":"string",
            "description":"Identifier of the conversation associated with the trigger."
        },
        "invocationMode":{
            "type":"string",
            "description":"Trigger mode for the request.",
            "enum":[
                "ADMIN",
                "USER"
            ]
        },
        "jobId":{
            "type":"string",
            "description":"Optional job identifier associated with the trigger."
        }
    }
}

Nested Schema : toolsConfig

Type: object

Additional Properties Allowed: true

Tool configuration available to the agent for triggering the workflow.

Nested Schema : workflowConfig

Type: object

Additional Properties Allowed: true

The configuration used for triggering the workflow.

Back to Top

Response

Supported Media Types

• text/event-stream
• application/json

200 Response

Workflow triggered successfully. Response is streamed to the caller.

Body ()

Root Schema : InvokeStreamEvent

Type: string

Server-sent event stream containing incremental agent response chunks, tool events, metadata, and completion events.

400 Response

Could not trigger workflow because the request is invalid.

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• message: string
  Description of the error.
• status: string
  Short status code of the error.
• userDetails: string
  Instructions or hint for user to action upon.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Short status code of the error."
        },
        "message":{
            "type":"string",
            "description":"Description of the error."
        },
        "userDetails":{
            "type":"string",
            "description":"Instructions or hint for user to action upon."
        }
    }
}

401 Response

Authentication failed.

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• message: string
  Description of the error.
• status: string
  Short status code of the error.
• userDetails: string
  Instructions or hint for user to action upon.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Short status code of the error."
        },
        "message":{
            "type":"string",
            "description":"Description of the error."
        },
        "userDetails":{
            "type":"string",
            "description":"Instructions or hint for user to action upon."
        }
    }
}

404 Response

Workflow not found.

500 Response

Internal server error while triggering the workflow.

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• message: string
  Description of the error.
• status: string
  Short status code of the error.
• userDetails: string
  Instructions or hint for user to action upon.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Short status code of the error."
        },
        "message":{
            "type":"string",
            "description":"Description of the error."
        },
        "userDetails":{
            "type":"string",
            "description":"Instructions or hint for user to action upon."
        }
    }
}

Back to Top