Skip to content

Commit 8cdcd38

Browse files
Examples updated
1 parent 6774c32 commit 8cdcd38

File tree

9 files changed

+26
-10
lines changed

9 files changed

+26
-10
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,18 @@ docker run --rm -i \
5757
--port 8010
5858
```
5959

60-
The API server will be available at `http://localhost:8010` with OpenAI-compatible API endpoints.
60+
The API server will be available at `http://localhost:8010` with OpenAI-compatible API endpoints. Interactive API documentation (Swagger UI) is available at `http://localhost:8010/docs`.
6161

6262
### Installation
6363

64-
For other installation methods:
64+
If you want to use SGR Agent Core as a Python library (framework):
6565

6666
```bash
6767
pip install sgr-agent-core
6868
```
6969

70+
See the [Installation Guide](https://vamplabai.github.io/sgr-agent-core/getting-started/installation/) for detailed instructions and the [Using as Library](https://vamplabai.github.io/sgr-agent-core/framework/first-steps/) guide to get started.
71+
7072
### Running Research Agents
7173

7274
The project includes example research agent configurations in the `examples/` directory. To get started with deep research agents:

docs/en/getting-started/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,17 @@ docker run --rm -i \
4545
--port 8010
4646
```
4747

48-
The API server will be available at `http://localhost:8010`.
48+
The API server will be available at `http://localhost:8010`. Interactive API documentation (Swagger UI) is available at `http://localhost:8010/docs`.
4949

5050
### Installation
5151

52-
For other installation methods:
52+
If you want to use SGR Agent Core as a Python library (framework):
5353

5454
```bash
5555
pip install sgr-agent-core
5656
```
5757

58-
See the [Installation Guide](installation.md) for detailed instructions.
58+
See the [Installation Guide](installation.md) for detailed instructions and the [Using as Library](../framework/first-steps.md) guide to get started.
5959

6060
### Next Steps
6161

docs/en/getting-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ services:
114114
docker-compose up -d
115115
```
116116

117-
The API server will be available at `http://localhost:8010`.
117+
The API server will be available at `http://localhost:8010`. Interactive API documentation (Swagger UI) is available at `http://localhost:8010/docs`.
118118

119119
### Building from Source
120120

docs/en/sgr-api/SGR-Description-API.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ SGR Agent Core provides a comprehensive REST API that is fully compatible with O
66
http://localhost:8010
77
```
88

9+
## API Documentation
10+
11+
Interactive API documentation (Swagger UI) is available at `http://localhost:8010/docs`. You can explore all endpoints, test requests, and view request/response schemas directly in your browser.
12+
913
## Authentication
1014

1115
Authentication is not supported by the API. For production deployments, use a reverse proxy with authentication configured.

docs/en/sgr-api/SGR-Quick-Start.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ After starting both backend and frontend, you can access:
9595
9696
- **Frontend:** http://localhost:5173
9797
- **Backend API:** http://localhost:8010
98+
- **API Documentation (Swagger UI):** http://localhost:8010/docs
9899
- Health check: http://localhost:8010/health
99100
- Agents endpoint: http://localhost:8010/agents
100101
- API endpoints: http://localhost:8010/v1/\*
@@ -164,6 +165,7 @@ docker run -d \
164165
After starting the container, you can access:
165166
166167
- **Backend API:** http://localhost:8010
168+
- **API Documentation (Swagger UI):** http://localhost:8010/docs
167169
- Health check: http://localhost:8010/health
168170
- Agents endpoint: http://localhost:8010/agents
169171
- API endpoints: http://localhost:8010/v1/\*
@@ -200,6 +202,7 @@ After deployment, you can access:
200202
201203
- **Frontend:** http://localhost:5173 (or custom `FRONTEND_PORT`)
202204
- **Backend API:** http://localhost:8010 (or custom `BACKEND_PORT`)
205+
- **API Documentation (Swagger UI):** http://localhost:8010/docs
203206
- Health check: http://localhost:8010/health
204207
- Agents endpoint: http://localhost:8010/agents
205208
- API endpoints: http://localhost:8010/v1/\*

docs/ru/getting-started/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,17 @@ docker run --rm -i \
4545
--port 8010
4646
```
4747

48-
API сервер будет доступен по адресу `http://localhost:8010`.
48+
API сервер будет доступен по адресу `http://localhost:8010`. Интерактивная документация API (Swagger UI) доступна по адресу `http://localhost:8010/docs`.
4949

5050
### Установка
5151

52-
Для других способов установки:
52+
Если вы хотите использовать SGR Agent Core как Python библиотеку (фреймворк):
5353

5454
```bash
5555
pip install sgr-agent-core
5656
```
5757

58-
См. [Руководство по установке](installation.md) для подробных инструкций.
58+
См. [Руководство по установке](installation.md) для подробных инструкций и [Использование как библиотека](../framework/first-steps.md) для начала работы.
5959

6060
### Следующие шаги
6161

docs/ru/getting-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ services:
114114
docker-compose up -d
115115
```
116116

117-
API сервер будет доступен по адресу `http://localhost:8010`.
117+
API сервер будет доступен по адресу `http://localhost:8010`. Интерактивная документация API (Swagger UI) доступна по адресу `http://localhost:8010/docs`.
118118

119119
### Сборка из исходников
120120

docs/ru/sgr-api/SGR-Description-API.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ SGR Agent Core предоставляет полноценный REST API, ко
66
http://localhost:8010
77
```
88

9+
## Документация API
10+
11+
Интерактивная документация API (Swagger UI) доступна по адресу `http://localhost:8010/docs`. Вы можете изучить все эндпоинты, протестировать запросы и просмотреть схемы запросов/ответов прямо в браузере.
12+
913
## Аутентификация
1014

1115
Аутентификация не поддерживается API. Для продакшн развертываний используйте reverse proxy с настроенной аутентификацией.

docs/ru/sgr-api/SGR-Quick-Start.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ VITE_API_BASE_URL=http://localhost:8010 npm run dev
9595

9696
- **Frontend:** http://localhost:5173
9797
- **Backend API:** http://localhost:8010
98+
- **Документация API (Swagger UI):** http://localhost:8010/docs
9899
- Проверка здоровья: http://localhost:8010/health
99100
- Endpoint агентов: http://localhost:8010/agents
100101
- API endpoints: http://localhost:8010/v1/\*
@@ -164,6 +165,7 @@ docker run -d \
164165
После запуска контейнера вы можете получить доступ:
165166

166167
- **Backend API:** http://localhost:8010
168+
- **Документация API (Swagger UI):** http://localhost:8010/docs
167169
- Проверка здоровья: http://localhost:8010/health
168170
- Endpoint агентов: http://localhost:8010/agents
169171
- API endpoints: http://localhost:8010/v1/\*
@@ -200,6 +202,7 @@ docker-compose up -d
200202

201203
- **Frontend:** http://localhost:5173 (или пользовательский `FRONTEND_PORT`)
202204
- **Backend API:** http://localhost:8010 (или пользовательский `BACKEND_PORT`)
205+
- **Документация API (Swagger UI):** http://localhost:8010/docs
203206
- Проверка здоровья: http://localhost:8010/health
204207
- Endpoint агентов: http://localhost:8010/agents
205208
- API endpoints: http://localhost:8010/v1/\*

0 commit comments

Comments
 (0)