> ## Documentation Index > Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt > Use this file to discover all available pages before exploring further. # Create an API key > Mint a new tenant API key. The key value is returned ONLY on this response (Cache-Control: no-store) — store it immediately. `mode: 'test'` activates sandbox-mode (no real provider hits, no billing). Optional per-key `allowed_ips` enforces an IP allowlist at auth time. ## OpenAPI ````yaml /openapi.yaml post /api/v1/settings/api-keys openapi: 3.1.0 info: title: Devotel CPaaS API description: Orbit by Devotel — Communications Platform as a Service API version: 1.0.0 contact: name: Devotel url: https://devotel.io email: support@devotel.io license: name: Proprietary servers: - url: https://api.orbit.devotel.io description: Production security: - Bearer: [] - ApiKey: [] tags: - name: Messages description: >- Send and manage messages across all channels (SMS, WhatsApp, RCS, Email, Viber, etc.) - name: Fax description: >- List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers (sending flows through the Messaging API) - name: Agents description: AI agent creation, configuration, and execution - name: Voice description: Voice calls, IVR, conferencing, and SIP trunking - name: OnCall description: On-call rotations and escalation policy planning for incident alerting - name: Webhooks description: Webhook endpoint management and delivery logs - name: Numbers description: Phone number search, provisioning, and configuration - name: Brand Identity description: >- Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp, RCS, branded calling, number KYC) - name: Contacts description: Contact management, segmentation, and lifecycle tracking - name: Campaigns description: Marketing campaign orchestration and analytics - name: Flows description: Automation flow builder and execution engine - name: Templates description: Message template management and approval workflows - name: Settings description: Organization, channel, and user preference settings - name: Verify description: OTP generation and verification across channels - name: Push description: Push notification delivery via FCM and APNs - name: Integrations description: Third-party service connections and OAuth management - name: CDP description: >- Customer Data Platform — activation surface (CRM object sync, streaming destinations, ad-audience activation) - name: Files description: >- Server-to-server media upload, listing, retrieval, and deletion (signed-URL backed) - name: Commerce description: >- Omnichannel conversational-commerce — persistent cart + checkout state machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout, and AP2-style agent payment mandates. - name: Sync description: >- Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps, Lists, and ephemeral Streams, with change events relayed over the /api/v1/ws/sync WebSocket gateway paths: /api/v1/settings/api-keys: post: tags: - Settings summary: Create an API key description: >- Mint a new tenant API key. The key value is returned ONLY on this response (Cache-Control: no-store) — store it immediately. `mode: 'test'` activates sandbox-mode (no real provider hits, no billing). Optional per-key `allowed_ips` enforces an IP allowlist at auth time. requestBody: required: true content: application/json: schema: type: object required: - name properties: name: type: string minLength: 1 maxLength: 100 description: >- Human-readable label shown in the dashboard. Not used for authentication. type: type: string enum: - secret - public default: secret description: >- secret = server-only `dv_*_sk_*` key; public = browser-safe `pk_*` key for the embed SDK. scopes: type: array items: type: string description: >- API key permission scopes (e.g. messages:write). At least one scope is required for keys minted after 2026-08-01; empty-scope keys are deprecated and treated as least-privilege (viewer) / will be rejected after the grandfather deadline. mode: type: string enum: - live - test default: live description: >- `test` keys never deliver messages and never bill; useful for CI/staging. expiresIn: type: string enum: - never - 30d - 90d - 1y default: never allowed_ips: type: array maxItems: 50 items: type: string minLength: 1 maxLength: 64 description: >- Optional IP/CIDR allowlist. Auth middleware rejects requests from a non-allowlisted source. responses: '201': description: API key created — store the `key` value now content: application/json: schema: type: object description: API key created — store the `key` value now properties: data: type: object additionalProperties: true properties: id: type: string key: type: string description: >- Plaintext key. Returned exactly once; the API stores only an HMAC. Format: `dv_(live|test)_(sk|pk)_*`. name: type: string type: type: string enum: - secret - public mode: type: string enum: - live - test scopes: type: array items: type: string allowed_ips: type: - 'null' - array items: type: string expires_at: type: - 'null' - string format: date-time created_at: type: string format: date-time _warning: type: string meta: type: object properties: request_id: type: string description: >- Unique request identifier (also returned in X-Request-Id header) timestamp: type: string format: date-time description: ISO 8601 UTC timestamp of the response '422': description: Default Response content: application/json: schema: type: object properties: error: type: object required: - code - message - status properties: code: type: string description: >- Machine-readable error code (e.g. INVALID_PHONE_NUMBER) message: type: string description: Human-readable error description status: type: integer description: HTTP status code details: type: object additionalProperties: true description: Additional context about the error meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri description: Link to relevant error documentation components: securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT description: Dashboard JWT token from Clerk ApiKey: type: apiKey name: X-API-Key in: header description: Server-to-server API key (dv_live_sk_*) ````