Skip to main content
POST
/
orgs
/
{org_id}
/
projects
/
{project_id}
/
preview
cURL
curl --request POST \
  --url https://api.timbal.ai/orgs/{org_id}/projects/{project_id}/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "rev": "main"
}'
{
  "components": [
    {
      "component": "<string>",
      "healthy": true
    }
  ],
  "rev": "<string>",
  "slug": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "project_id": 123,
  "status": "starting",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

​
org_id
string
required
​
project_id
string
required

Body

application/json
​
rev
string
required
Example:

"main"

Response

Preview started

​
components
object[]
required
​
rev
string
required
​
slug
string
required
​
started_at
string<date-time>
required

When the preview start was accepted (UTC).

​
project_id
integer<int64> | null

Set on org-level list responses.

​
status
null | enum<string>
Available options:
starting,
running
​
url
string | null

Full preview URL (if PREVIEW_DOMAIN is configured)