> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thinnest.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get BYOK Status

> Get configuration status for all BYOK providers

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.thinnest.ai/byok/status \
    -H "Authorization: Bearer $THINNESTAI_API_KEY"
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.thinnest.ai/byok/status"
  headers = {
      "Authorization": "Bearer " + "YOUR_THINNESTAI_API_KEY",
  }

  response = requests.get(url, headers=headers)
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch("https://api.thinnest.ai/byok/status", {
    method: "GET",
    headers: {
      "Authorization": "Bearer " + "YOUR_THINNESTAI_API_KEY",
    },
  });

  const data = await response.json();
  console.log(data);
  ```

  ```go Go theme={null}
  package main

  import (
      "fmt"
      "io"
      "net/http"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://api.thinnest.ai/byok/status", nil)
      req.Header.Set("Authorization", "Bearer YOUR_THINNESTAI_API_KEY")

      resp, err := http.DefaultClient.Do(req)
      if err != nil { panic(err) }
      defer resp.Body.Close()
      body, _ := io.ReadAll(resp.Body)
      fmt.Println(string(body))
  }
  ```
</RequestExample>

## Get BYOK Status

Returns the configuration status of all BYOK providers for the authenticated user.

### Request

```
GET /byok/status
Authorization: Bearer {token}
```

### Response

<ResponseExample>
  ```json 200 theme={null}
  {
    "providers": [
      {
        "provider": "openai",
        "name": "OpenAI",
        "type": "llm",
        "description": "GPT-4o, GPT-4o-mini, o1, o3, o4",
        "docs_url": "https://platform.openai.com/api-keys",
        "logo": "/logos/OpenAI.png",
        "is_configured": true,
        "masked_key": "****Hn4F"
      },
      {
        "provider": "anthropic",
        "name": "Anthropic",
        "type": "llm",
        "description": "Claude 4, Claude 3.5 Sonnet",
        "docs_url": "https://console.anthropic.com/settings/keys",
        "logo": "/logos/anthropic.png",
        "is_configured": false,
        "masked_key": null
      }
    ]
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /byok/status
openapi: 3.1.0
info:
  title: ThinnestAI API
  description: REST API for ThinnestAI — build, deploy, and manage AI agents.
  version: 1.0.0
servers: []
security: []
tags:
  - name: Agents
    description: Create, configure, and manage AI agents
  - name: Chat
    description: Send messages and get AI responses from agents
  - name: Knowledge
    description: Upload files, URLs, and text to agent knowledge bases
  - name: Sessions
    description: View and manage chat sessions and message history
  - name: Voice
    description: Start and manage voice call sessions
  - name: Recordings
    description: Manage voice call recordings
  - name: Campaigns
    description: Create and run automated outreach campaigns
  - name: Webhooks
    description: Register webhook endpoints for real-time event notifications
  - name: Evaluations
    description: Run and track agent evaluation benchmarks
  - name: Analytics
    description: Query agent performance metrics and usage data
  - name: Agent Tools
    description: View and manage tools attached to agents
  - name: BYOK
    description: >-
      Bring Your Own Key — manage credentials for LLM/STT/TTS providers,
      telephony BYOK (Vobiz/Twilio/Plivo/Exotel/Telnyx), and tool-specific BYOK
      (Razorpay UPI Payment, Surepass Aadhaar eKYC)
paths:
  /byok/status:
    get:
      tags:
        - BYOK
      summary: Get Byok Status
      description: Get status of all BYOK providers for the current user.
      operationId: get_byok_status_byok_status_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties:
                  items:
                    $ref: '#/components/schemas/ByokProviderStatus'
                  type: array
                type: object
                title: Response Get Byok Status Byok Status Get
      security:
        - HTTPBearer: []
components:
  schemas:
    ByokProviderStatus:
      properties:
        provider:
          type: string
          title: Provider
        name:
          type: string
          title: Name
        type:
          type: string
          title: Type
        description:
          type: string
          title: Description
        docs_url:
          type: string
          title: Docs Url
        logo:
          type: string
          title: Logo
        is_configured:
          type: boolean
          title: Is Configured
        masked_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Masked Key
      type: object
      required:
        - provider
        - name
        - type
        - description
        - docs_url
        - logo
        - is_configured
      title: ByokProviderStatus
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````