Test Assistant in Playground

Develop Env

http://localhost:3030

POST

/api/v1/accounts/{account_id}/aily/assistants/{id}/playground

Test an assistant with a message in the playground environment.

This endpoint creates a mock conversation and processes the message through the assistant's workflow,
returning the response and debug information.

Request

Authorization

API Key

Add parameter in header

api_access_token

Example:

api_access_token: ********************

Path Params

Body Params application/json; charset=utf-8Required

Examples

Responses

🟢200

application/json; charset=utf-8

Success - Playground response

Body

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://localhost:3030/api/v1/accounts//aily/assistants//playground' \
--header 'api_access_token: <api-key>' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "message_content": "string",
    "path_id": "string",
    "message_history": [
        {
            "role": "user",
            "content": "string"
        }
    ]
}'

Response Example

{
    "response": [
        {
            "content": "string",
            "content_type": "string",
            "created_at": "string"
        }
    ],
    "success": true,
    "debug_info": {},
    "available_paths": [
        {}
    ]
}

Modified at 2025-12-16 21:29:06

Delete an Assistant

List Inboxes for Assistant