HUD

HUD Byok Credentials API

The byok-credentials API from HUD — 2 operation(s) for byok-credentials.

GitHub OpenAPI

Operations 4

GET /v2/byok-credentials List Byok Credentials #
POST /v2/byok-credentials Create Byok Credential #
PATCH /v2/byok-credentials/{credential_id} Update Byok Credential #
DELETE /v2/byok-credentials/{credential_id} Delete Byok Credential #

Documentation

📖
APIReference
https://api.beta.hud.ai/docs
📖
Documentation
https://docs.hud.ai/platform/rest-api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/hud-ai/openapi/hud-ai-byok-credentials-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-trace-info-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-model-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-registry-detail-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-build-register-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-trace-analysis-context-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-build-response-schema.json

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/hud-ai:hud-ai-byok-credentials-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

hud-ai-byok-credentials-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HUD Platform Byok Credentials API
  version: 2.0.0
tags:
- name: byok-credentials
paths:
  /v2/byok-credentials:
    get:
      tags:
      - byok-credentials
      summary: List Byok Credentials
      description: List the caller's personal and team BYOK credentials with masked values.
      operationId: list_byok_credentials_v2_byok_credentials_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ByokCredentialsListResponse'
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - byok-credentials
      summary: Create Byok Credential
      description: Create or replace a provider credential for one ownership scope.
      operationId: create_byok_credential_v2_byok_credentials_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ByokCredentialCreateRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ByokCredentialItem'
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v2/byok-credentials/{credential_id}:
    patch:
      tags:
      - byok-credentials
      summary: Update Byok Credential
      description: Rotate a BYOK credential without exposing its plaintext value.
      operationId: update_byok_credential_v2_byok_credentials__credential_id__patch
      parameters:
      - name: credential_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Credential Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ByokCredentialUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ByokCredentialItem'
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - byok-credentials
      summary: Delete Byok Credential
      description: Disable a BYOK credential and erase its encrypted value.
      operationId: delete_byok_credential_v2_byok_credentials__credential_id__delete
      parameters:
      - name: credential_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Credential Id
      responses:
        '204':
          description: Successful Response
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ByokProviderOption:
      properties:
        provider_id:
          type: integer
          title: Provider Id
        provider_name:
          type: string
          title: Provider Name
        name:
          type: string
          title: Name
      type: object
      required:
      - provider_id
      - provider_name
      - name
      title: ByokProviderOption
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
        source:
          $ref: '#/components/schemas/ErrorSource'
        detail:
          type: string
          title: Detail
      type: object
      required:
      - error
      - source
      - detail
      title: ErrorResponse
      description: The uniform `{error, source, detail}` envelope returned for every 4xx/5xx.
    ErrorSource:
      type: string
      enum:
      - user
      - platform
      - provider
      title: ErrorSource
      description: 'Who is at fault for a failure.


        ``user``: the customer''s input, account, environment, or agent code.

        ``platform``: HUD infrastructure or a broken platform invariant.

        ``provider``: a third-party dependency (cloud runtime, upstream LLM API).'
    ByokCredentialUpdateRequest:
      properties:
        value:
          type: string
          title: Value
      additionalProperties: false
      type: object
      required:
      - value
      title: ByokCredentialUpdateRequest
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        error:
          type: string
          const: validation_error
          title: Error
        source:
          type: string
          enum:
          - user
          - platform
          - provider
          title: Source
        detail:
          type: string
          title: Detail
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Errors
      required:
      - error
      - source
      - detail
      - errors
    ByokCredentialItem:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        provider_id:
          type: integer
          title: Provider Id
        provider_name:
          type: string
          title: Provider Name
        name:
          type: string
          title: Name
        scope:
          type: string
          enum:
          - member
          - team
          title: Scope
        masked_value:
          type: string
          title: Masked Value
        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_id
      - provider_name
      - name
      - scope
      - masked_value
      - created_at
      - updated_at
      title: ByokCredentialItem
    ByokCredentialCreateRequest:
      properties:
        provider_id:
          type: integer
          title: Provider Id
        scope:
          type: string
          enum:
          - member
          - team
          title: Scope
        value:
          type: string
          title: Value
      additionalProperties: false
      type: object
      required:
      - provider_id
      - scope
      - value
      title: ByokCredentialCreateRequest
    ByokCredentialsListResponse:
      properties:
        credentials:
          items:
            $ref: '#/components/schemas/ByokCredentialItem'
          type: array
          title: Credentials
        providers:
          items:
            $ref: '#/components/schemas/ByokProviderOption'
          type: array
          title: Providers
      type: object
      required:
      - credentials
      - providers
      title: ByokCredentialsListResponse
    ValidationError:
      title: ValidationError
      type: object
      properties:
        type:
          type: string
          title: Error Type
        loc:
          type: array
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
        msg:
          type: string
          title: Message
      required:
      - type
      - loc
      - msg
x-hud-contract-scope: platform_public