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

# Test a custom LLM provider endpoint

> Probes an OpenAI-compatible endpoint (Azure AI Foundry, LiteLLM, vLLM, gateways) with the given credential: normalizes common base-URL mistakes, calls GET /models, and returns the model ids the endpoint actually serves — on Azure these are the deployment names. Nothing is stored.



## OpenAPI

````yaml /openapi.json post /v1/llm-providers/test-connection
openapi: 3.1.0
info:
  title: Den API
  description: >-
    OpenAPI spec for the Den control plane API.


    Authentication:

    - Use `Authorization: Bearer <session-token>` for user-authenticated routes
    that require a Den session.

    - Use `x-api-key: <den-api-key>` for API-key-authenticated routes that
    accept organization API keys.

    - Public routes like health and documentation do not require authentication.


    Swagger tip: use the security schemes in the Authorize dialog to set either
    `bearerAuth` or `denApiKey` before trying protected endpoints.
  version: dev
servers: []
security: []
tags:
  - name: System
    description: Service health and operational routes.
  - name: Organizations
    description: Top-level organization creation and context routes.
  - name: Invitations
    description: Invitation preview, acceptance, creation, and cancellation routes.
  - name: API Keys
    description: Organization API key management routes.
  - name: SCIM
    description: Organization SCIM connector management routes.
  - name: SSO
    description: Organization single sign-on connector management routes.
  - name: Members
    description: Organization member management routes.
  - name: Roles
    description: Organization custom role management routes.
  - name: Teams
    description: Organization team management routes.
  - name: Templates
    description: Organization shared template routes.
  - name: LLM Providers
    description: Organization LLM provider catalog, configuration, and access routes.
  - name: Skills
    description: Organization skill authoring and sharing routes.
  - name: Skill Hubs
    description: Organization skill hub management and access routes.
  - name: Workers
    description: Worker lifecycle, billing, and runtime routes.
  - name: Worker Runtime
    description: Worker runtime inspection and upgrade routes.
  - name: Worker Activity
    description: Worker heartbeat and activity reporting routes.
  - name: Telemetry
    description: Telemetry event ingestion and adoption analytics.
  - name: Admin
    description: Administrative reporting routes.
  - name: Users
    description: Current user and membership routes.
  - name: Bootstrap
    description: Agent-first provisional workspace setup routes.
paths:
  /v1/llm-providers/test-connection:
    post:
      tags:
        - LLM Providers
      summary: Test a custom LLM provider endpoint
      description: >-
        Probes an OpenAI-compatible endpoint (Azure AI Foundry, LiteLLM, vLLM,
        gateways) with the given credential: normalizes common base-URL
        mistakes, calls GET /models, and returns the model ids the endpoint
        actually serves — on Azure these are the deployment names. Nothing is
        stored.
      operationId: postV1LlmProvidersTestConnection
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                api:
                  type: string
                  minLength: 1
                  maxLength: 2048
                apiKey:
                  type: string
                  maxLength: 65535
                modelIds:
                  maxItems: 8
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 255
              required:
                - api
      responses:
        '200':
          description: Probe completed (ok=false carries a human hint).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LlmProviderTestConnectionResponse'
        '400':
          description: The probe request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
        '401':
          description: The caller must be signed in to test provider endpoints.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
components:
  schemas:
    LlmProviderTestConnectionResponse:
      type: object
      properties:
        result:
          type: object
          properties:
            ok:
              type: boolean
            vendor:
              type: string
              enum:
                - azure
                - openai-compatible
            normalizedApi:
              anyOf:
                - type: string
                - type: 'null'
            attempted:
              type: array
              items:
                type: string
            models:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                required:
                  - id
            hint:
              anyOf:
                - type: string
                - type: 'null'
            status:
              anyOf:
                - type: number
                - type: 'null'
          required:
            - ok
            - vendor
            - normalizedApi
            - attempted
            - models
            - hint
            - status
        verifications:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              status:
                type: string
                enum:
                  - ok
                  - adjusted
                  - failed
              npm:
                type: string
                enum:
                  - '@ai-sdk/openai-compatible'
                  - '@ai-sdk/openai'
              message:
                anyOf:
                  - type: string
                  - type: 'null'
            required:
              - id
              - status
              - npm
              - message
      required:
        - result
    InvalidRequestError:
      type: object
      properties:
        error:
          type: string
          const: invalid_request
        details:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
            required:
              - message
            additionalProperties: {}
      required:
        - error
        - details
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          const: unauthorized
      required:
        - error

````