Skip to main content

API Overview

The Lira API is a RESTful API built on Fastify 4 with Zod schema validation. All endpoints use JSON request/response bodies (except file uploads which use multipart form-data).

Base URL

https://api.creovine.com

Most endpoints are prefixed with /lira/v1/. Authentication routes use /v1/auth/.

Authentication

All API calls (except public routes) require a JWT token in the Authorization header:

Authorization: Bearer <jwt_token>

Tokens are obtained via Platform Auth (Google Sign-In or email/password) and expire after 7 days.

Common Response Format

Success

{
"success": true,
"data": { ... }
}

Error

{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Meeting not found"
}
}

Rate Limiting

API calls are rate-limited per organization based on beta limits. When a limit is reached, the API returns 429 with a BETA_LIMIT_REACHED error code. See Usage & Limits for details.

Endpoint Groups

GroupBase PathDescription
Authentication/v1/authRegister, login, Google Sign-In
Bot/lira/v1/botDeploy, monitor, terminate bots
Meetings/lira/v1/meetingsMeeting CRUD, summaries, settings
Organizations/lira/v1/orgsOrgs, members, documents, knowledge base
Interviews/lira/v1/orgs/:orgId/interviewsInterview lifecycle, evaluation, scoring
Integrations/lira/v1/integrationsOAuth flows, provider-specific endpoints
Tasks/lira/v1/orgs/:orgId/tasksTask CRUD, AI extraction, execution
WebSocket/lira/v1/wsReal-time audio + transcript streaming
Webhooks/lira/v1/webhooksInbound event receivers
Email/lira/v1/emailEmail config, custom domains, threads
Usage & Limits/lira/v1/usageOrganization usage tracking

Tech Stack

ComponentTechnology
FrameworkFastify 4.29.1
LanguageTypeScript 5.3.3 (Node.js 20+)
ValidationZod schemas on all request bodies
DatabaseDynamoDB (single-table design)
Vector DBQdrant (1536-dim, text-embedding-3-small)
StorageS3 (documents, recordings)
EncryptionAWS KMS (OAuth token encryption)
AIAmazon Nova Sonic, OpenAI GPT-4o
HostingEC2 t3.small