> ## Documentation Index > Fetch the complete documentation index at: https://docs.ouraicalling.com/llms.txt > Use this file to discover all available pages before exploring further. # Get current credential > Self-inspection of the calling API key: key metadata, workspace (tenant), active plan, and effective limits/feature toggles (`-1` = unlimited, `0` = disabled). No scope required — any valid key works. ## OpenAPI ````yaml /api-reference/openapi.json get /me openapi: 3.1.0 info: title: OurAiCalling API version: 1.0.0 description: >- REST API for OurAiCalling. Authenticate with an API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`) as a Bearer token. Every response uses a consistent envelope: `{ "data": ... , "meta": { ... } }` on success and `{ "error": { "code", "message" } }` on failure. List endpoints paginate with `?limit=` (default 50, max 200) and `?offset=`; `meta.pagination.total` carries the total match count. Everything documented here is also exposed as MCP tools at `https://app.famulor.io/mcp` (Model Context Protocol, streamable HTTP) using the same credentials and permission model. servers: - url: https://app.famulor.io/api/v1 description: Hosted platform. - url: https://{domain}/api/v1 description: White-label tenant domain — same paths, tenant branding. variables: domain: default: app.famulor.io description: Your white-label tenant domain. security: - bearerAuth: [] tags: - name: Account description: Self-inspection of the calling credential. - name: Migrations description: Preview and import data from supported legacy platforms. - name: Assistants description: Create and manage voice assistants. - name: Tools description: >- Reusable tools (HTTP APIs and external MCP servers) assistants can call mid-conversation. - name: Voices description: Browse the text-to-speech voice library. - name: Calls description: Start outbound calls and read call history, transcripts and recordings. - name: History description: Unified conversation history across calls, messaging and assistant emails. - name: Campaigns description: Outbound calling campaigns with a compliant power dialer. - name: Leads description: Manage Audience contacts across campaigns, channels and Call QA metrics. - name: Segments description: >- Saved, dynamic lead filters — reusable audience definitions used for Audience search and campaign lead assignment. - name: Suppression description: Cross-channel marketing opt-outs and active workspace suppression records. - name: Callbacks description: >- Scheduled callbacks booked by the Schedule callback tool across voice, chat, and email. - name: Phone Numbers description: Marketplace numbers and customer-provided numbers. - name: SIP Trunks description: Bring your own SIP provider and numbers. - name: Carrier Connections description: Connect a supported carrier account and import its existing phone numbers. - name: Knowledge Bases description: RAG knowledge bases and documents for assistants. - name: Settings description: Workspace-level settings such as caller-memory defaults. - name: Billing description: Balance and minutes ledger of the key owner. - name: Automations description: >- Native workspace automations — list, create, update, trigger. Plan gate: automation_platform. - name: Integrations description: >- Calendar integrations (Cal.com, Calendly, Acuity Scheduling, Google Calendar, Outlook, native booking engine). Assign them to assistants to provide availability and booking tools, plus provider-supported appointment lookup, cancellation, and rescheduling. - name: Bookings description: >- Native booking engine — event types with weekly availability, public booking pages at /book/{workspace}/{slug}, and the bookings they produce. - name: Dashboards description: >- Custom analytics dashboards, reusable widgets, and tenant-scoped performance analytics. Requires the custom_dashboards plan feature. - name: Catalog description: >- Read-only platform catalogs — available models, supported assistant languages, and prompt templates. - name: Simulations description: Assistant simulation tests (plan-gated). - name: Versions description: Assistant configuration version history. - name: Caller IDs description: Outbound caller ID verification. - name: Widgets description: Web widget connectors. - name: Messaging description: >- Telegram, Slack, and Messenger text bots linked to assistants (Chat SDK). Includes conversation delay, inactivity end, and conversation-ended webhooks. - name: QA description: Cohort AI Quality Assurance runs over call transcripts. - name: White Label description: >- Manage the customers of your white-label workspace on their behalf — list, register, mint access tokens, log in, log out, and transfer credits. Available to reseller workspaces with white-label access, and to platform admins (scoped to direct platform customers). Requires `platform:read` / `platform:write`. - name: API Keys description: >- Self-service API keys for the calling workspace. A key can only mint further keys with a scope subset of its own. - name: SMS description: Outbound SMS from workspace phone numbers. paths: /me: get: tags: - Account summary: Get current credential description: >- Self-inspection of the calling API key: key metadata, workspace (tenant), active plan, and effective limits/feature toggles (`-1` = unlimited, `0` = disabled). No scope required — any valid key works. operationId: getMe responses: '200': description: Metadata of the calling credential. content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/Me' example: data: api_key: id: k1b2c3d4-0000-4000-8000-000000000070 name: Production prefix: fam_Ab12Cd34 scopes: [] created_at: '2026-06-01T12:00:00Z' last_used_at: '2026-07-04T09:00:00Z' expires_at: null tenant: id: t1b2c3d4-0000-4000-8000-000000000002 name: Acme Corp user_id: u1b2c3d4-0000-4000-8000-000000000003 plan: id: pl1b2c3d-0000-4000-8000-000000000080 name: Pro price_monthly_cents: 9900 included_minutes: 1000 extra_minute_cost_cents: 12 currency: EUR limits: max_assistants: 10 max_campaigns: 5 max_cloned_voices: 3 max_knowledgebases: 5 max_tools: 20 max_parallel_calls: 5 max_automation_runs: 100 max_crm_syncs: 3 max_crm_synced_contacts: 25000 max_own_numbers: 3 max_members: 5 features: web_widget: true secondary_languages: true automation_platform: true calendar_integrations: true custom_dashboards: false flow_builder: true connect_ai_mcp: true whitelabel_enabled: false live_monitoring: true simulations: false display_currency: USD display_currency_rate: 1.08 '401': $ref: '#/components/responses/Unauthorized' components: schemas: Me: type: object properties: api_key: type: object description: Metadata of the calling credential. properties: id: type: string format: uuid name: type: - string - 'null' prefix: type: - string - 'null' description: Display prefix, e.g. `fam_Ab12Cd34`. scopes: type: array items: type: string description: Empty array = full access. created_at: type: string format: date-time last_used_at: type: - string - 'null' format: date-time expires_at: type: - string - 'null' format: date-time tenant: type: object properties: id: type: string format: uuid name: type: - string - 'null' user_id: type: - string - 'null' format: uuid plan: type: - object - 'null' description: >- Active plan summary (id, name, price_monthly_cents, included_minutes, extra_minute_cost_cents, currency), or `null`. limits: type: - object - 'null' description: >- Effective numeric plan limits. `-1` = unlimited, `0` = feature disabled. properties: max_assistants: type: - integer - 'null' max_campaigns: type: - integer - 'null' max_cloned_voices: type: - integer - 'null' max_knowledgebases: type: - integer - 'null' max_tools: type: - integer - 'null' max_parallel_calls: type: - integer - 'null' max_automation_runs: type: - integer - 'null' max_crm_syncs: type: - integer - 'null' max_crm_synced_contacts: type: - integer - 'null' max_own_numbers: type: - integer - 'null' max_members: type: - integer - 'null' features: type: - object - 'null' description: Boolean feature toggles of the active plan. properties: web_widget: type: - boolean - 'null' secondary_languages: type: - boolean - 'null' automation_platform: type: - boolean - 'null' calendar_integrations: type: - boolean - 'null' custom_dashboards: type: - boolean - 'null' flow_builder: type: - boolean - 'null' connect_ai_mcp: type: - boolean - 'null' whitelabel_enabled: type: - boolean - 'null' live_monitoring: type: - boolean - 'null' simulations: type: - boolean - 'null' display_currency: type: string description: >- Workspace's resolved display currency (reseller customers inherit their reseller's currency). example: USD display_currency_rate: type: number description: >- Units of display_currency per 1 EUR; 0 when the platform has not configured a rate yet. example: 1.08 ErrorEnvelope: type: object description: Error envelope returned by every /api/v1 endpoint on failure. required: - error properties: error: type: object required: - code - message properties: code: type: string enum: - unauthorized - forbidden - not_found - invalid_request - rate_limited - conflict - telephony_configuration_error - telephony_unavailable - internal_error description: Stable, machine-readable error code. message: type: string description: Human-readable description of the error. responses: Unauthorized: description: Missing, invalid, expired or revoked API key / access token. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: unauthorized message: Invalid API key. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`). Keys can be restricted to scopes such as `assistants:read`, `calls:write`, `campaigns:write`, `automations:read`, `dashboards:read`, `dashboards:write`, `leads:write`, `segments:write`, `phone_numbers:write`, `sip_trunks:write`, `knowledge:write`, `voices:read`, `billing:read`, `settings:write`, `platform:read`, `platform:write`; a `*:write` scope implies the matching `*:read`. Automation and dashboard endpoints also accept the legacy `calls:*` scope. Keys without scope restrictions have full access. ````