DeploymentsGet deployment status

Get deployment status

Returns the current state of a single deployment. Use this to poll a deployment started by POST /deploy or POST /deploy/preview until its status reaches ready or error.

curl -X GET "https://api.documentationai.app/api/v1/deployments/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "deploymentId": "9f1c2e64-3b47-4a8d-91f5-7c2e0a6d5b31",
  "status": "ready",
  "url": "https://docs.acme.com",
  "branch": "main",
  "isPreview": false,
  "triggerType": "api",
  "logs": "example_string",
  "createdAt": "2026-07-28T10:00:00.000Z",
  "updatedAt": "2026-07-28T10:01:32.000Z"
}
GET
/deployments/{deploymentId}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...

API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...
path
deploymentIdstring
Required

The deploymentId returned when the deployment was queued

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...

Path Parameters

deploymentIdstring
Required

The deploymentId returned when the deployment was queued

Responses

deploymentIdstring
statusstring

pending and building are in progress; ready, error and cancelled are final.

Allowed values:pendingbuildingreadyerrorcancelled
urlstring

Published address. Null until the deployment succeeds.

branchstring

Branch this deployment was built from

isPreviewboolean

True for preview deployments, which never affect the live site

triggerTypestring

What started it: user (dashboard), auto (repository push), system (internal), or api (this API).

Allowed values:userautosystemapi
logsstring

Failure detail. Populated only when status is error, null otherwise.

createdAtstring
updatedAtstring