Run a Workflow

POST

/api/v2/workflows/{workflow_id}/run

Handle POST requests to run a workflow.

Request Body:

request (Request): A JSON request object containing a workflow configuration and chat history.

Path Parameters:

workflow_id (int): The ID of the workflow to run.

Returns:

A JSON response containing the executed workflow data or an error message.

Current Version:

2.0.0

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///api/v2/workflows//run' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query_source": "web",
    "thread_id": 1,
    "chat_history": [
        {
            "user": "What regulations do we need to comply with when entering a new market and what marketing advice you want me to follow?"
        }
    ]
}'

Response Example

201 - Workflow Run Success

{
    "success": true,
    "message": "Workflow ran successfully",
    "data": {
        "agents_used": [],
        "answer": "Sorry, connected agents are unable to answer your query",
        "sources": "",
        "indexes": {},
        "references": [],
        "followup_questions": [],
        "subqueries": [
            {
                "question": "What regulations do we need to comply with when entering a new market?",
                "order": 1,
                "dependency": [],
                "agent": ""
            },
            {
                "question": "What marketing advice should I follow when entering a new market?",
                "order": 2,
                "dependency": []
            }
        ],
        "thread_name": "Updated Thread Title",
        "workflow_response_id": 9
    }
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Workflow ran successfully

Body

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Delete a Workflow Response

Create a Workflow Feedback