Skip to content

Commit 9f15005

Browse files
committed
Document /prompt and /resend endpoints in README
Update README to reflect API changes: clarify prompt handling via /prompt (formerly /llm), add /resend endpoint for sending email via the Resend API (implementation at app/utils/notify/resend.py), and list prospects endpoints including POST /prospects/process for bulk CSV ingestion. Also add a Notable Endpoints section and minor formatting tweaks.
1 parent f0405ef commit 9f15005

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
This project provides a scalable API backend using FastAPI and PostgreSQL, featuring:
1010

1111
- Automatic full-text search on all text fields (via tsvector)
12-
- Endpoints for health checks, product management, prompt handling, and prospect management
12+
- Endpoints for health checks, product management, prompt handling (via `/prompt`), resend email, and prospect management
1313
- Efficient ingestion and processing of large CSV files
1414

1515
#### 🚀 Features
@@ -42,13 +42,21 @@ uvicorn app.main:app --reload
4242

4343
Visit [localhost:8000](http://localhost:8000) or [onrender](https://nx-ai.onrender.com)
4444

45+
4546
#### API Documentation
4647

4748
FastAPI auto-generates interactive docs:
4849

4950
- [Swagger UI](https://nx-ai.onrender.com/docs)
5051
- [ReDoc](https://nx-ai.onrender.com/redoc)
5152

53+
#### Notable Endpoints
54+
55+
- `GET /health` — Health check
56+
- `GET/POST /prompt` — LLM prompt completion (formerly `/llm`)
57+
- `GET/POST /resend` — Send email via Resend API (see implementation in `app/utils/notify/resend.py`)
58+
- `GET /prospects` — Paginated prospects
59+
- `POST /prospects/process` — Bulk CSV ingestion
5260

5361
## Full-Text Search (tsvector)
5462

0 commit comments

Comments
 (0)