Jump to

• Request
• Response

Stream message response

post

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

Start a streaming message invocation for a published workflow. The request method must be `message/stream`. The response is returned as Server-Sent Events whose event payloads contain JSON-RPC task updates.

Request

Path Parameters

• workflowCode(required): string
  Published workflow code.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• id: string
• jsonrpc: string
  Default Value: 2.0
• method(required): string
  Allowed Values: [ "message/stream" ]
• params(required): object MessageSendParams

{
    "type":"object",
    "required":[
        "method",
        "params"
    ],
    "properties":{
        "id":{
            "type":"string"
        },
        "jsonrpc":{
            "type":"string",
            "default":"2.0"
        },
        "method":{
            "type":"string",
            "enum":[
                "message/stream"
            ]
        },
        "params":{
            "$ref":"#/components/schemas/MessageSendParams"
        }
    }
}

Nested Schema : MessageSendParams

Type: object

Show Source

• configuration: object MessageSendConfiguration
• message: object Message
• metadata: object metadata
  Additional Properties Allowed: true

{
    "type":"object",
    "properties":{
        "message":{
            "$ref":"#/components/schemas/Message"
        },
        "configuration":{
            "$ref":"#/components/schemas/MessageSendConfiguration"
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        }
    }
}

Nested Schema : MessageSendConfiguration

Type: object

Show Source

• acceptedOutputModes: array acceptedOutputModes
• blocking: boolean
• historyLength: integer

{
    "type":"object",
    "properties":{
        "acceptedOutputModes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "historyLength":{
            "type":"integer"
        },
        "blocking":{
            "type":"boolean"
        }
    }
}

Nested Schema : Message

Type: object

Show Source

• contextId: string
  Conversation identifier. For `message/stream`, this must be nested under `params.message`.
• kind: string
  Default Value: message
• messageId: string
• metadata: object metadata
  Additional Properties Allowed: true
• parts: array parts
• role: string
  Allowed Values: [ "user", "agent" ]
• taskId: string
  Optional task identifier used for resumed or task-associated message flows.

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "enum":[
                "user",
                "agent"
            ]
        },
        "parts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TextPart"
            }
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "messageId":{
            "type":"string"
        },
        "contextId":{
            "type":"string",
            "description":"Conversation identifier. For `message/stream`, this must be nested under `params.message`."
        },
        "taskId":{
            "type":"string",
            "description":"Optional task identifier used for resumed or task-associated message flows."
        },
        "kind":{
            "type":"string",
            "default":"message"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : acceptedOutputModes

Type: array

Show Source

• Array of: string

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

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : parts

Type: array

Show Source

• Array of: object TextPart

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TextPart"
    }
}

Nested Schema : TextPart

Type: object

Show Source

• kind: string
  Default Value: text
• metadata: object metadata
  Additional Properties Allowed: true
• text: string
  Text content.
• type: string
  Part type.

  Example: text

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Part type.",
            "example":"text"
        },
        "text":{
            "type":"string",
            "description":"Text content."
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "kind":{
            "type":"string",
            "default":"text"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Back to Top

Response

Supported Media Types

• text/event-stream

200 Response

Streaming task events started.

Body ()

Root Schema : SendMessageResponse

Type: object

Show Source

• error: object JSONRPCError
• id: string
• jsonrpc: string
  Default Value: 2.0
• method: string
• result: object Task

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "jsonrpc":{
            "type":"string",
            "default":"2.0"
        },
        "method":{
            "type":"string"
        },
        "result":{
            "$ref":"#/components/schemas/Task"
        },
        "error":{
            "$ref":"#/components/schemas/JSONRPCError"
        }
    }
}

Nested Schema : JSONRPCError

Type: object

Show Source

• code: integer
  JSON-RPC error code.
• message: string
  JSON-RPC error message.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "description":"JSON-RPC error code."
        },
        "message":{
            "type":"string",
            "description":"JSON-RPC error message."
        }
    }
}

Nested Schema : Task

Type: object

Show Source

• artifacts: array artifacts
• contextId: string
• final: boolean
  Indicates whether the task update is the final update.
• history: array history
• id: string
• kind: string
  Default Value: task
• metadata: object metadata
  Additional Properties Allowed: true
• status: object TaskStatus

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "contextId":{
            "type":"string"
        },
        "status":{
            "$ref":"#/components/schemas/TaskStatus"
        },
        "artifacts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Artifact"
            }
        },
        "history":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Message"
            }
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "kind":{
            "type":"string",
            "default":"task"
        },
        "final":{
            "type":"boolean",
            "description":"Indicates whether the task update is the final update."
        }
    }
}

Nested Schema : artifacts

Type: array

Show Source

• Array of: object Artifact

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Artifact"
    }
}

Nested Schema : history

Type: array

Show Source

• Array of: object Message

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Message"
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : TaskStatus

Type: object

Show Source

• message: object Message
• state: string
  Allowed Values: [ "submitted", "working", "input-required", "completed", "canceled", "failed", "unknown" ]
• timestamp: string
  UTC timestamp string.

{
    "type":"object",
    "properties":{
        "state":{
            "$ref":"#/components/schemas/TaskState"
        },
        "message":{
            "$ref":"#/components/schemas/Message"
        },
        "timestamp":{
            "type":"string",
            "description":"UTC timestamp string."
        }
    }
}

Nested Schema : Artifact

Type: object

Show Source

• append: boolean
• artifactId: string
• description: string
• lastChunk: boolean
• metadata: object metadata
  Additional Properties Allowed: true
• name: string
• parts: array parts

{
    "type":"object",
    "properties":{
        "artifactId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "parts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TextPart"
            }
        },
        "append":{
            "type":"boolean"
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "lastChunk":{
            "type":"boolean"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : parts

Type: array

Show Source

• Array of: object TextPart

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TextPart"
    }
}

Nested Schema : TextPart

Type: object

Show Source

• kind: string
  Default Value: text
• metadata: object metadata
  Additional Properties Allowed: true
• text: string
  Text content.
• type: string
  Part type.

  Example: text

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Part type.",
            "example":"text"
        },
        "text":{
            "type":"string",
            "description":"Text content."
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "kind":{
            "type":"string",
            "default":"text"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : Message

Type: object

Show Source

• contextId: string
  Conversation identifier. For `message/stream`, this must be nested under `params.message`.
• kind: string
  Default Value: message
• messageId: string
• metadata: object metadata
  Additional Properties Allowed: true
• parts: array parts
• role: string
  Allowed Values: [ "user", "agent" ]
• taskId: string
  Optional task identifier used for resumed or task-associated message flows.

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "enum":[
                "user",
                "agent"
            ]
        },
        "parts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TextPart"
            }
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "messageId":{
            "type":"string"
        },
        "contextId":{
            "type":"string",
            "description":"Conversation identifier. For `message/stream`, this must be nested under `params.message`."
        },
        "taskId":{
            "type":"string",
            "description":"Optional task identifier used for resumed or task-associated message flows."
        },
        "kind":{
            "type":"string",
            "default":"message"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : parts

Type: array

Show Source

• Array of: object TextPart

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TextPart"
    }
}

404 Response

Workflow not found.

Back to Top