Hlix Providers API

Connected model billing providers.

GitHub OpenAPI

Operations 8

GET /v1/api/providers List connected model billing providers #
POST /v1/api/providers Save a workspace model provider #
DELETE /v1/api/providers/{provider} Disconnect a model provider #
GET /v1/api/providers/{provider} Read a model provider configuration #
PATCH /v1/api/providers/{provider} Update a model provider #
GET /v1/api/providers/{provider}/models Read cached models advertised by this billing provider #
POST /v1/api/providers/{provider}/models/refresh Refresh the connected provider model catalog #
POST /v1/api/providers/{provider}/test Test provider credentials without inference #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/hlix-ai:hlix-ai-providers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hlix-ai-providers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: Explore the Hlix API for projects, agent teams, and delivery workflows. Authenticate with `x-api-key` and select a Workspace with `X-Organization-Id`. Session-only operations require a signed-in user session. Authentication setup.
  title: reference Providers API
  version: 1.0.0
servers:
- url: https://server.hlix.ai
  description: API server
security:
- apiKey: []
- sessionCookie: []
tags:
- description: Connected model billing providers.
  name: Providers
paths:
  /v1/api/providers:
    get:
      operationId: listModelProviders
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ModelProviderConfig'
                type: array
          description: Safe workspace provider configuration, no credentials or model payloads.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Agency only; mutations require owner/admin.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: List connected model billing providers
      tags:
      - Providers
    post:
      operationId: connectModelProvider
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertProvider'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelProviderConfig'
          description: Provider configuration saved.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: Invalid provider or body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Agency only; mutations require owner/admin.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: Save a workspace model provider
      tags:
      - Providers
  /v1/api/providers/{provider}:
    delete:
      operationId: deleteModelProvider
      parameters:
      - in: path
        name: provider
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelProviderRemoved'
          description: Disconnected.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: Invalid provider or body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Agency only; mutations require owner/admin.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: Disconnect a model provider
      tags:
      - Providers
    get:
      operationId: getModelProvider
      parameters:
      - in: path
        name: provider
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelProviderConfig'
          description: Safe provider configuration.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: Invalid provider or body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Agency only; mutations require owner/admin.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No stored provider credentials.
      summary: Read a model provider configuration
      tags:
      - Providers
    patch:
      operationId: updateModelProvider
      parameters:
      - in: path
        name: provider
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchProvider'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelProviderConfig'
          description: Provider configuration saved.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: Invalid provider or body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Agency only; mutations require owner/admin.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: Update a model provider
      tags:
      - Providers
  /v1/api/providers/{provider}/models:
    get:
      operationId: getModelProviderModels
      parameters:
      - in: path
        name: provider
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoderAccountModelCatalog'
          description: Cached advertised metadata; never probes or proves entitlement.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: Invalid provider or body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Agency only; mutations require owner/admin.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: Read cached models advertised by this billing provider
      tags:
      - Providers
  /v1/api/providers/{provider}/models/refresh:
    post:
      operationId: refreshModelProviderModels
      parameters:
      - in: path
        name: provider
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoderAccountModelCatalog'
          description: Bounded advertised metadata.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: Invalid provider or body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Agency only; mutations require owner/admin.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Connect this provider or refresh after its credential changed.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Provider model list unavailable.
      summary: Refresh the connected provider model catalog
      tags:
      - Providers
  /v1/api/providers/{provider}/test:
    post:
      operationId: testModelProvider
      parameters:
      - in: path
        name: provider
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestModelProvider'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelProviderProbe'
          description: Read-only provider check.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: Invalid provider or body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Agency only; mutations require owner/admin.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No stored provider credentials.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelProviderProbe'
          description: Provider check failed.
      summary: Test provider credentials without inference
      tags:
      - Providers
components:
  schemas:
    ApiError:
      additionalProperties: {}
      properties:
        error:
          type: string
      required:
      - error
      type: object
    TestModelProvider:
      properties:
        apiKey:
          minLength: 1
          type: string
        baseUrl:
          anyOf:
          - format: uri
            type: string
          - type: 'null'
      type: object
    ModelProviderProbe:
      properties:
        detail:
          type: string
        ok:
          type: boolean
        status:
          type: number
      required:
      - ok
      type: object
    PatchProvider:
      properties:
        apiKey:
          type:
          - string
          - 'null'
        baseUrl:
          anyOf:
          - format: uri
            type: string
          - type: 'null'
        enabled:
          type: boolean
        metadata:
          anyOf:
          - additionalProperties: {}
            propertyNames:
              type: string
            type: object
          - type: 'null'
      type: object
    ModelProviderRemoved:
      properties:
        ok:
          const: true
          type: boolean
      required:
      - ok
      type: object
    ModelProviderConfig:
      properties:
        baseUrl:
          type:
          - string
          - 'null'
        createdAt:
          type: string
        enabled:
          type: boolean
        hasApiKey:
          type: boolean
        id:
          type: string
        metadata:
          anyOf:
          - additionalProperties: {}
            propertyNames:
              type: string
            type: object
          - type: 'null'
        provider:
          enum:
          - openai
          - anthropic
          - openrouter
          - moonshot
          - deepseek
          - zai
          - google
          - xai
          - mistral
          - groq
          type: string
        updatedAt:
          type: string
      required:
      - id
      - provider
      - baseUrl
      - metadata
      - enabled
      - hasApiKey
      - createdAt
      - updatedAt
      type: object
    UpsertProvider:
      properties:
        apiKey:
          type:
          - string
          - 'null'
        baseUrl:
          anyOf:
          - format: uri
            type: string
          - type: 'null'
        enabled:
          type: boolean
        metadata:
          anyOf:
          - additionalProperties: {}
            propertyNames:
              type: string
            type: object
          - type: 'null'
        provider:
          enum:
          - openai
          - anthropic
          - openrouter
          - moonshot
          - deepseek
          - zai
          - google
          - xai
          - mistral
          - groq
          type: string
      required:
      - provider
      type: object
    ValidationError:
      properties:
        error:
          properties:
            message:
              type: string
            name:
              type: string
          required:
          - name
          - message
          type: object
        success:
          const: false
          type: boolean
      required:
      - success
      - error
      type: object
    CoderAccountModelCatalog:
      properties:
        capturedAt:
          type:
          - string
          - 'null'
        models:
          items:
            additionalProperties: false
            properties:
              id:
                maxLength: 200
                minLength: 1
                pattern: ^[\w./:~@+-]+$
                type: string
              name:
                maxLength: 256
                minLength: 1
                pattern: ^[^\x00-\x1f\x7f]+$
                type: string
            required:
            - id
            - name
            type: object
          maxItems: 1000
          type: array
        source:
          anyOf:
          - enum:
            - native
            - api
            type: string
          - type: 'null'
        status:
          enum:
          - available
          - unknown
          - stale
          type: string
      required:
      - models
      - status
      - source
      - capturedAt
      type: object
  parameters:
    OrganizationId:
      description: The workspace (organization) to act in. Omitted, the session's active organization is used.
      in: header
      name: X-Organization-Id
      required: false
      schema:
        type: string
      example: YOUR_WORKSPACE_ID
  securitySchemes:
    apiKey:
      description: An API key issued through `/v1/api/auth/api-key/*`. Browser clients can use their session cookie instead.
      in: header
      name: x-api-key
      type: apiKey
    sessionCookie:
      description: The complete session Cookie header issued by sign-in at the selected API host. Cookie names vary by hosting region and environment; preserve the issued name and value. Browsers send these HTTP-only cookies automatically. Session-only operations require this user session and do not accept an API key.
      in: header
      name: Cookie
      type: apiKey