> ## Documentation Index
> Fetch the complete documentation index at: https://vlyai-1c28d863.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get deployment

> Returns the full Deployment record including current status and the live URL.

`status` is one of: `queued`, `building`, `ready`, `failed`. When `ready`, the `url` field contains the live URL.

For a stream of status updates without polling, use a webhook subscribed to `deployment.*` events.


## OpenAPI

````yaml GET /v1/deployments/{id}
openapi: 3.1.0
info:
  title: vly.ai API
  version: 0.1.0
  description: >-
    REST API for the vly.ai AI app builder. v0, illustrative — endpoints, paths,
    and shapes may change before general availability. See the API Reference
    introduction for status.
  contact:
    name: vly.ai support
    email: support@vly.ai
    url: https://docs.vly.ai/api-reference/introduction
  license:
    name: vly.ai Terms
    url: https://vly.ai/terms
servers:
  - url: https://api.vly.ai
    description: Production
  - url: https://api.staging.vly.ai
    description: Staging
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Create, list, update, and delete vly projects.
  - name: Deployments
    description: Trigger and inspect deployments.
  - name: Agents
    description: Trigger an AI agent run on a project.
  - name: Files
    description: Upload assets to a project.
  - name: Billing
    description: Inspect plan usage and credits.
  - name: Webhooks
    description: Send and verify webhook events.
paths:
  /v1/deployments/{id}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - Deployments
      summary: Get deployment
      operationId: getDeployment
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
components:
  schemas:
    Deployment:
      type: object
      properties:
        id:
          type: string
          example: dpl_01JFA8N3Z1B6Y2K7Q3X4M5R8
        project_id:
          type: string
        environment:
          type: string
          enum:
            - preview
            - production
        status:
          type: string
          enum:
            - queued
            - building
            - ready
            - failed
        url:
          type: string
          format: uri
          nullable: true
        created_at:
          type: string
          format: date-time
      required:
        - id
        - project_id
        - environment
        - status
        - created_at
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: vly_live_...
      description: Workspace-scoped API key. Generate from Workspace settings → API keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.