Heista Power Source API

openapi: 3.2.0
info:
  title: Heista Power Source 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: PowerSource
  description: Extract 14-section brand intelligence from a URL, internal documents, or both.
paths:
  /powersource:
    post:
      tags:
      - PowerSource
      summary: Submit a PowerSource brand intelligence job
      description: 'Three modes auto-detected from body shape:

        - **URL only** → $1.00, ~75s

        - **Documents only** (file_ids / document_urls / documents_inline) → $1.00, ~90s

        - **URL + documents** → $2.00, ~130s


        `context_url` is mutually exclusive with `url`: pass `url` to use the page as a primary source (URL or full mode), or `context_url` for supplementary live brand context when the documents are primary.


        Optional `webhook_url` receives a signed POST when the job completes or fails — eliminates polling. See `webhooks.powersource_complete` below.'
      operationId: submitPowerSource
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PowerSourceSubmitRequest'
      responses:
        '202':
          description: Job accepted (queued)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerSourceJobQueued'
        '200':
          description: Deduplicated, in-flight, or idempotent existing job
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/PowerSourceJobCompletedRef'
                - $ref: '#/components/schemas/PowerSourceJobInflightRef'
                - $ref: '#/components/schemas/PowerSourceJobIdempotentRef'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/InsufficientCredits'
        '403':
          $ref: '#/components/responses/CircuitBreaker'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /powersource/{id}:
    get:
      tags:
      - PowerSource
      summary: Poll PowerSource job / retrieve completed brand intelligence
      operationId: getPowerSource
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Job status or completed PowerSource
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/PowerSourceJobQueued'
                - $ref: '#/components/schemas/PowerSourceJobProcessing'
                - $ref: '#/components/schemas/PowerSourceJobCompleted'
                - $ref: '#/components/schemas/PowerSourceJobFailed'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    ValidationError:
      description: Request validation failed
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    NotFound:
      description: Resource not found or not owned by this org
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    CircuitBreaker:
      description: 'Account paused (anomaly detection) — `reason: circuit_open`. Review at the API console.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/SpendingCapProblem'
    InsufficientCredits:
      description: Balance too low. Includes `current_balance`, `required`, and `top_up_url`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/InsufficientCreditsProblem'
    InternalError:
      description: Internal error
      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'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
  schemas:
    PowerSourceJobInflightRef:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
        deduplicated:
          type: boolean
          enum:
          - true
        price:
          type: number
          nullable: true
        created_at:
          type: string
          format: date-time
        poll_url:
          type: string
    PowerSourceJobCompleted:
      type: object
      properties:
        id:
          type: string
          format: uuid
        brief_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
          - completed
        price:
          type: number
          description: USD price charged.
        created_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
        powersource:
          $ref: '#/components/schemas/PowerSource'
    PowerSourceSubmitRequest:
      type: object
      properties:
        url:
          type: string
          description: Primary URL. Required for URL-only or full mode.
        context_url:
          type: string
          description: Supplementary URL — only for docs mode. Mutually exclusive with `url`.
        file_ids:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 10
          description: File IDs from /v1/files.
        document_urls:
          type: array
          items:
            type: string
            format: uri
          maxItems: 10
        documents_inline:
          type: array
          maxItems: 10
          items:
            type: object
            required:
            - filename
            - content_base64
            properties:
              filename:
                type: string
              content_base64:
                type: string
                description: Max 5MB per file.
        force_refresh:
          type: boolean
          description: Bypass the 30-day brand cache. Rate-limited to once per 24h per domain.
        webhook_url:
          type: string
          format: uri
          description: HTTPS URL to receive completion notification. See `webhooks.powersource_complete`.
        idempotency_key:
          type: string
          maxLength: 128
    PowerSourceJobFailed:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
          - failed
        error_code:
          type: string
        error_message:
          type: string
    PowerSourceJobQueued:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
          - queued
        estimated_seconds:
          type: integer
        created_at:
          type: string
          format: date-time
        poll_url:
          type: string
        warnings:
          type: array
          items:
            type: string
    SpendingCapProblem:
      allOf:
      - $ref: '#/components/schemas/ProblemDetails'
      - type: object
        properties:
          reason:
            type: string
            enum:
            - cap_hourly
            - cap_daily
            - cap_monthly
            - cap_key_daily
            - cap_key_monthly
            - circuit_open
          top_up_url:
            type: string
            format: uri
    PowerSourceJobIdempotentRef:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
        idempotent:
          type: boolean
          enum:
          - true
        price:
          type: number
          nullable: true
        created_at:
          type: string
          format: date-time
        poll_url:
          type: string
    InsufficientCreditsProblem:
      allOf:
      - $ref: '#/components/schemas/ProblemDetails'
      - type: object
        properties:
          current_balance:
            type: integer
            description: Current balance in cents
          required:
            type: integer
            description: Cents required for this operation
          top_up_url:
            type: string
            format: uri
            example: https://heista.co/api-console/billing
          resource:
            type: string
            example: decode
    PowerSourceJobProcessing:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
          - processing
        estimated_seconds:
          type: integer
        created_at:
          type: string
          format: date-time
        progress:
          type: object
          description: Phase/scan progress with partial intelligence as agents complete.
          additionalProperties: true
    PowerSource:
      type: object
      description: '14-section brand intelligence response. Each section carries a `_scope` tag: `product`, `brand`, `synthesized`, or `mixed`.

        '
      additionalProperties: true
      properties:
        identity:
          type: object
        offer:
          type: object
        selling_points:
          type: array
          items:
            type: object
        brand_story:
          type: object
        brand_style:
          type: object
        brand_assets:
          type: object
        brand_voice:
          type: string
          nullable: true
        buyer_profile:
          type: object
          nullable: true
        tensions:
          type: array
          items:
            type: object
        angles:
          type: object
        emotional_arcs:
          type: object
          nullable: true
        ctas:
          type: object
        proof_assets:
          type: object
        narrative:
          type: object
          nullable: true
    PowerSourceJobCompletedRef:
      type: object
      properties:
        id:
          type: string
          format: uuid
        brief_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
          - completed
        deduplicated:
          type: boolean
          enum:
          - true
        price:
          type: number
          example: 0
        created_at:
          type: string
          format: date-time
        poll_url:
          type: string
    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
  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.