|
2 | 2 |
|
3 | 3 | This section provides comprehensive reference documentation for all Agentex types, classes, and interfaces. Use this as your definitive guide to understanding the objects and APIs you'll work with when building agents. |
4 | 4 |
|
| 5 | +## Documentation Types |
| 6 | + |
| 7 | +Agentex provides three types of API documentation, each serving a different purpose: |
| 8 | + |
| 9 | +### Agentex REST API Reference |
| 10 | +**[View API Reference →](https://docs.gp.scale.com/reference/agentex/)** |
| 11 | + |
| 12 | +Complete REST API documentation for the Agentex server. Use this to understand the HTTP endpoints, request/response schemas, and authentication for interacting with Agentex from any programming language or external system. |
| 13 | + |
| 14 | +### Agentex SDK (Python Client) |
| 15 | +**[View SDK Client Docs →](https://agentex-sdk.stldocs.app/api/python)** |
| 16 | + |
| 17 | +Python client library for making requests to the Agentex server. Use this when you need to interact with Agentex via its REST API (create tasks, send messages, manage agents, etc.). The SDK wraps the REST API with convenient Python methods. |
| 18 | + |
| 19 | +**When to use:** Building applications or services that need to make requests to the Agentex server. |
| 20 | + |
| 21 | +### Agentex ADK (Agent Development Kit) |
| 22 | +**[View ADK Reference →](adk.md)** |
| 23 | + |
| 24 | +Python library for use **WITHIN** your agent code. The ADK provides high-level abstractions for streaming, tracing, tool calling, state management, and communicating with clients through Agentex's agentic infrastructure. It's specifically designed for agent development, not for making requests to the Agentex server. |
| 25 | + |
| 26 | +**When to use:** Building the internal logic of your agents. |
| 27 | + |
| 28 | +--- |
| 29 | + |
5 | 30 | ## What You'll Find |
6 | 31 |
|
7 | | -- **[Agent Development Kit](adk.md)** - SDK reference specifically for agent development functionswith detailed function signatures |
| 32 | +- **[Agent Development Kit](adk.md)** - SDK reference specifically for agent development functions with detailed function signatures |
8 | 33 | - **[Types](types.md)** - Complete API reference for all core data types (Task, TaskMessage, Event, ACP params, etc.) |
9 | 34 |
|
10 | 35 | ## Core Object Categories |
|
0 commit comments