Skip to main content

Projects

Manage projects within your organization. Projects are collections of related content.

List Projects

GET /v1/projects

Returns all projects in the organization.

Query Parameters

ParameterTypeDescription
limitintegerMax results (1-100, default: 20)
cursorstringPagination cursor

Request

curl "https://scribesight.com/api/v1/projects?limit=10" \
-H "Authorization: Bearer sk_live_xxx"

Response

{
"data": [
{
"id": "proj_xxxxxxxxxxxx",
"name": "Sales Calls Q1",
"slug": "sales-calls-q1",
"description": "Q1 2026 sales recordings",
"content_count": 47,
"latest_content_at": "2026-01-05T14:30:00Z",
"created_at": "2025-12-01T09:00:00Z",
"updated_at": "2026-01-05T14:30:00Z"
}
],
"pagination": {
"has_more": false,
"next_cursor": null
},
"meta": {
"request_id": "req_xxxxxxxxxxxx",
"timestamp": "2026-01-06T15:00:00Z"
}
}

Get Project

GET /v1/projects/{projectId}

Returns a specific project.

Request

curl https://scribesight.com/api/v1/projects/proj_xxxxxxxxxxxx \
-H "Authorization: Bearer sk_live_xxx"

Response

{
"data": {
"id": "proj_xxxxxxxxxxxx",
"name": "Sales Calls Q1",
"slug": "sales-calls-q1",
"description": "Q1 2026 sales recordings",
"settings": {
"default_prompt_id": "prompt_xxxxxxxxxxxx",
"auto_analyze": true
},
"content_count": 47,
"latest_content_at": "2026-01-05T14:30:00Z",
"created_at": "2025-12-01T09:00:00Z",
"updated_at": "2026-01-05T14:30:00Z"
},
"meta": {
"request_id": "req_xxxxxxxxxxxx",
"timestamp": "2026-01-06T15:00:00Z"
}
}

Create Project

POST /v1/projects

Creates a new project.

Request Body

FieldTypeRequiredDescription
namestringYesProject name
slugstringNoURL-safe identifier (auto-generated if omitted)
descriptionstringNoProject description
settings.default_prompt_idstringNoDefault prompt for analyses
settings.auto_analyzebooleanNoAuto-analyze new content

Request

curl -X POST https://scribesight.com/api/v1/projects \
-H "Authorization: Bearer sk_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"name": "Support Calls Q1",
"description": "Customer support recordings for Q1 2026",
"settings": {
"auto_analyze": true
}
}'

Response

{
"data": {
"id": "proj_yyyyyyyyyyyy",
"name": "Support Calls Q1",
"slug": "support-calls-q1",
"description": "Customer support recordings for Q1 2026",
"settings": {
"default_prompt_id": null,
"auto_analyze": true
},
"content_count": 0,
"latest_content_at": null,
"created_at": "2026-01-06T15:00:00Z",
"updated_at": "2026-01-06T15:00:00Z"
},
"meta": {
"request_id": "req_xxxxxxxxxxxx",
"timestamp": "2026-01-06T15:00:00Z"
}
}

Update Project

PATCH /v1/projects/{projectId}

Updates a project.

Request Body

All fields are optional. Only provided fields are updated.

FieldTypeDescription
namestringProject name
descriptionstringProject description
settings.default_prompt_idstringDefault prompt for analyses
settings.auto_analyzebooleanAuto-analyze new content

Request

curl -X PATCH https://scribesight.com/api/v1/projects/proj_xxxxxxxxxxxx \
-H "Authorization: Bearer sk_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"description": "Updated description",
"settings": {
"auto_analyze": false
}
}'

Delete Project

DELETE /v1/projects/{projectId}

Deletes a project and all its content.

danger

This action is irreversible. All content, transcripts, and analyses in the project will be permanently deleted.

Request

curl -X DELETE https://scribesight.com/api/v1/projects/proj_xxxxxxxxxxxx \
-H "Authorization: Bearer sk_live_xxx"

Response

{
"data": {
"deleted": true
},
"meta": {
"request_id": "req_xxxxxxxxxxxx",
"timestamp": "2026-01-06T15:00:00Z"
}
}