Athena
Home
Environments
Environments
  • Development Server
  • Production
Home
Environments
Environments
  • Development Server
  • Production
  1. Provider
  • 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
        GET
      • Retrieve a Provider
        GET
      • Update a Provider
        PUT
      • Create a Provider
        POST
      • Delete a Provider
        DELETE
    • 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
      • 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. Provider

Create a Provider

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

Request

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

Body Params application/json

Examples

Responses

🟢201Created
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://localhost/api/v1/providers' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "description": "string",
    "website": "http://example.com",
    "profile_photo_key": "string",
    "type": "large_language_model",
    "visibility": "public",
    "profile_photo_config": {
        "emoji": "string",
        "background_color": "string",
        "preference": "emoji"
    },
    "authentication_strategy": "token",
    "authentication_config": {
        "token": {
            "url": "string",
            "params": {},
            "body": {},
            "headers": {},
            "key": "string",
            "type": "basic"
        }
    },
    "metadata": {
        "tool_groups": [
            {
                "label": "string",
                "tools": [
                    "string"
                ]
            }
        ],
        "is_official": true,
        "is_featured": true
    },
    "with": "string"
}'
Response Response Example
{
    "data": {
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "slug": "openai-gpt",
        "name": "OpenAI GPT",
        "description": "OpenAI's GPT language model service",
        "website": "https://openai.com",
        "profile_photo_url": "https://example.com/photos/openai-logo.png",
        "profile_photo_config": {
            "emoji": "🤖",
            "background_color": "#3B82F6",
            "preference": "emoji"
        },
        "authentication_strategy": "token",
        "authentication_config": {
            "token": {
                "url": "string",
                "body": {},
                "params": {},
                "headers": {},
                "key": "string",
                "type": "basic",
                "property1": "string",
                "property2": "string"
            },
            "oauth2": {
                "url": "string",
                "client_id": "string",
                "client_secret": "string",
                "redirect_url": "string",
                "authorize_url": "string",
                "token_url": "string",
                "user_url": "string",
                "scopes": [
                    "string"
                ],
                "scope_separator": "space",
                "headers": {},
                "parameters": {},
                "property1": "string",
                "property2": "string"
            },
            "basic": {
                "url": "string",
                "headers": {},
                "params": {},
                "body": {},
                "property1": "string",
                "property2": "string"
            },
            "property1": "string",
            "property2": "string"
        },
        "is_enabled": true,
        "type": "large_language_model",
        "is_owner": true,
        "visibility": "public",
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T14:45:00Z",
        "metadata": {
            "tool_groups": [
                {
                    "label": "Text Generation",
                    "tools": [
                        "123e4567-e89b-12d3-a456-426614174000"
                    ]
                }
            ],
            "is_official": true,
            "is_featured": false,
            "property1": "string",
            "property2": "string"
        },
        "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": {}
            }
        },
        "tools_count": 5
    }
}
Modified at 2025-06-19 08:32:43
Previous
Update a Provider
Next
Delete a Provider
Built with