# Codebase Projects API

**Canonical:** https://apis.io/apis/codebase-design/codebase-design-projects-api/  
**Provider:** Codebase — https://apis.io/providers/codebase-design/  
**Base URL:** https://dev.codebase.design  
**Documentation:** https://codebase.design/docs/api

Codebase Projects API is one of 16 APIs that [Codebase](https://apis.io/providers/codebase-design/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and 1 JSON Schema.

The Projects API from Codebase — 12 operation(s) for projects.

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/projects` | Create a project shell |
| GET | `/api/v1/projects` | List user projects |
| PATCH | `/api/v1/projects/{id}` | Update project metadata |
| GET | `/api/v1/projects/{id}` | Get project details |
| GET | `/api/v1/projects/{id}/export` | Download project source archive |
| GET | `/api/v1/projects/{id}/files` | List project files |
| POST | `/api/v1/projects/{id}/files` | Create a project text file |
| GET | `/api/v1/projects/{id}/files/{filepath}` | Read a project file |
| PUT | `/api/v1/projects/{id}/files/{filepath}` | Write or replace a project text file |
| DELETE | `/api/v1/projects/{id}/files/{filepath}` | Delete a project file or directory |
| PATCH | `/api/v1/projects/{id}/files/rename` | Rename or move a project file |
| GET | `/api/v1/projects/{id}/branches` | List project branches |
| GET | `/api/v1/projects/{id}/diff` | Compare two project refs |
| POST | `/api/v1/projects/{id}/checkout` | Switch active project branch |
| GET | `/api/v1/projects/{id}/log` | List project commits |
| POST | `/api/v1/projects/{id}/merge` | Merge a project branch |
| GET | `/api/v1/projects/{id}/diagnostics` | Project diagnostics (live build state + previewState) |

## Machine-readable artifacts (4)

- **OpenAPI** — https://artifacts.apis.io/codebase-design/openapi/codebase-design-projects-api-openapi.yml
- **APIReference** — https://codebase.design/api-docs/
- **Documentation** — https://codebase.design/docs/api
- **JSONSchema** — https://artifacts.apis.io/codebase-design/json-schema/codebase-design-build-handoff-schema.json

## Other Codebase APIs (12)

- [Codebase MCP Server](https://apis.io/apis/codebase-design/codebase-design-mcp/)
- [Codebase Account API](https://apis.io/apis/codebase-design/codebase-design-account-api/)
- [Codebase Admin API](https://apis.io/apis/codebase-design/codebase-design-admin-api/)
- [Codebase API Keys API](https://apis.io/apis/codebase-design/codebase-design-api-keys-api/)
- [Codebase Billing API](https://apis.io/apis/codebase-design/codebase-design-billing-api/)
- [Codebase Builds API](https://apis.io/apis/codebase-design/codebase-design-builds-api/)
- [Codebase Community API](https://apis.io/apis/codebase-design/codebase-design-community-api/)
- [Codebase Credits API](https://apis.io/apis/codebase-design/codebase-design-credits-api/)
- [Codebase Deploys API](https://apis.io/apis/codebase-design/codebase-design-deploys-api/)
- [Codebase Gallery API](https://apis.io/apis/codebase-design/codebase-design-gallery-api/)
- [Codebase Health API](https://apis.io/apis/codebase-design/codebase-design-health-api/)
- [Codebase Inference API](https://apis.io/apis/codebase-design/codebase-design-inference-api/)

## Tags

Project

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/codebase-design/codebase-design-projects-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/codebase-design/.
