> ## Documentation Index > Fetch the complete documentation index at: https://docs.mavera.io/llms.txt > Use this file to discover all available pages before exploring further. # Get usage statistics > Get current usage statistics for your subscription including credits, transcription minutes, storage, and API request metrics. ## OpenAPI ````yaml /openapi.json get /usage openapi: 3.0.3 info: title: Mavera API version: 1.0.0 description: >- # Getting Started The Mavera Responses API provides persona-powered AI responses using the **OpenAI Responses API format**. Use `client.responses.create()` with the OpenAI SDK — just set the base URL to `https://app.mavera.io/api/v1`. ## Authentication All API requests require a Bearer token. Create an API key in **Settings > Developer > API Keys**. ``` Authorization: Bearer mvra_live_your_key_here ``` ## Quick Start ### Step 1: Get a Persona ID Every response request requires a `persona_id`. First, list available personas: ```bash curl https://app.mavera.io/api/v1/personas \ -H "Authorization: Bearer mvra_live_your_key_here" ``` This returns personas you can use. Copy the `id` field from any persona. ### Step 2: Create a Response Use the persona ID in your request: ```bash curl https://app.mavera.io/api/v1/responses \ -H "Authorization: Bearer mvra_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "model": "mavera-1", "persona_id": "YOUR_PERSONA_ID", "input": "Hello!" }' ``` ## Rate Limits Per-key sliding window limits based on your subscription tier: | Tier | Requests / min | |------|---------------| | Starter | 60 | | Basic | 120 | | Professional | 240 | | Enterprise | 600 | When rate limited, the response includes a `Retry-After` header indicating how many seconds to wait. ## Credits Each API call consumes credits from your subscription. The `usage.credits_used` field in the response shows the cost of each request. contact: name: Mavera Support url: https://mavera.io x-logo: url: /Mavera_Logo_Full.png altText: Mavera servers: - url: https://app.mavera.io/api/v1 description: Production - url: https://dev.mavera.io/api/v1 description: Development security: - BearerAuth: [] tags: - name: System description: Health checks and operational status. - name: Responses description: >- Generate persona-powered AI responses using the OpenAI Responses API format. Use `client.responses.create()` with the OpenAI SDK. - name: Models description: Discover available models and their capabilities. - name: Personas description: >- Browse available personas to inject specialized intelligence into responses via `persona_id`. - name: Custom Personas description: >- Create, manage, and customize AI-powered personas. Supports three creation pipelines: North Star (AI-generated from minimal input), Intermediate (guided 3-step process), and Advanced (full B2B/B2C customization with psychographics and purpose packs). 300 credits per persona. - name: Brand Voice description: >- Create, manage, and retrieve brand voice profiles for AI-powered content generation. Upload URLs and documents to analyze, and the AI will generate tone guidelines, vocabulary preferences, and writing style recommendations. - name: Generations description: >- Generate AI-powered content using pre-built templates with optional brand voice styling. Browse available generation apps, create content, and manage your generation history. Supports streaming responses. - name: Mave description: >- Mave is Mavera's AI-powered research and analysis agent. Send messages to conduct comprehensive investigations using multiple data sources, personas, and fact-checking. Mave uses a multi-phase orchestration process (Triage, Planning, Research, Execution, Validation) to deliver well-researched responses with sources. - name: Workspaces description: >- Manage workspaces for organizing your work. Workspaces contain projects, threads, personas, and other resources. Invite team members with role-based access control. Set budget alerts and usage limits. - name: Projects description: >- Organize work within workspaces using projects. Projects contain threads, generations, and other resources. Track usage and set per-project budget controls. - name: Meetings description: >- Access meeting recordings, transcripts, and AI-powered analysis. List meetings, retrieve transcripts in multiple formats (segments, text, SRT), get AI analysis with summaries, tasks, decisions, highlights, and coaching metrics. Run custom schemas to extract structured data from transcripts. - name: Schemas description: >- Create and manage meeting schemas for structured data extraction. Schemas define fields to extract from meeting transcripts, with support for various field types (text, enum, list, boolean, etc.), evidence tracking, and scoring. - name: Files description: >- Upload, manage, and retrieve files/assets. Use presigned URLs for direct uploads to avoid passing files through the API. Supports images, videos, documents, and more. File uploads count against your storage quota. - name: Folders description: >- Create and manage folders to organize your files. Folders can be favorited and shared with workspace members. - name: Video Analysis description: >- AI-powered video and advertisement analysis. Submit videos for comprehensive emotional, cognitive, behavioral, and technical analysis. Chat with AI about the results. - name: Focus Groups description: >- AI-powered synthetic focus group research. Create focus groups with personas to gather market research, product feedback, and audience insights. Supports 12 question types including NPS, Likert scales, and open-ended responses. - name: News description: >- AI-powered news intelligence. Browse trending stories, get AI analysis from persona perspectives, and manage scheduled news digests. Story analysis uses credits based on token usage. - name: Usage description: >- Monitor your subscription usage including credits, transcription minutes, storage, and API request metrics. Get real-time statistics on your billing period usage. paths: /usage: get: tags: - Usage summary: Get usage statistics description: >- Get current usage statistics for your subscription including credits, transcription minutes, storage, and API request metrics. operationId: getUsage responses: '200': description: Usage statistics content: application/json: schema: $ref: '#/components/schemas/UsageResponse' example: object: usage billing_period: start: '2024-03-01T00:00:00.000Z' end: '2024-03-31T23:59:59.999Z' credits: used: 2500 included: 5000 remaining: 2500 percentage_used: 50 transcription: minutes_used: 45.5 minutes_included: 500 minutes_remaining: 454.5 percentage_used: 9 storage: gb_used: 2.5 gb_included: 50 gb_remaining: 47.5 percentage_used: 5 api_requests: total_requests: 1250 total_tokens: 125000 prompt_tokens: 75000 completion_tokens: 50000 credits_used: 2500 error_count: 12 avg_latency_ms: 850 rate_limit: requests_per_minute: 120 auto_recharge: enabled: true threshold: 100 credits_to_add: 1000 limits: budget_alert: 4000 usage_limit: null '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-codeSamples: - lang: curl label: cURL source: |- curl -X GET https://app.mavera.io/api/v1/usage \ -H "Authorization: Bearer mvra_live_your_key_here" - lang: python label: Python source: >- import requests response = requests.get( "https://app.mavera.io/api/v1/usage", headers={"Authorization": "Bearer mvra_live_your_key_here"} ) usage = response.json() print(f"Credits: {usage['credits']['used']}/{usage['credits']['included']}") print(f"Remaining: {usage['credits']['remaining']} credits") print(f"API Requests: {usage['api_requests']['total_requests']}") - lang: javascript label: JavaScript source: >- const response = await fetch("https://app.mavera.io/api/v1/usage", { headers: { "Authorization": "Bearer mvra_live_your_key_here" } }); const usage = await response.json(); console.log(`Credits: ${usage.credits.used}/${usage.credits.included}`); console.log(`Remaining: ${usage.credits.remaining} credits`); console.log(`API Requests: ${usage.api_requests.total_requests}`); components: schemas: UsageResponse: type: object description: Current usage statistics for your subscription properties: object: type: string enum: - usage billing_period: type: object description: Current billing period dates properties: start: type: string format: date-time nullable: true description: Start of the current billing period end: type: string format: date-time nullable: true description: End of the current billing period credits: type: object description: Credit usage for the current billing period properties: used: type: integer description: Credits used this billing period included: type: integer description: Total credits included in your plan remaining: type: integer description: Credits remaining this billing period percentage_used: type: integer description: Percentage of credits used (0-100) transcription: type: object description: Transcription minutes usage properties: minutes_used: type: number description: Transcription minutes used this billing period minutes_included: type: integer description: Total transcription minutes included in your plan minutes_remaining: type: number description: Transcription minutes remaining percentage_used: type: integer description: Percentage of transcription minutes used (0-100) storage: type: object description: Storage usage properties: gb_used: type: number description: Storage used in GB gb_included: type: number description: Total storage included in your plan (GB) gb_remaining: type: number description: Storage remaining (GB) percentage_used: type: integer description: Percentage of storage used (0-100) api_requests: type: object description: API request statistics for the current billing period properties: total_requests: type: integer description: Total API requests made total_tokens: type: integer description: Total tokens used (prompt + completion) prompt_tokens: type: integer description: Total prompt tokens used completion_tokens: type: integer description: Total completion tokens used credits_used: type: integer description: Credits used by API requests error_count: type: integer description: Number of requests that resulted in errors avg_latency_ms: type: integer description: Average response latency in milliseconds rate_limit: type: object description: Rate limit configuration for your API key properties: requests_per_minute: type: integer description: Maximum requests allowed per minute auto_recharge: type: object description: Auto-recharge configuration properties: enabled: type: boolean description: Whether auto-recharge is enabled threshold: type: integer description: Credits threshold that triggers auto-recharge credits_to_add: type: integer description: Number of credits added when auto-recharge triggers limits: type: object description: Budget and usage limits properties: budget_alert: type: integer nullable: true description: Credit threshold for budget alert emails usage_limit: type: integer nullable: true description: Hard limit that pauses usage when reached ErrorResponse: type: object description: >- All error responses follow this format. The `type` field indicates the category of error, and `code` provides a machine-readable error code. properties: error: type: object properties: message: type: string description: A human-readable error message. example: Invalid API key. type: type: string enum: - invalid_request_error - authentication_error - insufficient_credits - not_found - rate_limit_error - api_error description: The category of error. example: authentication_error code: type: string description: A machine-readable error code. example: invalid_api_key param: type: string nullable: true description: The request parameter that caused the error, if applicable. example: null example: error: message: Invalid API key. type: authentication_error code: invalid_api_key param: null securitySchemes: BearerAuth: type: http scheme: bearer description: >- API key prefixed with `mvra_live_`. Create keys at **Settings > Developer > API Keys**. ````