# Create service

**POST** `/v1/services`

⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Creates a new service under the specified project. The `projectId` is required in the request body. The service is placed in the given region, or the project's default region if omitted (falling back to us-east-1). Returns `409 Conflict` when a service already occupies the slot on the resolved branch, either by name or by `logicalId`; the body includes the existing service's id, name, branch, and logical id, and `conflict` says which attribute clashed. The name is checked first. `logicalId` cannot be combined with `branchGitName`; pass `branchId` instead.

Base URL: `https://api.prisma.io`

Tags: `[Experimental]`

## Authorization

Any ONE of the following options authorizes this operation; every scheme listed within an option is required together.

| Option | Scheme | Type | Sent as | Scopes |
| --- | --- | --- | --- | --- |
| Option 1 | `OAuth2` | `oauth2` | `Authorization: Bearer <access token>` | `offline_access`, `workspace:admin` |
| Option 2 | `Bearer` | `http` | `Authorization: Bearer <token>` (JWT) | — |

### OAuth 2.0 flows

- **OAuth2 · authorizationCode**
  - Authorization URL: `https://auth.prisma.io/authorize`
  - Token URL: `https://auth.prisma.io/token`
  - Refresh URL: `https://auth.prisma.io/token`
  - Scope `offline_access` — Offline access
  - Scope `workspace:admin` — Full access to workspace resources

## Request body

Optional. Media type: `application/json`

### Example request body

```json
{
  "branchGitName": "string",
  "branchId": "string",
  "displayName": "string",
  "logicalId": "string",
  "projectId": "string",
  "regionId": "us-east-1"
}
```

## Responses

| Status | Description | Media type |
| --- | --- | --- |
| `201` | Service created. | `application/json` |
| `401` | Missing or invalid authorization token. | `application/json` |
| `403` | Insufficient permissions to access this resource. | `application/json` |
| `404` | Project not found. | `application/json` |
| `409` | A service already occupies the slot on the resolved branch, by `displayName` or by `logicalId`. The body includes the existing service's id, name, branch git name, and logical id; `conflict` says which attribute clashed. | `application/json` |
| `413` | Request body exceeds this endpoint's size cap. | `application/json` |
| `422` | Validation failed (e.g. missing projectId, empty display name, or invalid region). | `application/json` |
| `429` | Rate limit exceeded. | `application/json` |

### Example response: 201 — Service created.

```json
{
  "data": {
    "appEndpointDomain": "string",
    "branchId": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "id": "string",
    "latestDeploymentId": "string",
    "logicalId": "string",
    "name": "string",
    "projectId": "string",
    "region": {
      "id": "string",
      "name": "string"
    },
    "type": "app",
    "url": "https://example.com"
  }
}
```

### Example response: 401 — Missing or invalid authorization token.

```json
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
```

### Example response: 403 — Insufficient permissions to access this resource.

```json
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
```

### Example response: 404 — Project not found.

```json
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
```

### Example response: 409 — A service already occupies the slot on the resolved branch, by `displayName` or by `logicalId`. The body includes the existing service's id, name, branch git name, and logical id; `conflict` says which attribute clashed.

```json
{
  "error": {
    "branchGitName": "string",
    "code": "app:already_exists",
    "conflict": "logicalId",
    "existingAppId": "string",
    "logicalId": "string",
    "message": "string",
    "name": "string"
  }
}
```

### Example response: 413 — Request body exceeds this endpoint's size cap.

```json
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
```

### Example response: 422 — Validation failed (e.g. missing projectId, empty display name, or invalid region).

```json
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
```

### Example response: 429 — Rate limit exceeded.

```json
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
```

## Related pages

- [[Experimental]](./tags/experimental.md)
- [Acquire Alchemy deploy lease](./postv1projectsbyprojectidbranchesbybranchidalchemy-statelease.md)
- [Agents](./tags/agents.md)
- [Alchemy state store version](./getv1projectsbyprojectidbranchesbybranchidalchemy-stateversion.md)
- [Buckets](./tags/buckets.md)
- [Connections](./tags/connections.md)
- [Create a branch](./postv1projectsbyprojectidbranches.md)
- [Create a custom domain](./postv1appsbyappiddomains.md)
- [Create a custom domain](./postv1servicesbyserviceiddomains.md)
- [Create a workspace](./postv1workspaces.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.