Skip to content

API docs: /chat endpoint #474

Description

@codebestia

Write apps/ai_agent/docs/api-chat.md documenting POST /chat — request/response shape (ChatRequest/ChatResponse), the system prompt behavior, model used, and failure modes (missing API key, upstream OpenAI errors).

Acceptance criteria:

  • Request and response fields are documented with types, sourced from the actual Pydantic models in main.py
  • Every documented failure mode has its actual HTTP status code and response body shape verified against the code/tests
  • A worked example request/response pair is included

Metadata

Metadata

Labels

Stellar WaveIssues in the Stellar wave programaidocumentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions