Run an Agent

Local

https://localhost

POST

/api/v1/agents/{agent_uuid}/run

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟢200Stream

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://localhost/api/v1/agents//run?workspace_uuid={{workspace_uuid}}' \
--header 'Accept: application/json' \
--header 'X-Multiplai-Authorization;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "provider": "openai",
    "model": "gpt-4.1-mini",
    "messages": [
        {
            "content": "Hi",
            "role": "user"
        }
    ]
}'

Response Example

200 - Success - Example 1

{
    "id": "string",
    "content": "string",
    "metadata": {
        "tool_calls": [
            {
                "id": "string",
                "function": {
                    "name": "string",
                    "arguments": "string"
                }
            }
        ]
    }
}

Modified at 2025-06-20 03:49:35

Retrieve an Agent

Train an Agent