Projects

The Projects API allows you to retrieve information about your projects, including statistics about recordings, insights, and chats.

Get Project

Retrieves details about a specific project, including metadata and statistics.


GET /v2/projects/{projectId}

Headers

Header	Type	Required	Description
`x-api-key`	string	Yes	Your API key (requires `read` permission)

Path Parameters

Parameter	Type	Description
`projectId`	string	The project’s unique identifier (MongoDB ObjectId)

Response

200 OK


{
  "id": "507f1f77bcf86cd799439011",
  "organizationId": "507f1f77bcf86cd799439012",
  "name": "User Research Q1 2025",
  "description": "User interviews for the new checkout flow",
  "category": "user_research",
  "stats": {
    "recordingsCount": 15,
    "insightsCount": 42,
    "chatsCount": 5
  },
  "createdAt": "2024-01-15T10:30:00.000Z"
}

Response Fields

Field	Type	Description
`id`	string	Unique project identifier
`organizationId`	string	Organization that owns the project
`name`	string	Project name
`description`	string \| null	Optional project description
`category`	string	Project category (see categories below)
`stats`	object	Project statistics
`stats.recordingsCount`	number	Total number of recordings in the project
`stats.insightsCount`	number	Total number of insights generated
`stats.chatsCount`	number	Total number of AI chat sessions
`createdAt`	string	ISO 8601 timestamp when project was created

Project Categories

Projects can be categorized for better organization:

Category	Description
`generic`	General purpose project
`sales`	Sales calls and demos
`ui_ux`	UI/UX research and testing
`hr_interview`	HR interviews and candidate screening
`user_research`	User research and interviews
`product_feedback`	Product feedback sessions
`customer_support`	Customer support calls
`podcast`	Podcast recordings
`thought_leadership`	Thought leadership content
`internal_meeting`	Internal team meetings

Example Request


curl -X GET "https://api.yeino.com/v2/projects/507f1f77bcf86cd799439011" \
  -H "x-api-key: yno_live_abc123..."

Example Response


{
  "id": "507f1f77bcf86cd799439011",
  "organizationId": "507f1f77bcf86cd799439012",
  "name": "User Research Q1 2025",
  "description": "User interviews for the new checkout flow",
  "category": "user_research",
  "stats": {
    "recordingsCount": 15,
    "insightsCount": 42,
    "chatsCount": 5
  },
  "createdAt": "2024-01-15T10:30:00.000Z"
}

Error Responses

Status Code	Error	Description
401	`Unauthorized`	Invalid or missing API key
403	`Forbidden`	API key doesn’t have `read` permission
404	`Not Found`	Project not found or not accessible to your organization
500	`Internal Server Error`	Server error (contact support if persistent)

401 Unauthorized Example:


{
  "statusCode": 401,
  "message": "Invalid API key.",
  "error": "Unauthorized"
}

404 Not Found Example:


{
  "statusCode": 404,
  "message": "Project not found.",
  "error": "Not Found"
}

Use Cases

Dashboard Integration - Display project statistics in custom dashboards
Reporting - Generate reports on project activity
Project Validation - Verify project exists before uploading recordings
Analytics - Track project growth and engagement metrics

Notes

Projects are organization-scoped. You can only access projects within your organization.
Statistics are calculated in real-time and reflect current counts.
The category field helps organize projects but doesn’t affect functionality.