Phoenix
TypeScript APIPython APICommunityGitHubPhoenix Cloud
  • Documentation
  • Self-Hosting
  • Cookbooks
  • SDK and API Reference
  • Release Notes
  • Resources
  • Overview
  • Python
    • Overview
    • Reference
  • Python pacakges
    • arize-phoenix-evals
    • arize-phoenix-client
    • arize-phoenix-otel
  • TypeScript
    • Overview
    • Reference
  • TypeScript Packages
    • MCP Server
  • Rest API
    • Overview
    • Reference
  • Datasets
  • Experiments
  • Spans
  • Traces
  • Prompts
  • Projects
Powered by GitBook

Platform

  • Tracing
  • Prompts
  • Datasets and Experiments
  • Evals

Software

  • Python Client
  • TypeScript Client
  • Phoenix Evals
  • Phoenix Otel

Resources

  • Container Images
  • X
  • Blue Sky
  • Blog

Integrations

  • OpenTelemetry
  • AI Providers

© 2025 Arize AI

On this page

Was this helpful?

Projects

REST API methods for interacting with Phoenix projects

PreviousPrompts

Last updated 21 days ago

Was this helpful?

Get project by ID or name

get

Retrieve a specific project using its unique identifier: either project ID or project name. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

Path parameters
project_identifierstringRequired

The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

Responses
200
The requested project
application/json
403
Forbidden
text/plain
404
Not Found
text/plain
422
Unprocessable Entity
text/plain
get
GET /v1/projects/{project_identifier} HTTP/1.1
Host: 
Accept: */*
{
  "data": {
    "name": "text",
    "description": "text",
    "id": "text"
  }
}

Delete a project by ID or name

delete

Delete an existing project and all its associated data. The project identifier is either project ID or project name. The default project cannot be deleted. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

Path parameters
project_identifierstringRequired

The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

Responses
204
No content returned on successful deletion
403
Forbidden
text/plain
404
Not Found
text/plain
422
Unprocessable Entity
text/plain
delete
DELETE /v1/projects/{project_identifier} HTTP/1.1
Host: 
Accept: */*

No content

  • POSTCreate a new project
  • GETList all projects
  • GETGet project by ID or name
  • PUTUpdate a project by ID or name
  • DELETEDelete a project by ID or name

List all projects

get

Retrieve a paginated list of all projects in the system.

Query parameters
cursorany ofOptional

Cursor for pagination (project ID)

stringOptional
or
nullOptional
limitintegerOptional

The max number of projects to return at a time.

Default: 100
include_experiment_projectsbooleanOptional

Include experiment projects in the response. Experiment projects are created from running experiments.

Default: false
Responses
200
A list of projects with pagination information
application/json
403
Forbidden
text/plain
422
Unprocessable Entity
text/plain
get
GET /v1/projects HTTP/1.1
Host: 
Accept: */*
{
  "data": [
    {
      "name": "text",
      "description": "text",
      "id": "text"
    }
  ],
  "next_cursor": "text"
}

Create a new project

post

Create a new project with the specified configuration.

Body
namestring · min: 1Required
descriptionany ofOptional
stringOptional
or
nullOptional
Responses
200
The newly created project
application/json
403
Forbidden
text/plain
422
Unprocessable Entity
text/plain
post
POST /v1/projects HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}
{
  "data": {
    "name": "text",
    "description": "text",
    "id": "text"
  }
}

Update a project by ID or name

put

Update an existing project with new configuration. Project names cannot be changed. The project identifier is either project ID or project name. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

Path parameters
project_identifierstringRequired

The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

Body
descriptionany ofOptional
stringOptional
or
nullOptional
Responses
200
The updated project
application/json
403
Forbidden
text/plain
404
Not Found
text/plain
422
Unprocessable Entity
text/plain
put
PUT /v1/projects/{project_identifier} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "description": "text"
}
{
  "data": {
    "name": "text",
    "description": "text",
    "id": "text"
  }
}