Skip to content

docs: Evaluation API guide and reference - #8

Open
anajuliabit wants to merge 1 commit into
mainfrom
docs/evaluation-api
Open

anajuliabit wants to merge 1 commit into
mainfrom
docs/evaluation-api

Conversation

@anajuliabit

Copy link
Copy Markdown
Contributor

Summary

User-facing documentation for the Reppo Evaluation API (evals-as-a-service; gateway at github.com/Reppo-Labs/eval-api, judges are Orquestra nodes).

  • guides/evaluate-agent-output.mdx (Guides) — get a key, submit, poll, read the result field by field, handle a denial, calibrate thresholds, limits, guarantees.
  • api/evaluations.mdx (new "Evaluation API" group under API Reference) — base URL, auth per endpoint, error envelope, POST /keys, POST /evals, GET /evals/{evalId} with every status code and result field.
  • guides/run-orquestra.mdx — new §13 "Eval work (opt-in)" for node operators, linking to the orquestra repo's docs/eval-work.md.
  • docs.json — both pages added to navigation.

Follows the existing page conventions (frontmatter with sidebarTitle, theme={null} on fenced blocks in the guide, <Note>/<Tip>/<CardGroup> components, tables for field references).

Notes for review

  • The base URL is the API Gateway execute-api host (https://jjpt8cr7qh.execute-api.us-west-2.amazonaws.com/v1); if a custom domain lands, it is the only place to update.
  • Limits (10/hour burst 3, 10/day per key, 100/day global, 24 h SLA, 90-day retention) are the deployed defaults.
  • mint broken-links could not run locally (npm cache permissions); internal links are /guides/evaluate-agent-output, /api/evaluations, /guides/run-orquestra, all present.

🤖 Generated with Claude Code

https://claude.ai/code/session_0164UBkSA5p5JCDngdPt4mJY

…questra guide

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0164UBkSA5p5JCDngdPt4mJY

This branch has not been deployed

No deployments
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.

1 participant