Hermoso AI Channels API

openapi: 3.2.0
info:
  title: Hermoso Ai Channels API
  version: '2026-08-26'
  description: 'Operations tagged channels 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: Channels
paths:
  /v1/channels:
    get:
      operationId: listChannels
      summary: List publishing channels
      description: 'Every channel Hermoso can publish to, whether this workspace has it connected, and what each supports (visibilities, carousel limits, caption length). A channel that is NOT connected is still listed, with `connected: false` — "we do not support that" and "you have not connected it" are different answers and a client must be able to tell them apart.'
      tags:
      - Channels
      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.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelList'
        '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:
    Channel:
      type: object
      properties:
        object:
          type: string
          enum:
          - channel
        id:
          type: string
        name:
          type: string
        connector:
          type: string
          description: The connection this channel is reached through. Several channels can share one — Facebook and Instagram both ride the Meta connection.
        available:
          type: boolean
          description: Whether this channel can be connected AT ALL on this deployment. False while a platform approval is outstanding — a different answer from "you have not connected it yet", and collapsing the two would send you to build a connect flow that cannot succeed.
        unavailable_reason:
          type: string
          nullable: true
          description: Why, when `available` is false.
        connected:
          type: boolean
        needs_reconnect:
          type: boolean
          description: A row exists but holds no usable credential. Reconnect in the app, or send the account holder a link from POST /v1/connect-links.
        account:
          type: string
          nullable: true
          description: Which account is connected, where the provider tells us.
        visibilities:
          type: array
          items:
            type: string
        visibility_notes:
          type: string
          nullable: true
        carousel:
          type: object
          nullable: true
          properties:
            min:
              type: integer
            max:
              type: integer
              nullable: true
              description: The vendor’s own cap. null means the vendor publishes no number — render that as "no documented limit", never as unlimited and never as an invented cap.
            effective_max:
              type: integer
            video:
              type: boolean
        carousel_unsupported_reason:
          type: string
          nullable: true
        caption_max:
          type: integer
          nullable: true
        target_field:
          type: string
          nullable: true
          description: The key inside `targets` that names WHICH account on this channel to post to.
    ChannelList:
      type: object
      properties:
        object:
          type: string
          enum:
          - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Channel'
    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