Skip to main content

​
Overview

The Project interface represents the full metadata and configuration state of a project. It is the primary return type for the getDetails() method.

​
Properties

PropertyTypeDescription
org_idstringThe unique identifier of the organization owning the project.
project_idstringThe unique identifier of the project itself.
descriptionstringA human-readable summary of the project.
configobjectThe active AI configuration, including embedder and reranker model strings.

​
Usage Example

const project = client.project({ org_id: 'customer-support', project_id: 'customer-support' });
const details = await project.get();

console.log(`Project: ${details.description}`);
console.log(`Using Embedder: ${details.config.embedder}`);