OSS Agent provides a set of HTTP-based API operations that allow you to programmatically interact with OSS Agent for conversation, tool call confirmation, interruption control, and Agent-to-Agent (A2A) protocol communication.
API overview
OSS Agent APIs differ from traditional OSS APIs in the following ways:
-
Data format: Request bodies and response bodies use JSON format instead of XML.
-
API paths: Use paths with the
/api/prefix. -
Streaming responses: Conversation-related operations (Chat, Confirm) use Server-Sent Events (SSE) streaming responses to incrementally return the Agent's reply.
API list
|
Category |
API |
Description |
|
Conversation |
Chat |
Initiates a conversation and interacts with OSS Agent in natural language through a streaming interface. |
|
Confirm |
Confirms or rejects a tool call requested by the Agent. |
|
|
Interrupt |
Interrupts an ongoing conversation. |
|
|
GetSessionContent |
Retrieves the detailed conversation content of a specified session. |
|
|
A2A Protocol |
a2a |
Interacts with OSS Agent through the A2A (Agent-to-Agent) protocol. |
|
agent_card |
Retrieves the capability description (Agent Card) of OSS Agent. |