Logo

Create a deployment

POST/v1/deployments
Copy

Starts a deployment for the API key's site from the latest commit on its configured branch. A newer deployment supersedes any queued or building deployment for the same site. Every accepted build counts toward the organization's build activity, including builds that are later canceled. The Free daily allowance is shared across the organization, while Pro includes unlimited builds for normal product use.

curl --request POST \     --url https://radiantdocs.com/v1/deployments \     --header 'accept: application/json' \     --header 'authorization: Bearer <BEARER_TOKEN>'
{  "id": "90a76b22-8f25-4fc7-95cc-b3a5b2f24108",  "siteId": "25853bf0-7640-45c6-b008-568c6d90d8f8",  "status": "building",  "trigger": "api",  "commit": {    "sha": "4f91d8616e87bb258320565ff3eeca7c1f5f260b",    "message": "Update authentication documentation"  },  "failure": {    "message": "The docs configuration is invalid."  },  "createdAt": "2026-08-01T18:30:00.000Z",  "updatedAt": "2026-08-01T18:30:06.000Z"}

Header

Authorizationstringrequired

A site-scoped key created from the Radiant dashboard.

Responses

202
The deployment was accepted and dispatched.
idstring (uuid)required
siteIdstring (uuid)required
statusenum<string>required
Options:
queued,
building,
success,
failed or
canceled
triggerstringrequired

The workflow that created the deployment.

commitobjectrequired
shastringrequired
messagestringnullrequired
failureobject | nullrequired

One of these variants applies.

object
messagestringrequired
createdAtstring (date-time)required
updatedAtstring (date-time)required
401
The request is missing a valid, active Radiant API key.
errorobjectrequired
codestringrequired
messagestringrequired
detailsobject
[key: string]any
403
The API key does not have the scope required by the operation.
errorobjectrequired
codestringrequired
messagestringrequired
detailsobject
[key: string]any
404
The resource does not exist or is outside the API key's site scope.
errorobjectrequired
codestringrequired
messagestringrequired
detailsobject
[key: string]any
409
The site repository or its credentials are not ready for deployment.
errorobjectrequired
codestringrequired
messagestringrequired
detailsobject
[key: string]any
429
The organization cannot accept more builds until its build capacity resets.
errorobjectrequired
codestringrequired
messagestringrequired
detailsobject
[key: string]any
500
Radiant could not complete the request because of an internal error.
errorobjectrequired
codestringrequired
messagestringrequired
detailsobject
[key: string]any
502
Radiant could not load the configured repository from GitHub.
errorobjectrequired
codestringrequired
messagestringrequired
detailsobject
[key: string]any
503
Radiant created the deployment record but could not dispatch its build.
errorobjectrequired
codestringrequired
messagestringrequired
detailsobject
[key: string]any

© 2026 Radiant Docs. All rights reserved.