Implementation:Arize ai Phoenix OpenAPI Spec Docs

Overview

The docs/openapi.json file is a copy of the OpenAPI 3.1.0 specification embedded within the Mintlify documentation site. It defines the complete REST API surface of the Phoenix server, enabling interactive API documentation and client code generation from the docs site. This file is a documentation-oriented derivative of the canonical specification at schemas/openapi.json.

The specification declares the API as Arize-Phoenix REST API version 1.0.

Code Reference

Attribute	Value
Source File	docs/openapi.json
Lines	9,770
Domain	API_Documentation
OpenAPI Version	3.1.0
API Version	1.0

API Endpoints

The specification defines REST endpoints across the following resource groups (all under the /v1/ prefix):

Resource Group	Example Endpoints
Annotation Configs	/v1/annotation_configs, /v1/annotation_configs/{config_identifier}
Span Annotations	/v1/projects/{project_identifier}/span_annotations, /v1/span_annotations
Trace Annotations	/v1/projects/{project_identifier}/trace_annotations, /v1/trace_annotations
Session Annotations	/v1/projects/{project_identifier}/session_annotations, /v1/session_annotations
Document Annotations	/v1/document_annotations
Datasets	/v1/datasets, /v1/datasets/{id}, /v1/datasets/upload, /v1/datasets/{id}/csv
Experiments	/v1/datasets/{dataset_id}/experiments, /v1/experiments/{experiment_id}, /v1/experiments/{experiment_id}/runs
Evaluations	/v1/evaluations, /v1/experiment_evaluations
Traces & Spans	/v1/traces/{trace_identifier}, /v1/spans/{span_identifier}, /v1/projects/{project_identifier}/spans
OTLP Ingestion	/v1/projects/{project_identifier}/spans/otlpv1
Prompts	/v1/prompts, /v1/prompts/{prompt_identifier}/versions, /v1/prompt_versions/{prompt_version_id}
Projects	/v1/projects, /v1/projects/{project_identifier}
Users	/v1/users, /v1/users/{user_id}

Conventions

• Resource naming: Pluralized nouns (e.g., /datasets, /experiments)
• Payload format: snake_case for query parameters and JSON bodies
• Response structure: Responses use a data key with cursor-based pagination
• Error handling: Standard HTTP status codes (403 Forbidden, 422 Validation Error)

Related Pages

• Arize_ai_Phoenix_OpenAPI_Spec_Canonical - The canonical (source of truth) OpenAPI specification at schemas/openapi.json
• Arize_ai_Phoenix_Docs_Site_Config - Mintlify documentation configuration that references this spec
• Arize_ai_Phoenix_Pyproject_Config - Python package that implements the FastAPI server serving these endpoints