> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.sevalla.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > This is the Sevalla REST API reference. Base URL: https://api.sevalla.com/v3. Authenticate with an API key in the Authorization header as a Bearer token. > The OpenAPI spec is at https://api.sevalla.com/v3/openapi.json. Concepts and dashboard guides are at https://docs.sevalla.com (index: https://docs.sevalla.com/llms.txt). > To act on a Sevalla account from an AI agent, prefer the Sevalla MCP server (https://mcp.sevalla.com/mcp, see https://docs.sevalla.com/ai-agents/overview.md) or the Sevalla CLI (https://api-docs.sevalla.com/v3/cli.md). # Create preview app > Create a preview app for a branch or pull request in the pipeline preview stage. The app is created from the preview app settings and its first deployment of the latest commit on the branch starts right away, so this returns before the app is live. Use the application deployment endpoints to follow the progress. Preview must be enabled and the preview app settings configured first. Each preview app is a separate billed application. ## OpenAPI ````yaml https://api.sevalla.com/v3/openapi.json post /pipelines/{id}/preview/apps openapi: 3.1.0 info: title: Sevalla API docs version: 1.0.0 servers: - url: https://api.sevalla.com/v3 security: - bearerAuth: [] paths: /pipelines/{id}/preview/apps: post: tags: - Pipelines summary: Create preview app description: >- Create a preview app for a branch or pull request in the pipeline preview stage. The app is created from the preview app settings and its first deployment of the latest commit on the branch starts right away, so this returns before the app is live. Use the application deployment endpoints to follow the progress. Preview must be enabled and the preview app settings configured first. Each preview app is a separate billed application. operationId: createPipelinePreviewAppV3 parameters: - schema: example: fb5e5168-4281-4bec-94c5-0d1584e9e657 type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ in: path name: id required: true description: Pipeline identifier requestBody: required: true content: application/json: schema: type: object properties: branch: type: string minLength: 1 description: >- Git branch the preview app is built from and redeployed on every push example: feature/new-checkout pull_request_number: description: >- Pull request the preview app belongs to. When set, the app is named after the pull request and is deleted when the pull request is merged or closed. example: 42 type: integer minimum: 1 maximum: 9007199254740991 required: - branch additionalProperties: false responses: '201': description: Default Response content: application/json: schema: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Unique identifier for the application example: fb5e5168-4281-4bec-94c5-0d1584e9e657 name: type: string minLength: 1 maxLength: 64 description: >- Unique system name used in URLs and internal references. Auto-generated from the display name and cannot be changed after creation. example: my-app display_name: type: string minLength: 1 maxLength: 255 description: >- Human-readable name shown in the dashboard and API responses example: My Application default_branch: anyOf: - type: string - type: 'null' description: >- Git branch used for automatic and manual deployments when no branch is explicitly specified example: main required: - id - name - display_name - default_branch additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Bad request status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 400 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Unauthorized status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 401 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: >- This API key is missing the : permission. Grant it to the key or use a key that has it. status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 403 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Not found status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 404 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '429': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Too many requests status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 429 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Internal Server Error status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 500 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- API key authentication. Pass your API key as a Bearer token in the Authorization header. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.