Skip to content

feat(T5): OpenAPI spec, agent guide, and pricing docs#209

Open
writsop wants to merge 2 commits intolangoustine69:mainfrom
writsop:feat/t5-openapi-docs
Open

feat(T5): OpenAPI spec, agent guide, and pricing docs#209
writsop wants to merge 2 commits intolangoustine69:mainfrom
writsop:feat/t5-openapi-docs

Conversation

@writsop
Copy link
Copy Markdown

@writsop writsop commented Mar 18, 2026

T5 Deliverables

1. openapi.json — Full OpenAPI 3.1 Specification

  • All 4 endpoints documented (search, news, deep, health)
  • x402 payment security scheme
  • Request/response schemas with examples
  • Error responses (402, 422, 429, 500)

2. docs/AGENT_GUIDE.md — Agent Integration Guide

  • Step-by-step x402 payment flow (3-step process)
  • Python code example for handling 402 responses
  • Endpoint usage with request/response examples
  • Rate limits and best practices

3. docs/PRICING.md — Pricing Documentation

  • Per-endpoint costs in USDC and base units
  • Competitor comparison table (3-14x cheaper)
  • Monthly cost estimates for different usage tiers
  • Blended usage calculation example

Closes T5

X-Money Agent and others added 2 commits February 28, 2026 20:16
… tests

- Multi-stage Dockerfile (node:20-alpine, <80MB image)
- railway.json with health check and resource limits
- GitHub Actions CI: lint, type-check, build, smoke test
- DEPLOY.md with Railway, Docker, VPS instructions
- .env.example for onboarding
- scripts/smoke-test.sh for endpoint verification

Closes T4 from BOUNTY.md
Deliverables:
- openapi.json: Full OpenAPI 3.1 spec for all endpoints with x402 payment schema
- docs/AGENT_GUIDE.md: Step-by-step guide for AI agents (x402 flow, code examples, best practices)
- docs/PRICING.md: Per-endpoint pricing, competitor comparison, monthly cost estimates

Closes T5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants