Phoenix REST API
Developmentphoenix-rest-apiPhoenix REST API is an Agent Skill for development published in the Arize-ai/phoenix repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
REST API development for Phoenix. Use when adding, modifying, or reviewing endpoints in src/phoenix/server/api/routers/v1/.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/Arize-ai/phoenix/blob/HEAD/.agents/skills/phoenix-rest-api/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/phoenix-rest-api, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Phoenix REST API
Endpoints: src/phoenix/server/api/routers/v1/. Read the relevant reference.
Checklist — run before committing any endpoint change
make openapi— regenerate schema + client types, commit all generated files- Add endpoint to the correct list in
tests/integration/_helpers.py:- GET →
_COMMON_RESOURCE_ENDPOINTS - Admin-only →
_ADMIN_ONLY_ENDPOINTS - POST/PUT/DELETE →
_VIEWER_BLOCKED_WRITE_OPERATIONS - Path format: use
fake-id-{}for path params,test-tagfor tag/name params (these are normalized by_ensure_endpoint_coverage_is_exhaustive)
- GET →
make lint-python— fix any lint errors before committing
| Reference | When |
|---|---|
references/endpoint-patterns.md | Adding or modifying an endpoint |
references/openapi-codegen.md | Regenerating schema or client types |
references/testing-patterns.md | Writing integration tests |