GET/v1/projects/{projectId}

Get Project

Retrieve details for a single documentation project.

Path Parameters

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

Response

The project object.

Unique project identifier.

Project display name.

URL-friendly identifier.

Project description.

Live documentation URL.

Custom domain if configured.

Connected GitHub repository URL.

Branch to build from.

Project settings.

Whether AI assistant is enabled.

Whether search is enabled.

Whether analytics are enabled.

ISO 8601 creation timestamp.

ISO 8601 last update timestamp.

Example

curl https://api.syntext.dev/v1/projects/prj_abc123 \
-H "Authorization: Bearer stx_abc12345_..."

import { Syntext } from '@syntext/sdk'

const client = new Syntext('stx_abc12345_...')
const project = await client.projects.get('prj_abc123')

from syntext import Syntext

client = Syntext("stx_abc12345_...")
project = client.projects.get("prj_abc123")

Response

{
  "data": {
    "id": "prj_abc123",
    "name": "API Docs",
    "slug": "api-docs",
    "description": "Documentation for our REST API",
    "url": "https://api-docs-docs.syntext.dev",
    "customDomain": "docs.example.com",
    "repoUrl": "https://github.com/acme/api-docs",
    "repoBranch": "main",
    "settings": {
      "aiEnabled": true,
      "searchEnabled": true,
      "analyticsEnabled": true
    },
    "createdAt": "2026-01-15T12:00:00Z",
    "updatedAt": "2026-01-20T08:30:00Z"
  }
}

Error Responses

404 Not Found

Returned when the project does not exist or you don't have access.

{
  "error": {
    "code": "not_found",
    "message": "Project does not exist or you don't have access"
  }
}

401 Unauthorized

Returned when authentication is missing or invalid.

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}