Skip to content

Commit c5e3d35

Browse files
authored
Fix docs (#70)
1 parent 2841a08 commit c5e3d35

4 files changed

Lines changed: 37 additions & 5 deletions

File tree

agentex/docs/docs/api/adk.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# Agent Development Kit (ADK) Reference
22

3-
This is the API reference for the Agentex Python ADK. Use this ADK to leverage nice abstractions for interacting with the clients through Agentex's Agentic Infrastructure. This ADK makes things like streaming, tracing, tool calling, and communicating with clients in an async manner easy.
3+
!!! info "ADK vs SDK"
4+
**ADK (Agent Development Kit)** - Use within agent code to interact with Agentex infrastructure (streaming, tracing, state management, etc.)
5+
6+
**SDK (Software Development Kit)** - Use to make requests to the Agentex server via its REST API. [View SDK Docs →](https://agentex-sdk.stldocs.app/api/python)
7+
8+
This is the API reference for the Agentex Python ADK. Use this ADK to leverage convenient abstractions for interacting with clients through Agentex's Agentic Infrastructure. This ADK makes things like streaming, tracing, tool calling, and communicating with clients in an async manner easy.
49

510
## Agent Development Kit (ADK)
611

agentex/docs/docs/api/overview.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,34 @@
22

33
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.
44

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+
530
## What You'll Find
631

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
833
- **[Types](types.md)** - Complete API reference for all core data types (Task, TaskMessage, Event, ACP params, etc.)
934

1035
## Core Object Categories

agentex/docs/docs/concepts/task.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ Think of a task like a chat session, customer support ticket, or workflow execut
2222

2323
**Tasks maintain a flat ledger of messages.** This flat design is an intentional architectural decision that enables flexible multi-actor communication patterns.
2424

25-
#### Why This Design?
26-
2725
```python
2826
# A single task's message ledger might include:
2927
messages = [
@@ -36,6 +34,8 @@ messages = [
3634
]
3735
```
3836

37+
#### Why This Design?
38+
3939
This flat structure allows:
4040

4141
- **Multi-agent systems** where different agents contribute to the same conversation

agentex/docs/docs/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ The GitHub README will you how to scaffold an L1 example just to learn the ropes
2020
| Resource | Description |
2121
|----------|-------------|
2222
| **[Agentex README](https://github.com/scaleapi/scale-agentex#getting-started)** | **Getting Started**: Spin up a simple agent on your local computer from scratch in minutes. This comes with a full development UI and agent server. |
23-
| **[Python SDK](https://github.com/scaleapi/scale-agentex-python)** | **Examples**: Agent-building tutorials that work out of the box. These show how to build up from simple to more complex agents using Agentex. |
23+
| **[Python SDK Examples](https://github.com/scaleapi/scale-agentex-python)** | **Examples**: Agent-building tutorials that work out of the box. These show how to build up from simple to more complex agents using Agentex. |
24+
| **[API Reference](https://docs.gp.scale.com/reference/agentex/)** | **REST API**: Complete HTTP endpoint documentation for interacting with the Agentex server from any language or external system. |
25+
| **[SDK Client Docs](https://agentex-sdk.stldocs.app/api/python)** | **Python Client**: Python library for making requests to the Agentex server (create tasks, send messages, manage agents, etc.). |
2426
| **[Docs Site](https://agentex.sgp.scale.com/docs)** | **Concepts**: More in depth details on the what, why, and how of building L1-L5 agents.<br><br>**Enterprise Support**: Description of how our zero-ops deployment works. Learn how to share hundreds of agents with the rest of your company. Each agent is hosted and scaled independently on cloud-agnostic infrastructure. |
2527

0 commit comments

Comments
 (0)