APIPASS API Marketplace Models API

openapi: 3.2.0
info:
  title: ApiPass Platform Models API
  version: 1.0.0
tags:
- name: Models
paths:
  /v1/models/brands:
    get:
      tags:
      - Models
      summary: List Brands
      description: '获取所有品牌列表


        返回所有可用的品牌及其模型数量，用于前端筛选器'
      operationId: list_brands_v1_models_brands_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandsListResponse'
  /v1/models/task-types:
    get:
      tags:
      - Models
      summary: List Task Types
      description: '获取所有任务类型列表


        返回所有可用的任务类型及其支持的模型数量，用于前端筛选器'
      operationId: list_task_types_v1_models_task_types_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskTypesListResponse'
  /v1/models/types/{model_type_name}/credit-rules:
    get:
      tags:
      - Models
      summary: Get Model Credit Rules
      description: '获取指定模型类型的积分规则


        返回该模型的所有积分规则及定价基础信息，用于前端展示积分计算逻辑


        示例：

        - /v1/models/types/google/nano-banana-pro/credit-rules'
      operationId: get_model_credit_rules_v1_models_types__model_type_name__credit_rules_get
      parameters:
      - name: model_type_name
        in: path
        required: true
        schema:
          type: string
          title: Model Type Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditRulesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/models/types/{model_type_name}/calculate-credits:
    post:
      tags:
      - Models
      summary: Calculate Credits
      description: '计算指定参数下的积分消耗


        根据输入参数和当前 API Key 的用户配额匹配积分规则，返回创建任务时的预扣积分。

        对 Kling motion-control 等按输入媒体时长计费的模型，会安全探测媒体 URL；

        无法取得时长时返回 400，不会退回按 1 秒计费。

        非媒体请求只缓存固定渠道下的基础积分计算，最长 10 分钟；

        auto 的渠道选择、Starter 配额和 Provider 可用性始终实时检查。


        示例：

        POST /v1/models/types/google/nano-banana-pro/calculate-credits

        Body: {"input_params": {"duration": 5}}'
      operationId: calculate_credits_v1_models_types__model_type_name__calculate_credits_post
      parameters:
      - name: model_type_name
        in: path
        required: true
        schema:
          type: string
          title: Model Type Name
      - name: authorization
        in: header
        required: true
        schema:
          type: string
          description: Bearer YOUR_API_KEY
          title: Authorization
        description: Bearer YOUR_API_KEY
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculateCreditsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculateCreditsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/models/kie/elevenlabs-text-to-dialogue-v3/voices:
    get:
      tags:
      - Models
      summary: Get Kie Elevenlabs Text To Dialogue V3 Voices
      description: '返回 elevenlabs_text_to_dialogue_v3 可直接使用的默认音色列表。


        数据来源于仓库内置的静态 JSON，供客户端在调用该模型前拉取默认可用音色。'
      operationId: get_kie_elevenlabs_text_to_dialogue_v3_voices_v1_models_kie_elevenlabs_text_to_dialogue_v3_voices_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KieElevenLabsVoicesResponse'
  /v1/models/types/{model_type_name}:
    get:
      tags:
      - Models
      summary: Get Model Type Detail
      description: '查询单个 model_type 的详细信息（包含 playground_config、examples、readme、api_reference）


        通过 model_type 的 name 查询完整的配置信息，包括：

        - 基本信息（name, display_name 等）

        - 关联的模型信息（model_name, brand等）

        - 任务类型信息（task_type, task_type_name）

        - 4个JSON配置字段（playground_config, examples, readme, api_reference）


        示例：

        - /v1/models/types/google/nano-banana-pro - 查询 google/nano-banana-pro 的详细配置

        - /v1/models/types/claude-sonnet-4-5 - 查询 claude-sonnet-4-5 的详细配置'
      operationId: get_model_type_detail_v1_models_types__model_type_name__get
      parameters:
      - name: model_type_name
        in: path
        required: true
        schema:
          type: string
          title: Model Type Name
      - name: locale
        in: query
        required: false
        schema:
          type: string
          description: 语言代码，如 en、de、fr、ja、ko
          default: en
          title: Locale
        description: 语言代码，如 en、de、fr、ja、ko
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelTypeDetail'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/models/{model_slug}:
    get:
      tags:
      - Models
      summary: Get Model Detail
      description: '查询单个模型的详细信息


        通过模型的 slug 查询模型的完整信息，包括：

        - 模型基本信息（brand, name, description, thumbnail等）

        - 支持的所有任务类型

        - 所有可用的端点配置（model_types）


        示例：

        - /v1/models/veo-3-1 - 查询 Veo 3.1 模型的详细信息

        - /v1/models/nano-banana - 查询 nano-banana 模型的详细信息'
      operationId: get_model_detail_v1_models__model_slug__get
      parameters:
      - name: model_slug
        in: path
        required: true
        schema:
          type: string
          title: Model Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelInfo'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TaskTypeInfo:
      properties:
        id:
          type: string
          title: Id
          description: 任务类型ID
        name:
          type: string
          title: Name
          description: 任务类型名称
        slug:
          type: string
          title: Slug
          description: URL友好标识
        category:
          type: string
          title: Category
          description: 所属分类
        model_count:
          type: integer
          title: Model Count
          description: 支持该任务类型的模型数量
      type: object
      required:
      - id
      - name
      - slug
      - category
      - model_count
      title: TaskTypeInfo
      description: 任务类型信息
    CalculateCreditsResponse:
      properties:
        credit_cost:
          type: number
          title: Credit Cost
          description: 积分消耗
        cost_unit:
          type: string
          title: Cost Unit
          description: 收费单位，如 per run/per second/per video/per million tokens
          default: per run
        matched_rule_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Matched Rule Name
          description: 匹配的规则名称
        matched_rule_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Matched Rule Id
          description: 匹配的规则ID
        channel_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Channel Type
          description: 实际计费类别：starter / enterprise / custom_enterprise / regular / official
        matched_rule:
          anyOf:
          - $ref: '#/components/schemas/CreditRuleInfo'
          - type: 'null'
          description: 真实计费路径命中的完整积分规则
        matched_rules:
          items:
            $ref: '#/components/schemas/CreditRuleInfo'
          type: array
          title: Matched Rules
          description: 当前参数跨渠道命中的规则列表
        is_default:
          type: boolean
          title: Is Default
          description: 是否使用默认积分
      type: object
      required:
      - credit_cost
      - is_default
      title: CalculateCreditsResponse
      description: 计算积分响应
    ModelTypeDetail:
      properties:
        id:
          type: string
          title: Id
          description: 模型类型ID
        name:
          type: string
          title: Name
          description: 端点名称
        display_name:
          type: string
          title: Display Name
          description: 端点展示名称
        model_id:
          type: string
          title: Model Id
          description: 关联的模型ID
        model_name:
          type: string
          title: Model Name
          description: 模型名称
        model_slug:
          type: string
          title: Model Slug
          description: 模型slug
        brand:
          type: string
          title: Brand
          description: 品牌
        task_type:
          type: string
          title: Task Type
          description: 任务类型slug
        task_type_name:
          type: string
          title: Task Type Name
          description: 任务类型名称
        input_schema:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Input Schema
          description: 输入参数schema
        example_request:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Example Request
          description: 请求示例
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: 端点描述
        playground_config:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Playground Config
          description: Playground组件的JSON配置
        examples:
          anyOf:
          - items: {}
            type: array
          - type: 'null'
          title: Examples
          description: Examples的JSON配置
        readme:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Readme
          description: Readme的JSON配置
        api_reference:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Api Reference
          description: API Reference的JSON配置
        seo_info:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Seo Info
          description: SEO相关信息
        pricing_info:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Pricing Info
          description: 定价信息
        sort_order:
          type: integer
          title: Sort Order
          description: 展示排序；0 表示未设置并排在最后，非 0 数值越小越靠前
          default: 0
        is_active:
          type: boolean
          title: Is Active
          description: 是否启用
      type: object
      required:
      - id
      - name
      - display_name
      - model_id
      - model_name
      - model_slug
      - brand
      - task_type
      - task_type_name
      - is_active
      title: ModelTypeDetail
      description: 模型类型详细信息
    CalculateCreditsRequest:
      properties:
        input_params:
          additionalProperties: true
          type: object
          title: Input Params
          description: 输入参数
        channel:
          type: string
          title: Channel
          description: 渠道选择：starter / enterprise / regular / official / auto，默认 auto
          default: auto
        channel_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Channel Type
          description: 兼容字段；如果传入则覆盖 channel
      type: object
      required:
      - input_params
      title: CalculateCreditsRequest
      description: 计算积分请求
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    BrandInfo:
      properties:
        brand:
          type: string
          title: Brand
          description: 品牌名称
        model_count:
          type: integer
          title: Model Count
          description: 该品牌下的模型数量
      type: object
      required:
      - brand
      - model_count
      title: BrandInfo
      description: 品牌信息
    CreditRulesResponse:
      properties:
        model_type_name:
          type: string
          title: Model Type Name
          description: 模型类型名称
        display_name:
          type: string
          title: Display Name
          description: 展示名称
        pricing_note:
          anyOf:
          - type: string
          - type: 'null'
          title: Pricing Note
          description: Pricing 页面展示的 Markdown 说明
        default_credit_cost:
          type: number
          title: Default Credit Cost
          description: 无匹配规则时返回 0
          default: 0.0
        credit_rules:
          items:
            $ref: '#/components/schemas/CreditRuleInfo'
          type: array
          title: Credit Rules
          description: 积分规则列表
        pricing_base:
          $ref: '#/components/schemas/PricingBase'
      type: object
      required:
      - model_type_name
      - display_name
      - credit_rules
      - pricing_base
      title: CreditRulesResponse
      description: 积分规则列表响应
    CreditRuleInfo:
      properties:
        id:
          type: string
          title: Id
          description: 规则ID
        name:
          type: string
          title: Name
          description: 规则名称
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: 规则描述
        conditions:
          additionalProperties: true
          type: object
          title: Conditions
          description: 匹配条件
        credit_cost:
          type: number
          title: Credit Cost
          description: 积分消耗
        token_prices:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Token Prices
          description: Token 分项价格，如 input/output/cache_read
        competitor_prices:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Competitor Prices
          description: 规则级竞品价格列表
        cost_unit:
          type: string
          title: Cost Unit
          description: 收费单位，如 per run/per second/per video
          default: per run
        priority:
          type: integer
          title: Priority
          description: 优先级
        sort_order:
          type: integer
          title: Sort Order
          description: 价格展示排序，数值越大越靠前
          default: 0
        channel_type:
          type: string
          title: Channel Type
          description: 价格类别：starter / enterprise / regular / official
          default: regular
        starter_call_limit:
          anyOf:
          - type: integer
          - type: 'null'
          title: Starter Call Limit
          description: Starter 每用户次数上限
        starter_credit_limit:
          anyOf:
          - type: number
          - type: 'null'
          title: Starter Credit Limit
          description: Starter 每用户积分上限
      type: object
      required:
      - id
      - name
      - conditions
      - credit_cost
      - priority
      title: CreditRuleInfo
      description: 积分规则信息
    TaskTypesListResponse:
      properties:
        total:
          type: integer
          title: Total
          description: 任务类型总数
        task_types:
          items:
            $ref: '#/components/schemas/TaskTypeInfo'
          type: array
          title: Task Types
          description: 任务类型列表
      type: object
      required:
      - total
      - task_types
      title: TaskTypesListResponse
      description: 任务类型列表响应
    PricingBase:
      properties:
        total_credits:
          type: number
          title: Total Credits
          description: 总积分数
        total_usd:
          type: number
          title: Total Usd
          description: 总金额（美元）
        usd_per_credit:
          type: number
          title: Usd Per Credit
          description: 每积分对应的美元价格
      type: object
      required:
      - total_credits
      - total_usd
      - usd_per_credit
      title: PricingBase
      description: 定价基础信息
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    KieElevenLabsVoicesResponse:
      properties:
        voices:
          additionalProperties:
            items:
              additionalProperties: true
              type: object
            type: array
          type: object
          title: Voices
          description: 按分类分组的默认可用音色列表
      type: object
      required:
      - voices
      title: KieElevenLabsVoicesResponse
      description: Kie ElevenLabs 对话音色列表响应
    ModelEndpoint:
      properties:
        name:
          type: string
          title: Name
          description: 端点名称，如 claude-sonnet-4-5
        display_name:
          type: string
          title: Display Name
          description: 端点展示名称
        task_type:
          type: string
          title: Task Type
          description: 任务类型，如 text-to-text
        task_type_name:
          type: string
          title: Task Type Name
          description: 任务类型名称，如 Text to Text
        input_schema:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Input Schema
          description: 输入参数schema
        example_request:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Example Request
          description: 请求示例
        sort_order:
          type: integer
          title: Sort Order
          description: 展示排序；0 表示未设置并排在最后，非 0 数值越小越靠前
          default: 0
      type: object
      required:
      - name
      - display_name
      - task_type
      - task_type_name
      title: ModelEndpoint
      description: 模型端点信息
    ModelInfo:
      properties:
        id:
          type: string
          title: Id
          description: 模型ID
        brand:
          type: string
          title: Brand
          description: 品牌，如 Google、Anthropic
        name:
          type: string
          title: Name
          description: 模型名称，如 Veo 3.1、Claude Sonnet 4.5
        slug:
          type: string
          title: Slug
          description: URL友好标识
        display_name:
          type: string
          title: Display Name
          description: 展示名称
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: 模型描述
        thumbnail_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Thumbnail Url
          description: 缩略图URL
        supported_task_types:
          items:
            type: string
          type: array
          title: Supported Task Types
          description: 支持的任务类型列表
        endpoints:
          items:
            $ref: '#/components/schemas/ModelEndpoint'
          type: array
          title: Endpoints
          description: 可用的端点列表
      type: object
      required:
      - id
      - brand
      - name
      - slug
      - display_name
      - supported_task_types
      - endpoints
      title: ModelInfo
      description: 模型信息
    BrandsListResponse:
      properties:
        total:
          type: integer
          title: Total
          description: 品牌总数
        brands:
          items:
            $ref: '#/components/schemas/BrandInfo'
          type: array
          title: Brands
          description: 品牌列表
      type: object
      required:
      - total
      - brands
      title: BrandsListResponse
      description: 品牌列表响应
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer