Heista Account API

openapi: 3.2.0
info:
  title: Heista Account API
  version: 1.0.0
  description: 'Creative intelligence as an API. Decode any video ad, extract brand intelligence from any URL or document, generate scripts in any brand''s voice, and browse the decoded corpus for free.


    ## Surfaces

    - **Decode** — turn any video ad URL into a structural formula. Beats, hooks, psychology, visual playbook.

    - **PowerSource** — 14-section brand intelligence from a URL, internal documents, or both.

    - **Adscript** — generate 1–5 ad scripts from a proven structure + a PowerSource. Token-metered.

    - **Files** — upload PDF/DOCX/TXT/MD for use in PowerSource docs mode.

    - **Intelligence reads** — free corpus access (hook patterns, ad formulas, decoded ads).

    - **Account** — credit balance, monthly usage, pricing.


    ## Pricing

    - Decode: **$0.15** (≤60s) / **$0.20** (61–120s)

    - PowerSource: **$1.00** (URL or docs only) / **$2.00** (URL + docs)

    - Adscript: **token-metered**, typically **$0.02–$0.05** per script

    - Intelligence reads, Files API: **free**

    - Failed jobs auto-refund. Duplicate inputs (same org) return cached results at no charge.


    ## Authentication

    Bearer header on every request:

    ```

    Authorization: Bearer hst_live_your_key

    ```

    Production keys are prefixed `hst_live_`; test keys are `hst_test_`. Get yours at heista.co/api-console.


    ## Errors

    All errors follow RFC 9457 Problem Details. The same envelope shape across every endpoint; see the `ProblemDetails` schema.


    Spending-cap and circuit-breaker errors include a `reason` field (`cap_hourly`, `cap_daily`, `cap_monthly`, `cap_key_daily`, `cap_key_monthly`, `circuit_open`). Insufficient-credits errors include `top_up_url`, `current_balance`, and `required` extensions.


    ## Rate limits

    Per API key, per endpoint group. Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` (epoch ms). On 429 you also get `Retry-After` (seconds).'
  contact:
    name: Heista Support
    email: support@heista.co
    url: https://heista.co
  termsOfService: https://heista.co/terms
  license:
    name: Proprietary
    url: https://heista.co/terms
servers:
- url: https://www.heista.co/api/v1
  description: Production
- url: http://localhost:3000/api/v1
  description: Local development
security:
- bearerAuth: []
tags:
- name: Account
  description: Credit balance, monthly usage, pricing.
paths:
  /account/balance:
    get:
      tags:
      - Account
      summary: Account credit balance and monthly usage
      operationId: getAccountBalance
      responses:
        '200':
          description: Balance + monthly usage + pricing reference
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountBalance'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    RateLimited:
      description: Rate limit exceeded. Includes `Retry-After` (seconds).
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
  schemas:
    ProblemDetails:
      type: object
      description: RFC 9457 Problem Details envelope used for every error.
      required:
      - type
      - title
      - status
      properties:
        type:
          type: string
          format: uri
          example: https://api.heista.co/errors/validation-error
        title:
          type: string
          example: Validation error
        status:
          type: integer
          example: 400
        detail:
          type: string
        instance:
          type: string
          format: uri
        request_id:
          type: string
          example: req_a1b2c3d4
    AccountBalance:
      type: object
      properties:
        balance_cents:
          type: integer
        total_topped_up_cents:
          type: integer
        total_spent_cents:
          type: integer
        month:
          type: object
          properties:
            start:
              type: string
              format: date-time
            spend_cents:
              type: integer
            counts:
              type: object
              properties:
                decode:
                  type: integer
                powersource:
                  type: integer
                powersource_docs:
                  type: integer
                powersource_full:
                  type: integer
                adscript:
                  type: integer
                other:
                  type: integer
        pricing:
          type: object
          properties:
            decode_short_cents:
              type: integer
              example: 15
            decode_long_cents:
              type: integer
              example: 20
            powersource_url_cents:
              type: integer
              example: 100
            powersource_docs_cents:
              type: integer
              example: 100
            powersource_full_cents:
              type: integer
              example: 200
            adscript_per_script_min_cents:
              type: integer
              example: 2
            adscript_per_script_typical_max_cents:
              type: integer
              example: 5
            intelligence_reads:
              type: integer
              example: 0
            files:
              type: integer
              example: 0
        top_up_url:
          type: string
          format: uri
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: hst_live_xxx (production) or hst_test_xxx (test)
      description: API key issued at heista.co/api-console.