Guides development and review of Phoenix REST API endpoints under the v1 router.
npx skills add https://github.com/Arize-ai/phoenix --skill phoenix-rest-api
Please help me install this Agent Skill. Skill: phoenix-rest-api Source: https://github.com/Arize-ai/phoenix/tree/main/.agents/skills/phoenix-rest-api Command: npx skills add https://github.com/Arize-ai/phoenix --skill phoenix-rest-api
Adding or modifying REST endpoints in the Phoenix server requires following strict conventions for routing, models, auth, OpenAPI codegen, and integration test coverage, and missing any step causes CI failures.
make openapi to regenerate the OpenAPI schema plus Python and TypeScript client types, which must all be committed together.tests/integration/ and registration of endpoints in _helpers.py coverage lists.src/phoenix/server/api/routers/v1/, follow the checklist to implement the route, regenerate client types, and register it in _ADMIN_ONLY_ENDPOINTS before committing.Ask the assistant to add a new v1 REST endpoint to the Phoenix server following the phoenix-rest-api conventions and checklist.
High-intent search queries and answers about installing and using this skill.
Add the route in src/phoenix/server/api/routers/v1/ using V1RoutesBaseModel response wrappers, register the router in create_v1_router(), then run make openapi and add the endpoint to the correct coverage list in tests/integration/_helpers.py.
Run make openapi after any endpoint change. It regenerates schemas/openapi.json, the Python TypedDict client, and both TypeScript client files, all of which must be committed together to avoid CI drift failures.
Pagination is cursor-based only. Responses return a data array plus a next_cursor field, and filtering, sorting, and pagination parameters are passed as snake_case query parameters.
Unit tests cover Pydantic validation and schema assertions in-process, while integration tests cover CRUD, auth, and cross-API verification against a real Phoenix subprocess. Any test hitting an HTTP endpoint belongs in integration.
The _ensure_endpoint_coverage_is_exhaustive check normalizes paths, so use fake-id-{} for ID path params and test-tag for name params. Other placeholder values like fake-tag cause mismatches against the router.
FlexNetOSAutomate environment tooling installation and configuration with a declarative component model.
H2OSLabsConvert OpenAPI specifications into typed Next.js API clients and fetchers.
pdparchitectIdentify and exploit GraphQL API vulnerabilities including IDOR and broken authorization.
PatkikCreate paginated Laravel API responses with Resource::collection and conditional fields.