Example request:

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (401):

cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "success": false,
    "error": "UNAUTHENTICATED",
    "message": "Authentication required.",
    "timestamp": "2026-02-10T11:16:48+00:00"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (401):

cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "success": false,
    "error": "UNAUTHENTICATED",
    "message": "Authentication required.",
    "timestamp": "2026-02-10T11:16:48+00:00"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (404):

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 300
x-ratelimit-remaining: 298
vary: Origin
 

{
    "success": false,
    "error": "NOT_FOUND",
    "message": "The requested resource was not found.",
    "timestamp": "2026-02-10T11:16:48+00:00"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (401):

cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "success": false,
    "error": "UNAUTHENTICATED",
    "message": "Authentication required.",
    "timestamp": "2026-02-10T11:16:48+00:00"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "agents": [
        {
            "id": 1,
            "name": "Direct Chat Agent",
            "description": "General purpose conversational agent",
            "agent_type": "chat",
            "ai_provider": "openai",
            "ai_model": "gpt-4",
            "is_active": true,
            "max_steps": 10,
            "tool_count": 5,
            "created_at": "2024-01-01T00:00:00.000000Z"
        }
    ]
}
 

Example response (403, Insufficient permissions):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the agent:view ability"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "agent": {
        "id": 1,
        "name": "Direct Chat Agent",
        "description": "General purpose conversational agent",
        "agent_type": "chat",
        "ai_provider": "openai",
        "ai_model": "gpt-4",
        "is_active": true,
        "max_steps": 10,
        "system_prompt": "You are a helpful AI assistant...",
        "tools": [
            "web_search",
            "calculator",
            "file_read"
        ],
        "created_at": "2024-01-01T00:00:00.000000Z",
        "updated_at": "2024-01-01T00:00:00.000000Z"
    }
}
 

Example response (404, Agent not found):

{
    "success": false,
    "error": "Not Found",
    "message": "Agent not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "agent_id": 5,
    "agent_name": "Research Agent",
    "tools": [
        {
            "name": "web_search",
            "description": "Search the web using SearXNG meta-search engine",
            "category": "research",
            "enabled": true
        },
        {
            "name": "search_knowledge",
            "description": "Query the knowledge base with semantic search",
            "category": "research",
            "enabled": true
        }
    ],
    "total": 2
}
 

Example response (403, Missing tools:view ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the tools:view ability"
}
 

Example response (403, Missing agent:view ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the agent:view ability required to access agent tools"
}
 

Example response (404, Agent Not Found):

{
    "success": false,
    "error": "Not Found",
    "message": "Agent not found"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while retrieving agent tools"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "tools": [
        {
            "name": "web_search",
            "description": "Search the web using SearXNG meta-search engine",
            "category": "research",
            "requires_auth": false
        },
        {
            "name": "search_knowledge",
            "description": "Query the knowledge base with semantic search",
            "category": "research",
            "requires_auth": false
        },
        {
            "name": "calculator",
            "description": "Perform mathematical calculations",
            "category": "calculation",
            "requires_auth": false
        }
    ],
    "total": 15
}
 

Example response (403, Missing tools:view ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the tools:view ability"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while retrieving tools"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, SSE Stream):

event: message
data: {"type": "text", "content": "Here are the best practices for Laravel routing...", "delta": true}

event: tool_call
data: {"tool": "search_knowledge", "arguments": {"query": "routing best practices"}}

event: source
data: {"title": "Laravel Docs - Routing", "url": "https://laravel.com/docs/routing", "domain": "laravel.com"}

event: artifact
data: {"type": "code", "language": "php", "content": "Route::get('/user', [UserController::class, 'index']);"}

event: heartbeat
data: {"timestamp": 1704067200}

event: complete
data: {"status": "completed", "duration_seconds": 12}
 

Example response (400, Agent Inactive):

{
    "success": false,
    "error": "Agent Inactive",
    "message": "This agent is not currently active."
}
 

Example response (403, Missing chat:create ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the chat:create ability"
}
 

Example response (404, Resource Not Found):

{
    "success": false,
    "error": "Not Found",
    "message": "The specified resource was not found"
}
 

Example response (422, File Validation Failed):

{
    "success": false,
    "error": "File Validation Failed",
    "message": "File type not allowed: executable"
}
 

Example response (500, Agent Not Found):

{
    "success": false,
    "error": "Agent Not Found",
    "message": "Direct Chat Agent not found. Please run database seeder."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (501, Not Implemented):

{
    "success": false,
    "error": "Not Implemented",
    "message": "Non-streaming chat endpoint not yet implemented. Please use /api/v1/chat/stream instead."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "session": {
        "id": 123,
        "is_kept": true
    }
}
 

Example response (403, Missing chat:manage ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the chat:manage ability"
}
 

Example response (403, Not Session Owner):

{
    "success": false,
    "error": "Forbidden",
    "message": "You do not have permission to modify this session"
}
 

Example response (404, Session Not Found):

{
    "success": false,
    "error": "Not Found",
    "message": "Chat session not found"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while updating the session"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "session": {
        "id": 123,
        "is_archived": true,
        "archived_at": "2024-01-01T12:00:00Z"
    }
}
 

Example response (403, Missing chat:manage ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the chat:manage ability"
}
 

Example response (403, Not Session Owner):

{
    "success": false,
    "error": "Forbidden",
    "message": "You do not have permission to modify this session"
}
 

Example response (404, Session Not Found):

{
    "success": false,
    "error": "Not Found",
    "message": "Chat session not found"
}
 

Example response (422, Cannot Archive Kept Session):

{
    "success": false,
    "error": "Cannot Archive Kept Session",
    "message": "Cannot archive a session marked as kept. Remove the keep flag first."
}
 

Example response (422, Already Archived):

{
    "success": false,
    "error": "Already Archived",
    "message": "This session is already archived"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while archiving the session"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "session": {
        "id": 123,
        "is_archived": false,
        "archived_at": null
    }
}
 

Example response (403, Missing chat:manage ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the chat:manage ability"
}
 

Example response (403, Not Session Owner):

{
    "success": false,
    "error": "Forbidden",
    "message": "You do not have permission to modify this session"
}
 

Example response (404, Session Not Found):

{
    "success": false,
    "error": "Not Found",
    "message": "Chat session not found"
}
 

Example response (422, Not Archived):

{
    "success": false,
    "error": "Not Archived",
    "message": "This session is not archived"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while unarchiving the session"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "session": {
        "id": 123,
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "is_public": true,
        "public_url": "https://promptlyagent.com/share/550e8400-e29b-41d4-a716-446655440000",
        "public_shared_at": "2024-01-01T12:00:00Z",
        "public_expires_at": "2024-01-31T12:00:00Z"
    }
}
 

Example response (403, Missing chat:manage ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the chat:manage ability"
}
 

Example response (403, Not Session Owner):

{
    "success": false,
    "error": "Forbidden",
    "message": "You do not have permission to modify this session"
}
 

Example response (404, Session Not Found):

{
    "success": false,
    "error": "Not Found",
    "message": "Chat session not found"
}
 

Example response (422, Already Public):

{
    "success": false,
    "error": "Already Public",
    "message": "This session is already publicly shared"
}
 

Example response (422, Invalid Expiration):

{
    "success": false,
    "error": "Validation Failed",
    "message": "Invalid request parameters",
    "errors": {
        "expires_in_days": [
            "The expires in days must be between 1 and 365."
        ]
    }
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while sharing the session"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "session": {
        "id": 123,
        "is_public": false,
        "public_shared_at": null,
        "public_expires_at": null
    }
}
 

Example response (403, Missing chat:manage ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the chat:manage ability"
}
 

Example response (403, Not Session Owner):

{
    "success": false,
    "error": "Forbidden",
    "message": "You do not have permission to modify this session"
}
 

Example response (404, Session Not Found):

{
    "success": false,
    "error": "Not Found",
    "message": "Chat session not found"
}
 

Example response (422, Not Public):

{
    "success": false,
    "error": "Not Public",
    "message": "This session is not publicly shared"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while unsharing the session"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "message": "Session deleted successfully"
}
 

Example response (403, Missing chat:delete ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the chat:delete ability"
}
 

Example response (403, Not Session Owner):

{
    "success": false,
    "error": "Forbidden",
    "message": "You do not have permission to delete this session"
}
 

Example response (404, Session Not Found):

{
    "success": false,
    "error": "Not Found",
    "message": "Chat session not found"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while deleting the session"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "sessions": [
        {
            "id": 123,
            "name": "API Chat Session",
            "title": "Discussion about Laravel",
            "uuid": "550e8400-e29b-41d4-a716-446655440000",
            "is_public": false,
            "source_type": "api",
            "is_kept": false,
            "is_archived": false,
            "archived_at": null,
            "interactions_count": 5,
            "attachments_count": 2,
            "artifacts_count": 1,
            "sources_count": 3,
            "created_at": "2024-01-01T00:00:00Z",
            "updated_at": "2024-01-01T00:15:00Z"
        }
    ],
    "filters": {
        "source_type": "all",
        "include_archived": false,
        "kept_only": false,
        "limit": 50
    }
}
 

Example response (403, Missing chat:view ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the chat:view ability"
}
 

Example response (422, Invalid Parameters):

{
    "success": false,
    "error": "Validation Failed",
    "message": "Invalid query parameters",
    "errors": {
        "per_page": [
            "The per page must be between 1 and 50."
        ]
    }
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while retrieving sessions"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "session": {
        "id": 123,
        "name": "API Chat Session",
        "title": "Discussion about Laravel routing",
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "is_public": false,
        "created_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-01T00:15:00Z"
    },
    "interactions": [
        {
            "id": 456,
            "question": "What are Laravel best practices?",
            "answer": "Here are the Laravel best practices...",
            "agent_name": "Direct Chat Agent",
            "sources": [
                {
                    "title": "Laravel Documentation",
                    "url": "https://laravel.com/docs",
                    "domain": "laravel.com"
                }
            ],
            "created_at": "2024-01-01T00:00:00Z"
        }
    ]
}
 

Example response (403, Missing chat:view ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the chat:view ability"
}
 

Example response (403, Not Session Owner):

{
    "success": false,
    "error": "Forbidden",
    "message": "You do not have permission to access this session"
}
 

Example response (404, Session Not Found):

{
    "success": false,
    "error": "Not Found",
    "message": "Chat session not found"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while retrieving the session"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success (Sync)):

{
    "success": true,
    "result": {
        "answer": "Analysis complete. Here are the findings...",
        "sources": [],
        "artifacts": []
    },
    "execution_time": 5.2
}
 

Example response (200, Success (Async)):

{
    "success": true,
    "execution_id": 456,
    "status": "queued",
    "message": "Trigger execution started asynchronously"
}
 

Example response (403, Missing trigger:invoke ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the trigger:invoke ability"
}
 

Example response (403, Not Trigger Owner):

{
    "success": false,
    "error": "Forbidden",
    "message": "You do not have permission to invoke this trigger"
}
 

Example response (403, Trigger Disabled):

{
    "success": false,
    "error": "Trigger Disabled",
    "message": "This trigger is currently disabled"
}
 

Example response (422, Validation Failed):

{
    "success": false,
    "error": "Validation Failed",
    "message": "Invalid input format",
    "errors": {
        "input": [
            "The input field is required"
        ]
    }
}
 

Example response (422, Invalid Input):

{
    "success": false,
    "error": "Invalid Input",
    "message": "Input exceeds maximum length"
}
 

Example response (500, Provider Not Found):

{
    "success": false,
    "error": "Provider Not Found",
    "message": "Provider 'custom_provider' is not registered"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, SSE Stream):

event: message
data: {"type": "text", "content": "Analysis complete. Here are the key findings...", "delta": true}

event: tool_call
data: {"tool": "search_knowledge", "arguments": {"query": "data analysis"}}

event: source
data: {"title": "Data Analysis Guide", "url": "https://example.com/guide", "domain": "example.com"}

event: heartbeat
data: {"timestamp": 1704067200}

event: complete
data: {"status": "completed", "duration_seconds": 8}
 

Example response (403, Missing trigger:invoke ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the trigger:invoke ability"
}
 

Example response (403, Missing trigger:attach for files):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the trigger:attach ability required for file uploads"
}
 

Example response (403, Missing trigger:tools for override):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the trigger:tools ability required for tool override"
}
 

Example response (403, Not Trigger Owner):

{
    "success": false,
    "error": "Forbidden",
    "message": "You do not have permission to invoke this trigger"
}
 

Example response (403, Trigger Disabled):

{
    "success": false,
    "error": "Trigger Disabled",
    "message": "This trigger is currently disabled"
}
 

Example response (422, File Validation Failed):

{
    "success": false,
    "error": "File Validation Failed",
    "message": "File type not allowed: executable"
}
 

Example response (422, Invalid Tool Override):

{
    "success": false,
    "error": "Invalid Tool Override",
    "message": "Tool 'invalid_tool' not available for this agent",
    "details": []
}
 

Example response (422, Validation Failed):

{
    "success": false,
    "error": "Validation Failed",
    "message": "Invalid input format",
    "errors": {}
}
 

Example response (500, Provider Not Found):

{
    "success": false,
    "error": "Provider Not Found",
    "message": "Provider 'custom_provider' is not registered"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "triggers": [
        {
            "id": 1,
            "name": "Daily Report Generator",
            "description": "Generates daily analytics reports",
            "provider": "schedule",
            "is_active": true,
            "agent_name": "Report Agent",
            "usage_count": 42,
            "last_invoked_at": "2024-01-01T10:00:00Z",
            "api_url": "https://promptlyagent.com/api/input-triggers/1"
        }
    ]
}
 

Example response (403, Missing trigger:status ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the trigger:status ability"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while retrieving triggers"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "trigger": {
        "id": 1,
        "name": "Daily Report Generator",
        "description": "Generates daily analytics reports",
        "provider": "schedule",
        "is_active": true,
        "agent_id": 5,
        "agent_name": "Report Agent",
        "session_strategy": "continue_last",
        "usage_count": 42,
        "last_invoked_at": "2024-01-01T10:00:00Z",
        "rate_limits": {
            "max_per_minute": 10
        },
        "created_at": "2023-12-01T00:00:00Z"
    },
    "provider_info": {
        "name": "Schedule",
        "description": "Scheduled triggers",
        "icon": "⏰"
    }
}
 

Example response (403, Missing trigger:status ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the trigger:status ability"
}
 

Example response (403, Not Trigger Owner):

{
    "success": false,
    "error": "Forbidden",
    "message": "You do not have permission to view this trigger"
}
 

Example response (404, Trigger Not Found):

{
    "success": false,
    "error": "Not Found",
    "message": "Trigger not found"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while retrieving trigger information"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Will Create New Session):

{
    "success": true,
    "session_id": null,
    "is_existing": false,
    "will_create": true,
    "session_name": "⏰ Daily Report Generator",
    "strategy": "new_each"
}
 

Example response (200, Will Continue Existing):

{
    "success": true,
    "session_id": 123,
    "session_name": "Daily Report Generator",
    "is_existing": true,
    "will_create": false,
    "strategy": "continue_last",
    "interactions_count": 15
}
 

Example response (403, Missing trigger:status ability):

{
    "success": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the trigger:status ability"
}
 

Example response (403, Not Trigger Owner):

{
    "success": false,
    "error": "Forbidden",
    "message": "You do not have permission to access this trigger"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Server Error",
    "message": "An error occurred while resolving the session"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Session Valid):

{
    "success": true,
    "valid": true,
    "session": {
        "id": 123,
        "name": "Daily Report Generator",
        "url": "https://promptlyagent.com/dashboard/research-chat/123",
        "strategy_used": "validated"
    }
}
 

Example response (200, Session Resolved):

{
    "success": true,
    "valid": true,
    "session": {
        "id": 456,
        "name": "Report Session",
        "url": "https://promptlyagent.com/dashboard/research-chat/456",
        "strategy_used": "continue_last"
    }
}
 

Example response (200, No Session Available):

{
    "success": true,
    "valid": true,
    "session": null,
    "message": "No existing session available",
    "strategy": "new_each",
    "url_pattern": "https://promptlyagent.com/dashboard/research-chat/<id>"
}
 

Example response (403, Missing trigger:status ability):

{
    "success": false,
    "valid": false,
    "error": "Unauthorized",
    "message": "Your API token does not have the trigger:status ability"
}
 

Example response (403, Not Trigger Owner):

{
    "success": false,
    "valid": false,
    "error": "Forbidden",
    "message": "You do not have permission to access this trigger"
}
 

Example response (404, Session Not Found):

{
    "success": false,
    "valid": false,
    "session": null,
    "message": "Session not found"
}
 

Example response (404, Session Not Owned):

{
    "success": false,
    "valid": false,
    "session": null,
    "message": "Session does not belong to you"
}
 

Example response (404, Session Wrong Trigger):

{
    "success": false,
    "valid": false,
    "session": null,
    "message": "Session does not belong to this trigger"
}
 

Example response (500, Server Error):

{
    "success": false,
    "valid": false,
    "error": "Internal Server Error",
    "message": "Failed to validate session"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "triggers": [
        {
            "id": 1,
            "name": "GitHub Push Webhook",
            "config": {
                "provider": "webhook",
                "description": "Trigger on push events"
            },
            "webhook_url": "https://example.com/webhooks/triggers/1",
            "webhook_secret": "whs_abc123xyz456"
        }
    ]
}
 

Example response (401, Unauthenticated):

{
    "message": "Unauthenticated."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "id": 1,
    "name": "GitHub Push Webhook",
    "config": {
        "provider": "webhook",
        "description": "Trigger on push events"
    },
    "webhook_url": "https://example.com/webhooks/triggers/1",
    "webhook_secret": "whs_abc123xyz456"
}
 

Example response (401, Unauthenticated):

{
    "message": "Unauthenticated."
}
 

Example response (404, Not Found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (201, Success):

{
    "success": true,
    "data": {
        "id": 1,
        "title": "Laravel Best Practices",
        "content_type": "text",
        "privacy_level": "private",
        "processing_status": "completed",
        "created_at": "2024-01-01T00:00:00Z"
    },
    "message": "Knowledge document created successfully"
}
 

Example response (422, File Validation Failed):

{
    "success": false,
    "error": "FILE_VALIDATION_FAILED",
    "message": "File type not allowed: executable"
}
 

Example response (500, Creation Failed):

{
    "success": false,
    "error": "CREATION_FAILED",
    "message": "Failed to create document"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": {
        "content": "Laravel is a web application framework...",
        "title": "Laravel Documentation",
        "description": "The PHP framework for web artisans",
        "tags": [
            "framework",
            "php"
        ],
        "metadata": {
            "author": "Laravel",
            "published_at": "2024-01-01"
        }
    }
}
 

Example response (403, SSRF Blocked):

{
    "success": false,
    "error": "SSRF_BLOCKED",
    "message": "Access to this URL is not allowed for security reasons"
}
 

Example response (422, Validation Failed):

{
    "success": false,
    "error": "VALIDATION_ERROR",
    "message": "URL parameter is required"
}
 

Example response (422, Invalid URL):

{
    "success": false,
    "error": "VALIDATION_ERROR",
    "message": "Invalid URL format"
}
 

Example response (500, Extraction Failed):

{
    "success": false,
    "error": "Failed to extract content from URL: Connection timeout"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": {
        "context": "[Source: Laravel Queues Guide]\nLaravel queues provide a unified API for background job processing...\n\n[Source: Redis Configuration]\nTo use Redis as your queue driver, set QUEUE_CONNECTION=redis...",
        "query": "How do I configure Laravel queues?",
        "total_sources": 2,
        "sources": [
            {
                "id": 1,
                "title": "Laravel Queues Guide",
                "relevance_score": 0.8,
                "document_type": "text"
            },
            {
                "id": 5,
                "title": "Redis Configuration",
                "relevance_score": 0.8,
                "document_type": "file"
            }
        ]
    }
}
 

Example response (200, No Sources Found):

{
    "success": true,
    "data": {
        "context": "",
        "query": "obscure query with no matches",
        "total_sources": 0,
        "sources": []
    }
}
 

Example response (403, Missing Ability):

{
    "success": false,
    "error": "Unauthorized"
}
 

Example response (500, Failed):

{
    "success": false,
    "error": "RAG query failed"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": {
        "context": "[Source: Laravel Queues Guide]\nLaravel queues provide a unified API...",
        "query": "How do I configure Laravel queues?",
        "total_sources": 2,
        "sources": [
            {
                "id": 1,
                "title": "Laravel Queues Guide",
                "relevance_score": 0.8,
                "document_type": "text"
            }
        ]
    }
}
 

Example response (403, Missing Ability):

{
    "success": false,
    "error": "Unauthorized"
}
 

Example response (500, Failed):

{
    "success": false,
    "error": "RAG query failed"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, SSE Stream):

event: message
data: {"type": "context_retrieved", "sources_found": 3}

data: {"type": "source", "data": {"id": 1, "title": "Laravel Queues Guide", "score": 0.8}}

data: {"type": "source", "data": {"id": 5, "title": "Redis Configuration", "score": 0.8}}

data: {"type": "context", "data": "[Source: Laravel Queues Guide]\nLaravel queues provide..."}

data: {"type": "done"}
 

Example response (200, SSE Error):

event: message
data: {"type": "error", "message": "RAG streaming failed"}
 

Example response (403, Missing Ability):

{
    "error": "Unauthorized",
    "message": "Your API token does not have the knowledge:rag ability"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": {
        "deleted_count": 3,
        "total_requested": 5,
        "errors": [
            "Document 2 not found",
            "Access denied for document 4"
        ]
    },
    "message": "Successfully deleted 3 documents"
}
 

Example response (403, Missing Ability):

{
    "success": false,
    "error": "Unauthorized"
}
 

Example response (500, Operation Failed):

{
    "success": false,
    "error": "Bulk delete failed"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": {
        "assigned_count": 4,
        "total_requested": 5,
        "tag": {
            "id": 1,
            "name": "important",
            "color": "zinc"
        },
        "errors": [
            "Access denied for document 3"
        ]
    },
    "message": "Successfully assigned tag 'important' to 4 documents"
}
 

Example response (500, Operation Failed):

{
    "success": false,
    "error": "Bulk assign tag failed"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": {
        "processed": 25,
        "successful": 23,
        "failed": 2,
        "failed_documents": [
            {
                "id": 10,
                "error": "Content too large"
            },
            {
                "id": 15,
                "error": "Invalid format"
            }
        ]
    },
    "message": "Processed 25 documents. Successful: 23, Failed: 2"
}
 

Example response (500, Failed):

{
    "success": false,
    "error": "Failed to regenerate embeddings"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": {
        "chunk_count": 150,
        "generated_at": "2024-01-01T12:00:00Z",
        "embedding_model": "text-embedding-ada-002"
    },
    "message": "Document embedding regenerated successfully"
}
 

Example response (403, Missing Ability):

{
    "success": false,
    "error": "Unauthorized"
}
 

Example response (403, No Permission):

{
    "success": false,
    "error": "You do not have permission to modify this document"
}
 

Example response (500, Failed):

{
    "success": false,
    "error": "Failed to regenerate embedding"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success (Sync)):

{
    "success": true,
    "data": {
        "chunks_processed": 150,
        "embeddings_generated": 150
    },
    "message": "Document reprocessed successfully"
}
 

Example response (202, Success (Async)):

{
    "success": true,
    "status": "processing",
    "job_id": "job_abc123",
    "status_url": "/api/v1/knowledge/1"
}
 

Example response (403, Unauthorized):

{
    "success": false,
    "error": "You do not have permission to reprocess this document"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Failed to reprocess document"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": null,
    "message": "Document refresh queued successfully"
}
 

Example response (403, Unauthorized):

{
    "success": false,
    "error": "You do not have permission to refresh this document"
}
 

Example response (422, Not Refreshable):

{
    "success": false,
    "error": "INVALID_DOCUMENT",
    "message": "Document is not refreshable"
}
 

Example response (422, No External URL):

{
    "success": false,
    "error": "INVALID_DOCUMENT",
    "message": "Document does not have an external source URL"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Failed to queue document refresh"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": [
        {
            "id": 1,
            "title": "Laravel Routing Guide",
            "content": "Laravel routing allows you to...",
            "score": 1,
            "created_at": "2024-01-01T00:00:00Z"
        }
    ]
}
 

Example response (500, Search Failed):

{
    "success": false,
    "error": "Search failed"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": [
        {
            "id": 1,
            "title": "Laravel HTTP Client",
            "content": "The Laravel HTTP client...",
            "score": 0.95,
            "created_at": "2024-01-01T00:00:00Z"
        }
    ]
}
 

Example response (500, Search Failed):

{
    "success": false,
    "error": "Search failed"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": [
        {
            "id": 1,
            "title": "Authentication Middleware",
            "content": "Laravel middleware...",
            "score": 0.98,
            "created_at": "2024-01-01T00:00:00Z"
        }
    ]
}
 

Example response (500, Search Failed):

{
    "success": false,
    "error": "Search failed"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": [
        {
            "id": 2,
            "title": "Laravel Routing Advanced",
            "content": "Advanced routing techniques...",
            "score": 0.8
        }
    ]
}
 

Example response (500, Failed):

{
    "success": false,
    "error": "Failed to find similar documents"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (201, Success):

{
    "success": true,
    "data": {
        "id": 1,
        "name": "laravel",
        "description": "Laravel framework documentation and guides",
        "color": "blue",
        "created_at": "2024-01-01T00:00:00Z"
    },
    "message": "Tag created successfully"
}
 

Example response (403, Missing Ability):

{
    "success": false,
    "error": "Unauthorized"
}
 

Example response (422, Validation Failed):

{
    "success": false,
    "error": "Validation failed",
    "errors": {
        "name": [
            "The name field is required."
        ]
    }
}
 

Example response (500, Failed):

{
    "success": false,
    "error": "Failed to create tag"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": {
        "id": 1,
        "title": "Laravel Guide",
        "tags": [
            {
                "id": 1,
                "name": "laravel"
            },
            {
                "id": 2,
                "name": "php"
            }
        ]
    },
    "message": "Tags added to document successfully"
}
 

Example response (403, No Permission):

{
    "success": false,
    "error": "You do not have permission to modify this document"
}
 

Example response (422, Validation Failed):

{
    "success": false,
    "error": "Validation failed",
    "errors": {
        "tag_ids": [
            "The tag ids field is required."
        ]
    }
}
 

Example response (500, Failed):

{
    "success": false,
    "error": "Failed to add tags"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": null,
    "message": "Document assigned to agent successfully"
}
 

Example response (403, Missing Ability):

{
    "success": false,
    "error": "Unauthorized"
}
 

Example response (403, No Permission):

{
    "success": false,
    "error": "You do not have permission to modify this document"
}
 

Example response (422, Validation Failed):

{
    "success": false,
    "error": "Validation failed",
    "errors": {
        "agent_id": [
            "The agent id field is required."
        ]
    }
}
 

Example response (500, Failed):

{
    "success": false,
    "error": "Failed to assign document to agent"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": null,
    "message": "Document unassigned from agent successfully"
}
 

Example response (403, Missing Ability):

{
    "success": false,
    "error": "Unauthorized"
}
 

Example response (403, No Permission):

{
    "success": false,
    "error": "You do not have permission to modify this document"
}
 

Example response (500, Failed):

{
    "success": false,
    "error": "Failed to unassign document from agent"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": {
        "id": 1,
        "title": "Updated Laravel Guide",
        "privacy_level": "public"
    },
    "message": "Knowledge document updated successfully"
}
 

Example response (403, Unauthorized):

{
    "success": false,
    "error": "You do not have permission to update this document"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Failed to update document"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": null,
    "message": "Knowledge document deleted successfully"
}
 

Example response (403, Unauthorized):

{
    "success": false,
    "error": "You do not have permission to delete this document"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Failed to delete document"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": [
        {
            "id": 1,
            "title": "Laravel Documentation",
            "description": "Comprehensive Laravel guide",
            "content_type": "external",
            "privacy_level": "public",
            "processing_status": "completed",
            "url": "https://laravel.com/docs",
            "domain": "laravel.com",
            "tags": [
                {
                    "id": 1,
                    "name": "laravel"
                }
            ],
            "created_at": "2024-01-01T00:00:00Z",
            "updated_at": "2024-01-01T00:00:00Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "per_page": 50,
        "total": 100
    }
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Failed to retrieve documents"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": [
        {
            "id": 1,
            "title": "Laravel Documentation",
            "content_type": "external",
            "created_at": "2024-01-01T00:00:00Z"
        }
    ]
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Failed to retrieve recent documents"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, URL Exists):

{
    "success": true,
    "exists": true,
    "document": {
        "id": 1,
        "title": "Laravel Documentation",
        "url": "https://laravel.com/docs"
    }
}
 

Example response (200, URL Not Found):

{
    "success": true,
    "exists": false,
    "document": null
}
 

Example response (422, Missing URL):

{
    "success": false,
    "error": "VALIDATION_ERROR",
    "message": "URL parameter is required"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Failed to check URL"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": {
        "id": 1,
        "title": "Laravel Documentation",
        "description": "Comprehensive guide",
        "content": "Laravel is a web application framework...",
        "content_type": "external",
        "privacy_level": "public",
        "processing_status": "completed",
        "url": "https://laravel.com/docs",
        "embedding_status": {
            "has_embeddings": true,
            "chunk_count": 150,
            "last_embedded_at": "2024-01-01T00:00:00Z"
        },
        "tags": [
            {
                "id": 1,
                "name": "laravel"
            }
        ],
        "created_at": "2024-01-01T00:00:00Z"
    }
}
 

Example response (403, Unauthorized):

{
    "success": false,
    "error": "You do not have permission to view this document"
}
 

Example response (500, Server Error):

{
    "success": false,
    "error": "Failed to retrieve document"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

(binary file download)
 

Example response (403, Unauthorized):

Forbidden
 

Example response (404, Not a File):

File not found
 

Example response (404, File Missing):

File not found
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

Example response (200, Success):

{
    "success": true,
    "data": {
        "statistics": {
            "total_documents": 1000,
            "documents_with_embeddings": 950,
            "documents_without_embeddings": 50,
            "total_chunks": 15000,
            "avg_chunks_per_document": 15.8
        },
        "documents": [
            {
                "id": 1,
                "title": "Laravel Guide",
                "has_embeddings": true,
                "chunk_count": 150
            }
        ]
    }
}
 

Example response (403, Missing Ability):

{
    "success": false,
    "error": "Unauthorized"
}
 

Example response (500, Failed):

{
    "success": false,
    "error": "Failed to retrieve embedding status"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.