Frontend API Docs

ResearchX now ships an OpenAPI-backed frontend API registry so the web app's callable endpoints can be browsed in one place.

Entry Points

• Swagger UI: /swagger
• OpenAPI JSON: /openapi.json

Agent-Facing Guides

• LLM API Guide: end-to-end project, workspace, agent ticket, and permission flow
• Data Analysis API Cookbook: examples for uploads, analysis tasks, results, and failures
• Agent API Profile: compact tool set recommended for external LLM agents

Module Guide

• admin
  • Overview, users, projects, container builds, asset repositories, skill repositories, web search settings
• auth
  • Current user, personal web search settings, personal token usage
• projects
  • Project list, project detail, member management
• conversations
  • Conversations, messages, branches, scheduled tasks, streaming chat
• catalogs
  • Skills, actions, agents, runtimes, visualizers, MCP servers
• files
  • Project files, folders, downloads/previews, local workspace files
• agents
  • Agent tickets, permission requests, tool change revert
• container
  • Container status, image options, events, builds, logs
• models
  • Project model options and model management

Common Endpoints

• Public bootstrap chat
  • GET /api/public/chat/bootstrap
  • POST /api/public/chat/bootstrap
• Public showcase
  • GET /api/public/showcase/projects
  • GET /api/public/showcase/projects/{projectId}
  • GET /api/public/showcase/projects/{projectId}/conversations
  • GET /api/public/showcase/projects/{projectId}/conversations/{conversationId}/messages
  • GET /api/public/showcase/projects/{projectId}/files
• Project chat
  • POST /api/projects/{projectId}/chat
• Conversations and messages
  • GET /api/projects/{projectId}/conversations
  • GET /api/projects/{projectId}/conversations/{conversationId}/messages
• Local workspace
  • GET /api/projects/{projectId}/agent-workspace
  • POST /api/projects/{projectId}/agent-workspace
  • GET /api/projects/{projectId}/agent-workspace/content
  • GET /api/projects/{projectId}/agent-workspace/download
• Skills / Actions / Agents
  • GET /api/projects/{projectId}/skills
  • GET /api/projects/{projectId}/actions
  • GET /api/projects/{projectId}/agents
• MCP
  • GET /api/projects/{projectId}/mcp/servers
  • GET /api/projects/{projectId}/mcp/servers/{serverId}/tools
• Container
  • GET /api/projects/{projectId}/container/status
  • GET /api/projects/{projectId}/container/options
  • GET /api/projects/{projectId}/container-builds/{buildId}/logs
• Admin
  • GET /api/admin/overview
  • GET /api/admin/users
  • GET /api/admin/projects
  • PATCH /api/admin/projects/{projectId}/showcase

Current Coverage

The current registry now covers nearly the full business-facing frontend SDK surface, including:

• Authentication and current user
• Admin APIs
• Projects and membership
• Conversations, messages, and scheduled tasks
• Streaming chat endpoints
• Files, folders, and local workspace
• Skills / actions / agents / runtimes / visualizers
• MCP servers
• Agent tickets and permission requests
• Container management
• Model management and project model options

Notes

• Protected endpoints use Bearer auth
• Use the Authorize button in Swagger UI with your current session token
• Streaming endpoints are documented as text/event-stream
• Download endpoints may return binary content or ZIP archives instead of JSON
• Some routes support both JSON and export flows, for example download=1

As new frontend endpoints are added, they should be registered in the shared OpenAPI registry. If an endpoint is meant for external LLMs or automation agents, also update the LLM guide, cookbook, or Agent API Profile.