skills.rest
deskagent-ai
deskagent-aiOFFICIAL
Explore all skills by this author →
WebsiteGitHub

DeskAgent REST API Reference

Start agents and stream task events via the DeskAgent REST API.

1|Updated Feb 26, 2026
Search Tags:#session management#REST API#cost tracking#system information#agent execution#task streaming#DeskAgent
One-click install
npx skills add https://github.com/deskagent-ai/community --skill deskagent-rest-api-reference
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: DeskAgent REST API Reference
Source: https://github.com/deskagent-ai/community/tree/main/cowork-plugin/skills/api-reference
Command: npx skills add https://github.com/deskagent-ai/community --skill deskagent-rest-api-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

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}.

Frequently Asked Questions about DeskAgent REST API Reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I integrate DeskAgent with external tools using a REST API?▼

You can integrate DeskAgent with external tools using a FastAPI-based REST API that provides endpoints for starting agents, streaming task events via Server-Sent Events, and accessing system information for automated workflows.

Can I stream real-time task updates from an agent execution?▼

Real-time task updates are streamed during agent execution via Server-Sent Events (SSE), allowing external tools to monitor task progress and capture events as they occur through the REST API.

What REST API endpoints are available for session management and history?▼

The REST API provides endpoints for managing sessions, continuing existing sessions, and retrieving session history, enabling external applications to maintain state and track agent interactions over time.

How do I track API costs and monitor system health for DeskAgent?▼

You can track API costs and monitor system health using dedicated REST API endpoints that provide cost summaries, detailed cost breakdowns, health checks, version info, and MCP status.

Do I need a running DeskAgent server to use the REST API?▼

A running and accessible DeskAgent server is required to use the REST API, as the FastAPI-based endpoints depend on the server to execute agents, manage sessions, and stream task events.

How can I secure external access to the DeskAgent REST API?▼

Secure external access to the REST API is supported through reverse proxy configurations and API key authentication, with security considerations for mitigating unauthorized access, data exposure, and CORS issues.

Related Skills

Explore More Software Engineering Skills→
delta-and-betadelta-and-beta

engineer-mcp-server

Install and configure the Braze MCP server for Braze REST API access.

Community
Advanced
freedomw1987freedomw1987
2

sse-chunk-boundary-debug

Diagnose and fix JSON parse errors from SSE chunk boundary splits.

Community
Intermediate
maruakshaymaruakshay
4

litellm-proxy-security

Audits LiteLLM proxy deployments for API key leakage and implements hardening steps.

Community
Advanced
zli5460zli5460
2

airtable

Manage Airtable records via REST API calls using curl commands.

Community
Intermediate