DeskAgent REST API Reference

What problem does it solve?

This Skill allows users to integrate DeskAgent with external tools and services through a comprehensive REST API, enabling automation and external access to DeskAgent's functionalities.

Core Features & Use Cases

• REST API Access: Provides a FastAPI-based REST API for external integrations.
• Agent Execution: Start and manage agents with or without inputs.
• Task Streaming: Real-time task updates via Server-Sent Events (SSE).
• Discovery: List available agents, skills, backends, and agent inputs.
• Session & History: Manage sessions, continue sessions, and retrieve session history.
• System Information: Health check, version, system info, and MCP status.
• Cost Tracking: Cost summary and detailed costs.
• Examples: Python and curl examples for common operations.
• Error Handling: Standard HTTP status codes and error response format.
• Authentication & External Access: Options for secure external access, including reverse proxy and API key authentication.
• Security Considerations: Mitigation strategies for unauthorized access, data exposure, agent execution, and CORS.

Quick Start

Start an agent named 'daily_check' with inputs using the API endpoint /agent/{agent_name}.