whoisgeni-us Byok API

openapi: 3.2.0
info:
  title: WhoisGenius Byok API
  description: 'Domain intelligence platform with AI-powered operator attribution Responses are JSON by default; request the compact, token-efficient TOON format with the `Accept: application/toon` header.'
  version: 0.1.0
tags:
- name: byok
paths:
  /account/llm-keys:
    get:
      tags:
      - byok
      summary: List BYOK LLM API keys
      description: 'List all active BYOK LLM API keys for the authenticated user.


        Never includes raw or encrypted key values in the response.'
      operationId: list_byok_keys_account_llm_keys_get
      responses:
        '200':
          description: Active keys for the authenticated user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_BYOKKeyListResponse_'
        '403':
          description: Tier insufficient — Team or higher required
        '401':
          description: Unauthorized — missing or invalid API key/JWT.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                  meta:
                    type: 'null'
      security:
      - HTTPBearer: []
    post:
      tags:
      - byok
      summary: Save a BYOK LLM API key
      description: 'Save (create or update) an encrypted BYOK LLM API key.


        Validates the key via a test inference call before persisting.

        One key per provider per user -- saving for an existing provider

        replaces the previous key.'
      operationId: save_byok_key_account_llm_keys_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveBYOKKeyRequest'
        required: true
      responses:
        '200':
          description: Saved key details (never includes raw key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_BYOKKeyResponse_'
        '400':
          description: Unsupported provider
        '403':
          description: Tier insufficient — Team or higher required
        '422':
          description: Key validation failed (invalid/expired key)
        '401':
          description: Unauthorized — missing or invalid API key/JWT.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                  meta:
                    type: 'null'
      security:
      - HTTPBearer: []
  /account/llm-keys/{provider}:
    delete:
      tags:
      - byok
      summary: Delete a BYOK LLM API key
      description: 'Soft-delete a BYOK LLM API key by provider name.


        Returns 204 on success, 404 if no active key exists for the given provider.'
      operationId: delete_byok_key_account_llm_keys__provider__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: provider
        in: path
        required: true
        schema:
          type: string
          title: Provider
      responses:
        '204':
          description: Deletion confirmation
        '403':
          description: Tier insufficient — Team or higher required
        '404':
          description: No active key found for this provider
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: Unauthorized — missing or invalid API key/JWT.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                  meta:
                    type: 'null'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
        details:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Details
      type: object
      required:
      - code
      - message
      title: ErrorDetail
      description: "Structured error information for API error responses.\n\nAttributes:\n    code: Machine-readable error code (e.g. \"JOB_NOT_FOUND\").\n    message: Human-readable error description.\n    details: Optional additional context for debugging."
      example:
        code: JOB_NOT_FOUND
        message: No job found with the given ID.
    BYOKKeyListResponse:
      properties:
        keys:
          items:
            $ref: '#/components/schemas/BYOKKeyResponse'
          type: array
          title: Keys
      type: object
      required:
      - keys
      title: BYOKKeyListResponse
      description: Response body listing all BYOK keys for a user.
    BYOKKeyResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        provider:
          type: string
          title: Provider
        key_prefix:
          type: string
          title: Key Prefix
        is_active:
          type: boolean
          title: Is Active
        last_used_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Used At
        last_validated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Validated At
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
      - id
      - provider
      - key_prefix
      - is_active
      - created_at
      - updated_at
      title: BYOKKeyResponse
      description: Response body for a single BYOK key. Never includes the raw or encrypted key.
    SaveBYOKKeyRequest:
      properties:
        provider:
          type: string
          title: Provider
          description: 'LLM provider name: "openai", "anthropic", "google", "mistral", "groq"'
        api_key:
          type: string
          minLength: 1
          title: Api Key
          description: Raw API key (will be encrypted server-side, never stored in plaintext)
      type: object
      required:
      - provider
      - api_key
      title: SaveBYOKKeyRequest
      description: Request body for saving (creating or updating) a BYOK LLM API key.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ApiResponse_BYOKKeyListResponse_:
      properties:
        data:
          anyOf:
          - $ref: '#/components/schemas/BYOKKeyListResponse'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      title: ApiResponse[BYOKKeyListResponse]
    ApiResponse_BYOKKeyResponse_:
      properties:
        data:
          anyOf:
          - $ref: '#/components/schemas/BYOKKeyResponse'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      title: ApiResponse[BYOKKeyResponse]
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer