Athena
Home
Environments
Environments
  • Development Server
  • Production
Home
Environments
Environments
  • Development Server
  • Production
  1. Message
  • Getting Started
    • Start Guide
  • Installation & Setup
    • Windows
  • Architecture
  • Guide
    • Bundles
      • Backend
    • Permissions
      • Frontend
    • Developers
      • Commit Lint
      • RESTful API
    • Workflows
      • Workflow Variables
  • API Reference
    • Authentication
      • Sign In
      • Logout
    • User
      • Get Authenticated User using Multiplai App Access Token
      • Get Authenticated User using Basic Token
    • Workspace
      • Get Workspaces Metrics
      • Get Workspaces
      • Update a Workspace
      • Retrieve a workspace
      • Delete a Workspace
    • Provider
      • Get Providers
      • Retrieve a Provider
      • Update a Provider
      • Create a Provider
      • Delete a Provider
    • Account
      • Get Accounts
      • Update an Account
      • Create an Account
      • Delete an Account
      • Retrieve an Account
    • Agent
      • Get Agents
      • Update an Agent
      • Create an Agent
      • Delete an Agent
      • Retrieve an Agent
      • Run an Agent
      • Train an Agent
      • Generate an Agent
      • Share Agent
      • Get Agent Leaderboard
    • Workflow
      • Get Workflows
      • Create a Workflow
      • Retrieve a Workflow
      • Update a Workflow
      • Delete a Workflow
      • Trigger a webhook
      • Share Workflow
      • Generate Workflow
    • Workflow Execution
      • Get Workflow Executions
      • Get Workflow Execution Counts
      • Retrieve a Workflow Execution
      • Delete a Workflow Execution
    • Prompt
      • Get Prompts
      • Create a Prompt
      • Retrieve a Prompt
      • Update a Prompt
      • Delete a Prompt
      • Run a prompt
    • Memory
      • Get Memories
      • Retrieve a Memory
      • Update a Memory
      • Delete a Memory
    • Thread
      • Get Threads
      • Retrieve a Thread
      • Update a Thread
      • Delete a Thread
      • Create a Thread
      • Run a Thread
      • Generate Thread Name
    • Message
      • Get Messages
        GET
      • Retrieve a Message
        GET
      • Update a Message
        PUT
      • Delete a Message
        DELETE
      • Create a Message
        POST
    • Large Language Model
      • Get Large Language Models
      • Retrieve a Large Language Model
    • Command Room Task
      • Store Command Room Task
      • Remove Command Room Task
    • Metrics
      • Get Agents Metrics
      • Get Workflows Metrics
      • Get Threads Metrics
      • Get Messages Metrics
      • Get Workflow Executions Metrics
  • Schemas
    • Resources
      • User
      • Workspace
      • Provider
      • Account
      • Agent
      • Workflow
      • Share
      • WorkflowExecution
      • WorkflowExecutionData
      • Prompt
      • Memory
      • Thread
      • Attachment
      • Media
      • Tool
      • Message
      • LargeLanguageModel
      • AgentLeaderboard
    • Utils
      • Pagination
        • PaginationMeta
        • PaginationLinks
      • Provider
        • AuthenticationConfig
      • Profile
        • ProfilePhotoConfig
      • Workflow
        • WorkflowExecutionDataWorkflowData
        • Node
        • Edge
  1. Message

Create a Message

Local
https://localhost
Local
https://localhost
POST
/api/v1/messages

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Header Params

Body Params application/json

Examples

Responses

🟢201Created
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://localhost/api/v1/messages?workspace_uuid={{workspace_uuid}}&thread_uuid={{thread_uuid}}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "thread_uuid": "c2c8bf89-c607-4c7c-82f9-c6415a0447e9",
    "content": "string",
    "role": "user",
    "files": [
        {
            "key": "string",
            "name": "string"
        }
    ]
}'
Response Response Example
{
    "data": {
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "content": "Hello! How can I help you today?",
        "role": "user",
        "created_at": "2024-01-15T10:30:00.000000Z",
        "updated_at": "2024-01-15T10:30:00.000000Z",
        "metadata": {
            "model": "gpt-4-turbo",
            "temperature": 0.7,
            "tokens": {
                "input": 150,
                "output": 75,
                "total": 225
            }
        },
        "thread": {
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
            "name": "string",
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "metadata": {
                "model": "gpt-4",
                "temperature": 0,
                "max_tokens": 1,
                "system_prompt": "string",
                "conversation_style": "casual",
                "property1": "string",
                "property2": "string"
            },
            "creator": {
                "id": 123,
                "name": "John Doe",
                "first_name": "John",
                "last_name": "Doe",
                "email": "john.doe@example.com",
                "profile_photo_url": "https://example.com/storage/photos/user-123.jpg",
                "multiplai_id": "multiplai_abc123def456",
                "created_at": "2024-01-15T10:30:00Z",
                "updated_at": "2024-01-15T14:45:00Z",
                "primary_workspace": {
                    "uuid": "550e8400-e29b-41d4-a716-446655440000",
                    "slug": "my-ai-workspace",
                    "name": "My AI Workspace",
                    "profile_photo_url": "https://example.com/storage/workspaces/workspace-123.jpg",
                    "multiplai_id": "multiplai_workspace_abc123",
                    "is_onboarded": true,
                    "metadata": {
                        "onboarding_step": 75,
                        "sources": [
                            "google_search",
                            "social_media",
                            "referral"
                        ],
                        "affiliate_name": "John Doe Marketing",
                        "role": "Product Manager",
                        "industry": "Technology",
                        "tools": [
                            "slack",
                            "notion",
                            "github"
                        ],
                        "ai_tools": {
                            "agents": [
                                {
                                    "emoji": "🤖",
                                    "name": "Customer Support Bot",
                                    "description": "Handles customer inquiries and support tickets"
                                }
                            ],
                            "prompts": [
                                {
                                    "emoji": "✍️",
                                    "name": "Email Writer",
                                    "description": "Generates professional email responses"
                                }
                            ],
                            "workflows": [
                                {
                                    "emoji": "⚡",
                                    "name": "Lead Processing",
                                    "description": "Automatically processes and qualifies incoming leads"
                                }
                            ]
                        },
                        "property1": "string",
                        "property2": "string"
                    },
                    "is_owner": true,
                    "created_at": "2024-01-15T10:30:00Z",
                    "updated_at": "2024-01-15T14:45:00Z",
                    "user": {}
                }
            },
            "agent": {
                "uuid": "550e8400-e29b-41d4-a716-446655440000",
                "name": "Customer Support Assistant",
                "description": "An AI assistant specialized in handling customer support inquiries and providing helpful responses.",
                "instruction": "You are a helpful customer support agent. Always be polite, empathetic, and provide clear solutions to customer problems.",
                "profile_photo_url": "https://example.com/storage/agents/agent-123.jpg",
                "profile_photo_config": {
                    "emoji": "string",
                    "background_color": "string",
                    "preference": "string"
                },
                "visibility": "public",
                "metadata": {
                    "role": "Customer Support Specialist",
                    "goal_statement": "To provide exceptional customer service by quickly resolving issues and ensuring customer satisfaction.",
                    "backstory": "You have 5 years of experience in customer service and are known for your patience and problem-solving skills.",
                    "guardrails": "Never share personal customer information. Always escalate complex technical issues to human agents.",
                    "base_instructions": "Always greet customers warmly. Listen carefully to their concerns. Provide step-by-step solutions.",
                    "conversation_starters": [
                        "Hello! How can I help you today?",
                        "I'm here to assist you with any questions or concerns you may have.",
                        "What brings you here today? I'm ready to help!"
                    ],
                    "greetings": "Welcome! I'm your friendly customer support assistant. How may I assist you today?",
                    "tone_of_voice": "Professional yet friendly, empathetic, and solution-focused. Use clear and simple language.",
                    "disc_personality": "dominant",
                    "openai_voice": "alloy",
                    "large_language_model": "gpt-4",
                    "memory": true,
                    "knowledge": true,
                    "web_search": false,
                    "property1": "string",
                    "property2": "string"
                },
                "is_owner": true,
                "created_at": "2024-01-15T10:30:00Z",
                "updated_at": "2024-01-15T14:45:00Z",
                "workflows_count": 0,
                "tools_count": 0,
                "threads_count": 0,
                "last_used_at": "2019-08-24T14:15:22.123Z",
                "usage_count": 0,
                "usage_frequency": "hourly",
                "user": {
                    "id": 123,
                    "name": "John Doe",
                    "first_name": "John",
                    "last_name": "Doe",
                    "email": "john.doe@example.com",
                    "profile_photo_url": "https://example.com/storage/photos/user-123.jpg",
                    "multiplai_id": "multiplai_abc123def456",
                    "created_at": "2024-01-15T10:30:00Z",
                    "updated_at": "2024-01-15T14:45:00Z",
                    "primary_workspace": {
                        "uuid": "550e8400-e29b-41d4-a716-446655440000",
                        "slug": "my-ai-workspace",
                        "name": "My AI Workspace",
                        "profile_photo_url": "https://example.com/storage/workspaces/workspace-123.jpg",
                        "multiplai_id": "multiplai_workspace_abc123",
                        "is_onboarded": true,
                        "metadata": {
                            "onboarding_step": 75,
                            "sources": [
                                "google_search",
                                "social_media",
                                "referral"
                            ],
                            "affiliate_name": "John Doe Marketing",
                            "role": "Product Manager",
                            "industry": "Technology",
                            "tools": [
                                "slack",
                                "notion",
                                "github"
                            ],
                            "ai_tools": {
                                "agents": [
                                    {
                                        "emoji": "🤖",
                                        "name": "Customer Support Bot",
                                        "description": "Handles customer inquiries and support tickets"
                                    }
                                ],
                                "prompts": [
                                    {
                                        "emoji": "✍️",
                                        "name": "Email Writer",
                                        "description": "Generates professional email responses"
                                    }
                                ],
                                "workflows": [
                                    {
                                        "emoji": "⚡",
                                        "name": "Lead Processing",
                                        "description": "Automatically processes and qualifies incoming leads"
                                    }
                                ]
                            },
                            "property1": "string",
                            "property2": "string"
                        },
                        "is_owner": true,
                        "created_at": "2024-01-15T10:30:00Z",
                        "updated_at": "2024-01-15T14:45:00Z",
                        "user": {}
                    }
                },
                "workspace": {
                    "uuid": "550e8400-e29b-41d4-a716-446655440000",
                    "slug": "my-ai-workspace",
                    "name": "My AI Workspace",
                    "profile_photo_url": "https://example.com/storage/workspaces/workspace-123.jpg",
                    "multiplai_id": "multiplai_workspace_abc123",
                    "is_onboarded": true,
                    "metadata": {
                        "onboarding_step": 75,
                        "sources": [
                            "google_search",
                            "social_media",
                            "referral"
                        ],
                        "affiliate_name": "John Doe Marketing",
                        "role": "Product Manager",
                        "industry": "Technology",
                        "tools": [
                            "slack",
                            "notion",
                            "github"
                        ],
                        "ai_tools": {
                            "agents": [
                                {
                                    "emoji": "🤖",
                                    "name": "Customer Support Bot",
                                    "description": "Handles customer inquiries and support tickets"
                                }
                            ],
                            "prompts": [
                                {
                                    "emoji": "✍️",
                                    "name": "Email Writer",
                                    "description": "Generates professional email responses"
                                }
                            ],
                            "workflows": [
                                {
                                    "emoji": "⚡",
                                    "name": "Lead Processing",
                                    "description": "Automatically processes and qualifies incoming leads"
                                }
                            ]
                        },
                        "property1": "string",
                        "property2": "string"
                    },
                    "is_owner": true,
                    "created_at": "2024-01-15T10:30:00Z",
                    "updated_at": "2024-01-15T14:45:00Z",
                    "user": {
                        "id": 123,
                        "name": "John Doe",
                        "first_name": "John",
                        "last_name": "Doe",
                        "email": "john.doe@example.com",
                        "profile_photo_url": "https://example.com/storage/photos/user-123.jpg",
                        "multiplai_id": "multiplai_abc123def456",
                        "created_at": "2024-01-15T10:30:00Z",
                        "updated_at": "2024-01-15T14:45:00Z",
                        "primary_workspace": {}
                    }
                },
                "tools": [
                    {
                        "uuid": "456e7890-e12b-34c5-d678-901234567890",
                        "name": "Email Sender",
                        "description": "Send emails through various providers",
                        "type": "api",
                        "profile_photo_url": "http://example.com",
                        "profile_photo_config": {},
                        "visibility": "public",
                        "credits": 0,
                        "is_owner": true,
                        "metadata": {},
                        "created_at": "2019-08-24T14:15:22.123Z",
                        "updated_at": "2019-08-24T14:15:22.123Z",
                        "pivot_account": {}
                    }
                ],
                "workflows": [
                    {
                        "uuid": "abc12345-de67-89f0-1234-567890abcdef",
                        "name": "Customer Onboarding",
                        "description": "Automated workflow for onboarding new customers",
                        "profile_photo_url": "http://example.com",
                        "profile_photo_config": {},
                        "visibility": "public",
                        "is_active": true,
                        "is_owner": true,
                        "nodes": [
                            "string"
                        ],
                        "edges": [
                            "string"
                        ],
                        "settings": {},
                        "static_data": {},
                        "pin_data": {},
                        "trigger_count": 0,
                        "created_at": "2019-08-24T14:15:22.123Z",
                        "updated_at": "2019-08-24T14:15:22.123Z",
                        "deleted_at": "2019-08-24T14:15:22.123Z"
                    }
                ],
                "shares": [
                    {
                        "entity_type": "user",
                        "entity": {
                            "id": 123,
                            "name": "John Doe",
                            "first_name": "John",
                            "last_name": "Doe",
                            "email": "john.doe@example.com",
                            "profile_photo_url": "https://example.com/storage/photos/user-123.jpg",
                            "multiplai_id": "multiplai_abc123def456",
                            "created_at": "2024-01-15T10:30:00Z",
                            "updated_at": "2024-01-15T14:45:00Z",
                            "primary_workspace": {
                                "uuid": "550e8400-e29b-41d4-a716-446655440000",
                                "slug": "my-ai-workspace",
                                "name": "My AI Workspace",
                                "profile_photo_url": "https://example.com/storage/workspaces/workspace-123.jpg",
                                "multiplai_id": "multiplai_workspace_abc123",
                                "is_onboarded": true,
                                "metadata": {
                                    "onboarding_step": 75,
                                    "sources": [
                                        "google_search",
                                        "social_media",
                                        "referral"
                                    ],
                                    "affiliate_name": "John Doe Marketing",
                                    "role": "Product Manager",
                                    "industry": "Technology",
                                    "tools": [
                                        "slack",
                                        "notion",
                                        "github"
                                    ],
                                    "ai_tools": {
                                        "agents": [
                                            {
                                                "emoji": "🤖",
                                                "name": "Customer Support Bot",
                                                "description": "Handles customer inquiries and support tickets"
                                            }
                                        ],
                                        "prompts": [
                                            {
                                                "emoji": "✍️",
                                                "name": "Email Writer",
                                                "description": "Generates professional email responses"
                                            }
                                        ],
                                        "workflows": [
                                            {
                                                "emoji": "⚡",
                                                "name": "Lead Processing",
                                                "description": "Automatically processes and qualifies incoming leads"
                                            }
                                        ]
                                    },
                                    "property1": "string",
                                    "property2": "string"
                                },
                                "is_owner": true,
                                "created_at": "2024-01-15T10:30:00Z",
                                "updated_at": "2024-01-15T14:45:00Z",
                                "user": {}
                            }
                        },
                        "permission": "read"
                    }
                ]
            },
            "attachments": [
                {
                    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                    "type": "media",
                    "created_at": "2019-08-24T14:15:22.123Z",
                    "updated_at": "2019-08-24T14:15:22.123Z",
                    "attachable": {
                        "id": 1,
                        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                        "is_finished": true,
                        "mode": "string",
                        "retry_of": "string",
                        "retry_success_id": "string",
                        "started_at": "2019-08-24T14:15:22.123Z",
                        "stopped_at": "2019-08-24T14:15:22.123Z",
                        "wait_till": "2019-08-24T14:15:22.123Z",
                        "status": "pending",
                        "created_at": "2019-08-24T14:15:22.123Z",
                        "updated_at": "2019-08-24T14:15:22.123Z",
                        "deleted_at": "2019-08-24T14:15:22.123Z",
                        "workflow": {
                            "id": 42,
                            "uuid": "550e8400-e29b-41d4-a716-446655440000",
                            "user_id": 15,
                            "workspace_id": 3,
                            "template_id": null,
                            "name": "Customer Onboarding Flow",
                            "description": "Automated workflow for onboarding new customers",
                            "profile_photo_url": null,
                            "profile_photo_config": null,
                            "visibility": "workspace",
                            "is_active": true,
                            "is_owner": true,
                            "is_favorite": false,
                            "trigger_count": 2,
                            "allow_cloning": true,
                            "allow_account_usage": false,
                            "last_used_at": "2026-02-10T14:30:00.000000Z",
                            "created_at": "2026-01-15T10:00:00.000000Z",
                            "updated_at": "2026-02-10T09:15:00.000000Z",
                            "deleted_at": null,
                            "executions_count": 156,
                            "executions_in_progress_count": 3,
                            "executions_for_review_count": 7,
                            "executions_completed_count": 142
                        },
                        "workflow_execution_data": [
                            {
                                "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                                "workflow_data": [
                                    {
                                        "status": "error",
                                        "output": {},
                                        "started_at": "2019-08-24T14:15:22.123Z",
                                        "stopped_at": "2019-08-24T14:15:22.123Z"
                                    }
                                ],
                                "metadata": {
                                    "running_node": "string",
                                    "workflow_execution_data_id": 1,
                                    "execution_time": 0,
                                    "wait_until": "2019-08-24T14:15:22.123Z",
                                    "wait_until_timestamp": 0,
                                    "wait_started_at": "2019-08-24T14:15:22.123Z",
                                    "wait_completed_at": "2019-08-24T14:15:22.123Z",
                                    "loop_index": 0,
                                    "processed_count": 0,
                                    "error_count": 0,
                                    "retry_count": 0,
                                    "property1": "string",
                                    "property2": "string"
                                },
                                "data": "string",
                                "created_at": "2019-08-24T14:15:22.123Z",
                                "updated_at": "2019-08-24T14:15:22.123Z",
                                "deleted_at": "2019-08-24T14:15:22.123Z"
                            }
                        ]
                    }
                }
            ]
        },
        "attachments": [
            {
                "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                "type": "media",
                "created_at": "2019-08-24T14:15:22.123Z",
                "updated_at": "2019-08-24T14:15:22.123Z",
                "attachable": {
                    "id": 1,
                    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                    "is_finished": true,
                    "mode": "string",
                    "retry_of": "string",
                    "retry_success_id": "string",
                    "started_at": "2019-08-24T14:15:22.123Z",
                    "stopped_at": "2019-08-24T14:15:22.123Z",
                    "wait_till": "2019-08-24T14:15:22.123Z",
                    "status": "pending",
                    "created_at": "2019-08-24T14:15:22.123Z",
                    "updated_at": "2019-08-24T14:15:22.123Z",
                    "deleted_at": "2019-08-24T14:15:22.123Z",
                    "workflow": {
                        "id": 42,
                        "uuid": "550e8400-e29b-41d4-a716-446655440000",
                        "user_id": 15,
                        "workspace_id": 3,
                        "template_id": null,
                        "name": "Customer Onboarding Flow",
                        "description": "Automated workflow for onboarding new customers",
                        "profile_photo_url": null,
                        "profile_photo_config": null,
                        "visibility": "workspace",
                        "is_active": true,
                        "is_owner": true,
                        "is_favorite": false,
                        "trigger_count": 2,
                        "allow_cloning": true,
                        "allow_account_usage": false,
                        "last_used_at": "2026-02-10T14:30:00.000000Z",
                        "created_at": "2026-01-15T10:00:00.000000Z",
                        "updated_at": "2026-02-10T09:15:00.000000Z",
                        "deleted_at": null,
                        "executions_count": 156,
                        "executions_in_progress_count": 3,
                        "executions_for_review_count": 7,
                        "executions_completed_count": 142
                    },
                    "workflow_execution_data": [
                        {
                            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                            "workflow_data": [
                                {
                                    "status": "error",
                                    "output": {},
                                    "started_at": "2019-08-24T14:15:22.123Z",
                                    "stopped_at": "2019-08-24T14:15:22.123Z"
                                }
                            ],
                            "metadata": {
                                "running_node": "string",
                                "workflow_execution_data_id": 1,
                                "execution_time": 0,
                                "wait_until": "2019-08-24T14:15:22.123Z",
                                "wait_until_timestamp": 0,
                                "wait_started_at": "2019-08-24T14:15:22.123Z",
                                "wait_completed_at": "2019-08-24T14:15:22.123Z",
                                "loop_index": 0,
                                "processed_count": 0,
                                "error_count": 0,
                                "retry_count": 0,
                                "property1": "string",
                                "property2": "string"
                            },
                            "data": "string",
                            "created_at": "2019-08-24T14:15:22.123Z",
                            "updated_at": "2019-08-24T14:15:22.123Z",
                            "deleted_at": "2019-08-24T14:15:22.123Z"
                        }
                    ]
                }
            }
        ]
    }
}
Modified at 2025-06-20 02:55:32
Previous
Delete a Message
Next
Large Language Model
Built with