Hermoso AI Clones API

openapi: 3.2.0
info:
  title: Hermoso Ai Clones API
  version: '2026-08-26'
  description: 'Operations tagged clones across 2 of this provider''s published API definitions: app_hermoso_ai.json, app_hermoso_ai_rest.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.hermoso.ai
security:
- bearerAuth: []
tags:
- name: clones
paths:
  /v1/clones/quote:
    post:
      operationId: quoteClone
      summary: Price a clone before running it
      description: 'What cloning an ad for this profile will cost, step by step, before anything runs. `type: image` prices the static clone (`clone_static`): reading the layout (a flat charge) plus the image render’s own hold, with the brand’s product photo attached exactly as the clone attaches it; the copy writing and the final brand check are billed at their real model cost and are listed with `credits: null`. `type: video` prices the first step of a video clone (`clone_video`: watching the original and planning the storyboard) as the server’s own estimate; the render is priced exactly once the plan exists, by calling `render_ad` with `dryRun: true`. Free: nothing is read, reserved or charged.'
      tags:
      - clones
      parameters:
      - name: X-Hermoso-User
        in: header
        required: false
        schema:
          type: string
        description: 'Which profile to act on, when the account holds more than one: an `id` from `GET /v1/brands`. Defaults to the workspace the key is pinned to. Membership is re-authorised on every request, and an id this key cannot act on is a 404 `brand_not_found`, never an empty result.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneQuoteRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloneQuote'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, invalid or revoked key — or a channel that is not connected, in which case `error.connector` names it and `error.type` is `connector_error`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: '`error.code: brand_not_found`: `X-Hermoso-User` (or the profile this key is pinned to) names a profile this key cannot act on. `GET /v1/brands` lists the valid ids.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. `Retry-After` says how long to wait.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
    servers:
    - url: https://app.hermoso.ai
components:
  schemas:
    CloneQuoteRequest:
      type: object
      required:
      - type
      - url
      properties:
        type:
          type: string
          enum:
          - image
          - video
          description: image = a static ad image to clone; video = a TikTok, Reel, Facebook, X or YouTube link (or a direct video file). This enum MAY GROW.
        url:
          type: string
          description: The https URL of the ad image (image) or of the post or video file (video).
    CloneQuote:
      type: object
      properties:
        object:
          type: string
          enum:
          - quote
        type:
          type: string
          description: clone_image or clone_video. This set MAY GROW.
        credits:
          type: number
          nullable: true
          description: 'The sum of every step priced in advance (`flat` and `hold` steps, plus `estimate` steps). Steps with `credits: null` are billed on top at their real cost.'
        steps:
          type: array
          items:
            $ref: '#/components/schemas/CloneQuoteStep'
        refused:
          type: string
          nullable: true
          description: Why the clone would not start. Nothing was charged.
        next:
          type: string
          description: What runs it, in one sentence.
    CloneQuoteStep:
      type: object
      properties:
        step:
          type: string
          description: read_layout, render, copy_and_check, plan or render_video. This set MAY GROW.
        label:
          type: string
          description: The step in plain words.
        credits:
          type: number
          nullable: true
          description: Its price, or null when it is billed at real cost or priced later.
        likely_credits:
          type: number
          nullable: true
          description: 'For a `hold` that covers an optional step (a label repair): the likely charge.'
        basis:
          type: string
          description: flat, hold, estimate, metered or later. This set MAY GROW.
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - type
          - code
          - message
          properties:
            type:
              type: string
              enum:
              - authentication_error
              - permission_error
              - invalid_request_error
              - connector_error
              - rate_limit_error
              - insufficient_credits
              - api_error
              description: The coarse family — branch on this. New CODES land inside an existing type wherever possible so that branch keeps working; the enum is published for code generation, and a client should still fall through gracefully on a member it does not recognise.
            code:
              type: string
              description: The specific reason. Log this. New values may appear at any time.
            message:
              type: string
            param:
              type: string
              description: The offending field, when there is one.
            connector:
              type: string
              description: Present when the reason is a channel that is not connected. Reconnect in the app — an OAuth consent screen cannot be completed headlessly.
            credits_needed:
              type: number
              description: 'On `insufficient_credits` from a recast or an edit: what the request needs.'
            balance:
              type: number
              description: 'On `insufficient_credits` from a recast or an edit: what this workspace has.'
            unknown_arguments:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                    description: The key that was sent.
                  did_you_mean:
                    type: string
                    nullable: true
                    description: An argument THIS tool declares that the key most likely meant, or null.
              description: 'On `invalid_arguments` from POST /v1/tools/{name}: each key the tool does not take, with the argument it most likely meant. Nothing was run.'
            upgrade_url:
              type: string
              description: 'On `real_face_needs_paid`: where to choose a paid plan.'
            alternative:
              type: string
              description: 'On `real_face_needs_paid`: the field that works on every plan instead (`person.describe`).'
            person_url:
              type: string
              description: 'On a recast with `person.describe` whose recast step was refused after the person was made: the AI person, in your Library. Send it as `person.image_url` to retry without making a new one.'
        request_id:
          type: string
          nullable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: hmk_...
      description: A Hermoso API key, or an access token from the OAuth authorization-code flow (which is the same thing).
x-refined-from:
- app_hermoso_ai.json
- app_hermoso_ai_rest.json