OpenParable
Skip to content
← Back to skills

Phoenix REST API

Development
phoenix-rest-api

Phoenix 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/.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. 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

  1. make openapi — regenerate schema + client types, commit all generated files
  2. 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-tag for tag/name params (these are normalized by _ensure_endpoint_coverage_is_exhaustive)
  3. make lint-python — fix any lint errors before committing
ReferenceWhen
references/endpoint-patterns.mdAdding or modifying an endpoint
references/openapi-codegen.mdRegenerating schema or client types
references/testing-patterns.mdWriting integration tests