Syntext DOCS
Get Started
API Get Build
GET/v1/projects/{projectId}/builds/{buildId}

Get Build

Retrieve detailed information about a specific build, including logs.

Path Parameters

The project ID (e.g., prj_abc123).

The build ID (e.g., bld_xyz789).

Response

The build object with full details.

Build identifier.

Build status: queued, building, deployed, failed.

What triggered the build.

Git branch.

Git commit SHA.

Git commit message.

Whether this is a preview deployment.

Deployed URL.

Build duration in milliseconds.

List of files changed in this commit.

Number of pages compiled.

Build log entries.

ISO 8601 timestamp.

Log level: info, warn, error.

Log message.

Error details if build failed.

Error code.

Error description.

File that caused the error.

Line number.

ISO 8601 timestamp.

ISO 8601 timestamp when deployment completed.

Example

curl https://api.syntext.dev/v1/projects/prj_abc123/builds/bld_xyz789 \
-H "Authorization: Bearer stx_abc12345_..."
import { Syntext } from '@syntext/sdk'

const client = new Syntext('stx_abc12345_...')
const build = await client.builds.get('prj_abc123', 'bld_xyz789')
from syntext import Syntext

client = Syntext("stx_abc12345_...")
build = client.builds.get("prj_abc123", "bld_xyz789")

Response

{
  "data": {
    "id": "bld_xyz789",
    "status": "deployed",
    "trigger": "push",
    "branch": "main",
    "commitSha": "a1b2c3d4e5f6",
    "commitMessage": "Update API documentation",
    "isPreview": false,
    "url": "https://api-docs-docs.syntext.dev",
    "duration": 4523,
    "filesChanged": [
      "docs/api-reference/overview.mdx",
      "docs/api-reference/endpoints.mdx"
    ],
    "pagesBuilt": 24,
    "logs": [
      {
        "timestamp": "2026-06-28T10:00:00Z",
        "level": "info",
        "message": "Build started"
      },
      {
        "timestamp": "2026-06-28T10:00:02Z",
        "level": "info",
        "message": "Compiling 24 pages..."
      },
      {
        "timestamp": "2026-06-28T10:00:04Z",
        "level": "info",
        "message": "Uploading to CDN..."
      },
      {
        "timestamp": "2026-06-28T10:00:05Z",
        "level": "info",
        "message": "Deployment complete"
      }
    ],
    "createdAt": "2026-06-28T10:00:00Z",
    "deployedAt": "2026-06-28T10:00:05Z"
  }
}

Error Responses

404 Not Found

Returned when the project or build does not exist.

{
  "error": {
    "code": "not_found",
    "message": "Build or project does not exist"
  }
}

401 Unauthorized

Returned when authentication is missing or invalid.

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}
Assistant
Responses are generated using AI and may contain mistakes.

Ask me anything about the documentation.

ESC