README + OpenAPI spec for Anthropic endpoints #6

Open
opened 2026-08-03 16:55:24 -07:00 by kalmiya · 0 comments
Owner

Kanban ticket: t_4f84900e
Board: hermes-anthropic-api


Task t_4f84900e: README + OpenAPI spec for Anthropic endpoints
status: ready
assignee: -
workspace: scratch
max-retries: 2 (default)
created: 2026-08-03 16:53 by kalmiya

Body:
Write user-facing docs.

  • README.md with:
    • One-paragraph summary + the OpenAI→Anthropic equivalence (which endpoints map to which, which have no Anthropic equivalent).
    • Install: clone repo, pip install -e . (or document the entry point), then hermes plugins enable anthropic_api.
    • Minimal curl example for POST /v1/messages (text only) and a streaming SSE example.
    • Auth env var doc (ANTHROPIC_API_KEY).
    • The 8643 default port and how to change it.
  • docs/openapi.yaml (or .json) describing the Anthropic-shaped surface we expose. Use the spec for the Anthropic API as the structural baseline (https://docs.anthropic.com/en/api/messages) — emit only the endpoints we actually implement.

Note: do NOT document /api/sessions/*, /v1/runs/*, /v1/responses/*, /v1/capabilities, or /health/detailed. Those are not part of this plugin by user direction.

Events (1):
[2026-08-03 16:53] created {'assignee': None, 'status': 'ready', 'parents': [], 'tenant': None, 'workspace_kind': 'scratch', 'workspace_path': None, 'branch_name': None, 'project_id': None, 'skills': None, 'goal_mode': None, 'model_override': None, 'provider_override': None}

**Kanban ticket:** `t_4f84900e` **Board:** `hermes-anthropic-api` --- Task t_4f84900e: README + OpenAPI spec for Anthropic endpoints status: ready assignee: - workspace: scratch max-retries: 2 (default) created: 2026-08-03 16:53 by kalmiya Body: Write user-facing docs. - `README.md` with: - One-paragraph summary + the OpenAI→Anthropic equivalence (which endpoints map to which, which have no Anthropic equivalent). - Install: clone repo, `pip install -e .` (or document the entry point), then `hermes plugins enable anthropic_api`. - Minimal curl example for `POST /v1/messages` (text only) and a streaming SSE example. - Auth env var doc (`ANTHROPIC_API_KEY`). - The 8643 default port and how to change it. - `docs/openapi.yaml` (or `.json`) describing the Anthropic-shaped surface we expose. Use the spec for the Anthropic API as the structural baseline (https://docs.anthropic.com/en/api/messages) — emit only the endpoints we actually implement. Note: do NOT document `/api/sessions/*`, `/v1/runs/*`, `/v1/responses/*`, `/v1/capabilities`, or `/health/detailed`. Those are not part of this plugin by user direction. Events (1): [2026-08-03 16:53] created {'assignee': None, 'status': 'ready', 'parents': [], 'tenant': None, 'workspace_kind': 'scratch', 'workspace_path': None, 'branch_name': None, 'project_id': None, 'skills': None, 'goal_mode': None, 'model_override': None, 'provider_override': None}
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
kalmiya/hermes-anthropic-api#6
No description provided.