v0 Platform API/API Reference/Deployments

Get Deployment

Get a deployment by ID. This will return the details of the deployment, including the inspector URL, chat ID, project ID, version ID, API URL, and web URL.

GET/v1/deployments/{deploymentId}

Usage

TypeScript Example
import { v0 } from 'v0-sdk'

const result = await v0.deployments.getById({
  deploymentId: '123',
})

console.log(result)

API Signature

Request

Path Parameters

deploymentId: string

Path parameter "deploymentId"

Response

id: string

A unique identifier for the deployment.

object: 'deployment'

Fixed value identifying this object as a deployment.

inspectorUrl: string

URL to the deployment inspector.

chatId: string

The ID of the chat that this deployment is scoped to.

projectId: string

The ID of the project that this deployment is scoped to.

versionId: string

The ID of the version that this deployment is scoped to.

apiUrl: string

The API endpoint URL for accessing this deployment programmatically.

webUrl: string

The web URL where the deployment can be viewed or managed.