Developer Guide

In addition to its web interface, DolphinX provides a rich set of APIs that enable developers to integrate DolphinX capabilities into the application layer. This article introduces the fundamentals of the DolphinX API, including the following topics:

• General Conventions: Describes the overall calling conventions for the DolphinX API, providing unified rules for protocols, authentication, errors, pagination, and stream processing in application-layer implementations.
• API List: Describes the request methods, API endpoints, request parameters, request examples, and response examples for the DolphinX API, covering APIs for discovering agents, creating sessions, starting conversations, using skills, reading and writing files, calling tools, accessing the network, and debugging context.
• Response Data Structures: Describes the data structures that recur in DolphinX API responses, helping developers process business data using these structures.
• Error Codes: Describes the error code system of the DolphinX API, helping developers provide more precise prompts or recovery strategies at the application layer based on error codes.
• WebSocket Protocol: Describes how to use WebSocket to provide API-calling capabilities equivalent to those of the HTTP protocol.
• Skill Package Specification: Describes the format and loading model for agent skill packages, guiding developers in writing skills that agents can use.