---
title: "Start an app preview"
method: POST
path: "/api/v3/builds/{build_id}/preview"
tags: ["App Previews"]
---

# Start an app preview

`POST /api/v3/builds/{build_id}/preview`

## Request

- Base URL: `https://codemagic.io`
- URL: `https://codemagic.io/api/v3/builds/{build_id}/preview`
- Auth: API key in header `x-auth-token`
- TypeScript: <https://skmtc.dev/codemagic/apis/codemagic-api/docs/api/v3/builds/:build_id/preview/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `build_id` string, required

## Request body

- StartPreviewSchema
  - `artifact_path` string, required

## Response `201`

Document created, URL follows

- StartedAppPreviewSchemaNoPagination
  - `data` StartedAppPreviewSchema, required
    - `id` string, required
    - `expires_at` string, date-time, required

## Other responses

- `400`: The request could not be validated
- `401`: Authentication is missing or invalid
- `402`: The maximum number of preview sessions has been reached
- `403`: The caller lacks the required permission
- `404`: The requested resource does not exist
- `429`: The rate limit has been exceeded

---

[API](https://skmtc.dev/codemagic/apis/codemagic-api.md) - [All operations](https://skmtc.dev/codemagic/apis/codemagic-api/llms.txt) - [OpenAPI document](https://skmtc.dev/codemagic/apis/codemagic-api/revisions/be09630f65e2?raw)