Project API

Retrieve project details and manage published versions. The API key is scoped to a single project, so these endpoints return data for the authenticated project only.

Endpoints

GET

/api/v1/project

Get project details

GET

/api/v1/project/versions

List published versions

Get Project

Returns the full project configuration including name, description, framework, language, and widget config.

Request

GET /api/v1/project
Authorization: Bearer cdt_abc123...

Response

{
  "id": "proj_abc123",
  "name": "Customer Support Agent",
  "description": "Handles customer inquiries and support tickets",
  "framework": "agentic",
  "language": "en",
  "slug": "support-agent",
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-15T12:00:00Z"
}

List Versions

Returns all published versions (snapshots) for the project, ordered by most recent. Use version IDs when interacting with the Conversations API to target a specific release.

Request

GET /api/v1/project/versions
Authorization: Bearer cdt_abc123...

Response

[
  {
    "id": "ver_xyz789",
    "name": "V3 release (manual)",
    "createdAt": "2025-01-15T10:30:00Z"
  },
  {
    "id": "ver_abc456",
    "name": "V2 release (manual)",
    "createdAt": "2025-01-10T08:00:00Z"
  }
]

Response Fields

Project

Field	Type	Description
id	string	Unique project identifier
name	string	Project display name
description	string \| null	Project description
framework	string	"agentic", "conversation-flow", or "outbound"
language	string \| null	ISO language code (e.g. "en")
slug	string \| null	URL-friendly project slug
createdAt	string	ISO 8601 creation timestamp

Version

Field	Type	Description
id	string	Unique version identifier
name	string	Version name / release label
createdAt	string	ISO 8601 publish timestamp

Targeting Environments

When calling the Conversations API, you can specify which version of your project to target by passing a versionId in the request body:

Value	Description
"development"	Latest unpublished changes (default)
"production"	Most recently published version
"ver_xyz789"	Specific version by ID