DeploymentsDeploy the live site

Deploy the live site

Republishes the deployment branch as it currently stands. Commits nothing.

Use it when content reached the branch some other way, or when an OpenAPI specification you reference by URL changed on its own host — nothing changed in Git, so nothing triggered a rebuild.

Requires editor or admin role.

curl -X POST "https://api.documentationai.app/api/v1/deploy" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "commitSha": "example_string"
}'
{
  "deploymentId": "9f1c2e64-3b47-4a8d-91f5-7c2e0a6d5b31",
  "status": "pending",
  "url": "https://docs.acme.com"
}
POST
/deploy
POST
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_...
Content-Typestring
Required

The media type of the request body

Options: application/json
commitShastring

Specific commit to deploy. Defaults to the current head of the deployment branch.

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_...

Body

application/json
commitShastring

Specific commit to deploy. Defaults to the current head of the deployment branch.

Responses