> ## 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.

# Activate a pending BYO LLM inference credential

> Marks a `pending` credential `active`. Pass enforce=true to begin routing this tenant's agent inference through the customer credential — self-serve, with no operator provisioning step. Requires `agents:write` with the owner or admin role. Writes are audit-logged.



## OpenAPI

````yaml /openapi.yaml post /api/v1/agents/llm-provider-credential/activate
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
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/agents/llm-provider-credential/activate:
    post:
      tags:
        - Agents
      summary: Activate a pending BYO LLM inference credential
      description: >-
        Marks a `pending` credential `active`. Pass enforce=true to begin
        routing this tenant's agent inference through the customer credential —
        self-serve, with no operator provisioning step. Requires `agents:write`
        with the owner or admin role. Writes are audit-logged.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                enforce:
                  type: boolean
                  description: >-
                    When true, immediately route this tenant's agent inference
                    through the credential.
      responses:
        '200':
          description: The credential is now `active`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LlmProviderCredentialResponse'
        '404':
          description: No LLM provider credential is registered for this organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: >-
            Lifecycle/validation conflict (e.g. an unsupported provider or
            transport, a non-`pending` activation, or a revoked credential).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '422':
          description: Request body failed schema validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    LlmProviderCredentialResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          properties:
            config:
              $ref: '#/components/schemas/LlmProviderCredentialConfig'
            providers:
              type: array
              items:
                $ref: '#/components/schemas/LlmProviderCredentialProvider'
              description: The supported Anthropic-native provider catalog.
            posture:
              $ref: '#/components/schemas/LlmProviderCredentialPosture'
            provisioning_descriptor:
              $ref: '#/components/schemas/InferenceEndpointDescriptor'
              description: Secret-free operator descriptor when a config exists, else null.
              nullable: true
        meta:
          $ref: '#/components/schemas/ResponseMeta'
    ErrorEnvelope:
      type: object
      required:
        - error
        - meta
      additionalProperties: false
      properties:
        error:
          type: object
          required:
            - code
            - message
            - status
          additionalProperties: false
          properties:
            code:
              type: string
            message:
              type: string
            status:
              type: integer
            details:
              type: object
              nullable: true
              additionalProperties: true
        meta:
          type: object
          required:
            - request_id
            - timestamp
          additionalProperties: false
          properties:
            request_id:
              type: string
              description: Unique request identifier (also returned as X-Request-Id header)
            timestamp:
              type: string
              format: date-time
            docs_url:
              type: string
              format: uri
              nullable: true
    LlmProviderCredentialConfig:
      type: object
      nullable: true
      description: >-
        The org's registered credential config (null element of the response =
        no credential registered). Secret-free.
      properties:
        provider:
          type: string
          enum:
            - anthropic
            - bedrock
            - vertex
        region:
          type: string
        base_url:
          type: string
          nullable: true
        credential_transport:
          type: string
          enum:
            - api_key
            - auth_token
        fingerprint:
          type: string
          description: Truncated SHA-256 fingerprint of the secret (audit).
        key_alias:
          type: string
          nullable: true
        state:
          type: string
          enum:
            - pending
            - active
            - revoked
          description: >-
            Lifecycle state: registrations start `pending`, become `active` on
            activation, and `revoked` on revocation.
        enforced:
          type: boolean
          description: Whether inference routing is forced through this credential.
        justification:
          type: string
          nullable: true
        pooled_fallback_enabled:
          type: boolean
          description: >-
            Opt-in automatic degrade to Orbit's pooled model on repeated
            endpoint failure (default off).
        rotation_count:
          type: integer
          minimum: 0
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        activated_at:
          type: string
          format: date-time
          nullable: true
        rotated_at:
          type: string
          format: date-time
          nullable: true
        revoked_at:
          type: string
          format: date-time
          nullable: true
    LlmProviderCredentialProvider:
      type: object
      description: Catalog metadata for one supported provider.
      properties:
        provider:
          type: string
          enum:
            - anthropic
            - bedrock
            - vertex
        label:
          type: string
          description: Human-readable label for the UI.
        description:
          type: string
          description: What the customer supplies.
        requiresBaseUrl:
          type: boolean
          description: >-
            Whether an in-region endpoint URL is required (direct Anthropic
            defaults to the global endpoint).
        exampleBaseUrl:
          type: string
          nullable: true
          description: Canonical example endpoint URL for the UI placeholder.
        transports:
          type: array
          items:
            type: string
            enum:
              - api_key
              - auth_token
          description: Credential transports this provider supports.
    LlmProviderCredentialPosture:
      type: object
      description: >-
        Resolved credential posture for consumers. When a revoked (or no)
        config, every identifying field is null / false.
      properties:
        enabled:
          type: boolean
          description: A non-revoked credential is registered.
        enforced:
          type: boolean
          description: A credential is active AND enforced — inference routes through it.
        state:
          type: string
          enum:
            - pending
            - active
            - revoked
          nullable: true
        provider:
          type: string
          enum:
            - anthropic
            - bedrock
            - vertex
          nullable: true
        region:
          type: string
          nullable: true
        base_url:
          type: string
          nullable: true
        fingerprint:
          type: string
          nullable: true
          description: Credential fingerprint to stamp into audit trails, or null.
        pooled_fallback_enabled:
          type: boolean
    InferenceEndpointDescriptor:
      type: object
      description: >-
        Secret-free operator-provisioning descriptor for the registered config
        (shape-compatible with the in-region inference secret minus its
        credential).
      properties:
        provider:
          type: string
          enum:
            - anthropic
            - bedrock
            - vertex
        region:
          type: string
        baseURL:
          type: string
          description: >-
            Effective endpoint URL; direct Anthropic with no override resolves
            to https://api.anthropic.com.
        credentialTransport:
          type: string
          enum:
            - api_key
            - auth_token
        fingerprint:
          type: string
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  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_*)

````