Athena
Home
Environments
Environments
  • Development Server
  • Production
Home
Environments
Environments
  • Development Server
  • Production
  1. Thread
  • 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
        GET
      • Retrieve a Thread
        GET
      • Update a Thread
        PUT
      • Delete a Thread
        DELETE
      • Create a Thread
        POST
      • Run a Thread
        POST
      • Generate Thread Name
        POST
    • Message
      • Get Messages
      • Retrieve a Message
      • Update a Message
      • Delete a Message
      • Create a Message
    • 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. Thread

Create a Thread

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

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query 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/threads?workspace_uuid={{workspace_uuid}}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspace_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Customer Support Conversation",
    "agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "with": "Product inquiry about pricing plans",
    "metadata": {
        "model": "gpt-4",
        "property1": "string",
        "property2": "string"
    }
}'
Response Response Example
{
    "data": {
        "uuid": "8a38e84b-6fb3-490c-b5c2-f543bc67dae9",
        "name": "Kayla Mante",
        "created_at": "2025-06-19T03:32:11.070Z",
        "updated_at": "2025-05-27",
        "metadata": {
            "model": "claude-3",
            "temperature": 1.0243947521731562,
            "max_tokens": 78933936,
            "system_prompt": null,
            "conversation_style": "creative",
            "aliqua_19": -55322203.15275844
        },
        "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"
                            }
                        ]
                    }
                },
                "is_owner": true,
                "created_at": "2024-01-15T10:30:00Z",
                "updated_at": "2024-01-15T14:45:00Z",
                "user": null
            }
        },
        "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": "🌽",
                "background_color": "#0ef1eb",
                "preference": "emoji"
            },
            "visibility": "workspace",
            "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": "steady",
                "openai_voice": "nova",
                "large_language_model": "gpt-4",
                "memory": true,
                "knowledge": true,
                "web_search": false
            },
            "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": {
                    "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"
                                }
                            ]
                        }
                    },
                    "is_owner": true,
                    "created_at": "2024-01-15T10:30:00Z",
                    "updated_at": "2024-01-15T14:45:00Z",
                    "user": null
                }
            },
            "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"
                            }
                        ]
                    }
                },
                "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": null
                }
            },
            "tools": null,
            "workflows": null,
            "shares": [
                {
                    "entity_type": "workspace",
                    "entity": null,
                    "permission": "write"
                }
            ]
        },
        "attachments": null
    }
}
Modified at 2025-06-20 02:25:39
Previous
Delete a Thread
Next
Run a Thread
Built with