ClipUGC Credits API

Your account, balance, prices and credit packs.

GitHub OpenAPI

Operations 4

0 of 4 operations are conformant: apis.io called them with no credentials and the responses matched this contract; 4 more answered but could not be checked against a schema. Checked 2026-11-12. how this works · status file

GET /credits Get your balance and prices observed #
GET /user Get your account observed #
GET /credits/transactions List credit transactions observed #
GET /credits/packs List credit packs observed #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/clipugc-com:clipugc-com-credits-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

clipugc-com-credits-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: ClipUGC Credits API
  version: '2'
  description: 'Make UGC videos for your app from code. Create AI influencers who keep the same face,

    animate them into short clips, and turn a clip plus your app screen recording into the

    video you post. - **Base URL:** `https://clipugc.com/api/v2`

    - **Format:** JSON in and out. File fields also accept multipart. - **OpenAPI spec:** https://clipugc.com/docs/api.json. Import it into Postman or Insomnia, or generate

    a client from it. The URL stays the same between releases. - **Access:** the Professional and Business plans. See pricing. Prefer a terminal or an AI assistant? The same features ship as the

    `clipugc` CLI and as a connector for Claude and

    ChatGPT. ## Getting started


    **1. Create a key.** In the dashboard open API Keys and press

    *Create API Key*. Copy the key right away. It is shown once. **2. Make your first request.**


    ```bash

    curl https://clipugc.com/api/v2/user \

    -H "Authorization: Bearer $CLIPUGC_API_KEY" \

    -H "Accept: application/json"

    ```


    **3. Create a character.** Describe the person in plain words. ```bash

    curl -X POST https://clipugc.com/api/v2/ai-characters \

    -H "Authorization: Bearer $CLIPUGC_API_KEY" \

    -H "Content-Type: application/json" \

    -d ''{"description": "Maya, 26, a friendly barista from Lisbon with curly dark hair and freckles"}''

    ```


    The response holds the character and its first look in `data.reference_images`, with

    `status: "pending"`. This costs 2 credits. **4. Poll the look until it is ready.**


    ```bash

    curl https://clipugc.com/api/v2/character-images/LOOK_ID/check-status \

    -H "Authorization: Bearer $CLIPUGC_API_KEY"

    ```


    Repeat every 5 to 10 seconds until `data.status` is `completed` (or `failed`, which refunds

    the credits). The picture is in `data.media.image_url`. **5. Animate the look into a clip.**


    ```bash

    curl -X POST https://clipugc.com/api/v2/character-videos/image-to-video \

    -H "Authorization: Bearer $CLIPUGC_API_KEY" \

    -H "Content-Type: application/json" \

    -d ''{"character_reference_image_id": LOOK_ID, "prompt": "looks at the phone, surprised, then smiles", "duration": "5"}''

    ```


    Poll `GET /character-videos/CLIP_ID/check-status` the same way. A 5 second clip costs

    7 credits. **6. Upload your app screen recording.**


    ```bash

    curl -X POST https://clipugc.com/api/v2/uploads/presign \

    -H "Authorization: Bearer $CLIPUGC_API_KEY" \

    -H "Content-Type: application/json" \

    -d ''{"purpose": "app_video", "extension": "mp4"}''


    # then PUT the raw file to data.upload_url, adding any headers from data.headers

    curl --upload-file recording.mp4 "UPLOAD_URL"

    ```


    **7. Make the finished video.**


    ```bash

    curl -X POST https://clipugc.com/api/v2/character-videos/CLIP_ID/merge \

    -H "Authorization: Bearer $CLIPUGC_API_KEY" \

    -H "Content-Type: application/json" \

    -d ''{"app_video_key": "KEY_FROM_STEP_6", "hook_text": "this app saved me 3 hours this week"}''

    ```


    The response carries `data.merged_video_id`. Poll `GET /merged-videos/MERGED_VIDEO_ID` until

    `data.status` is `completed`, then call `GET /merged-videos/MERGED_VIDEO_ID/download` for a

    link to the MP4. ## Authentication


    Send your key as a bearer token on every request:


    ```

    Authorization: Bearer YOUR_API_KEY

    ```


    A key acts as your account and spends its credits, so keep it on your server and never ship

    it in an app. You can create several keys and revoke any of them on the

    API Keys page. Keys work while your account is on Professional or Business, including a trial. When the

    subscription ends, at the end of the paid period, the keys pause. They work again as soon as

    you subscribe again. ## Responses and errors


    Every response uses the same JSON envelope:


    ```json

    {

    "statusCode": 200,

    "errorMessage": null,

    "data": { },

    "message": "Success"

    }

    ```


    **Read `statusCode`, not only the HTTP status.** Most errors arrive with HTTP 200 and the real

    code in `statusCode`, with a readable `errorMessage`. The exceptions are listed in the HTTP

    column below. | statusCode | HTTP | Meaning |

    |---|---|---|

    | `200`, `201` | 200 | Success. `201` means something was created or started.'
servers:
- url: https://clipugc.com/api/v2
security:
- http: []
tags:
- name: Credits
  description: Your account, balance, prices and credit packs.
paths:
  /credits:
    get:
      operationId: v2.credits.index
      description: 'Your credit balance and what each generation costs right now. Prices are set by the server,

        so read them here rather than hard-coding them.'
      summary: Get your balance and prices
      tags:
      - Credits
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                examples:
                - statusCode: 200
                  errorMessage: null
                  data:
                    balance: 200
                    costs:
                      image: 2
                      clip: 7
                      clip_10s: 13
                      motion_per_second: 3
                      motion_wan_per_second: 2
                      scene_replace_per_second: 3
                      motion_max_seconds: 30
                      scene_staged: 9
                      merge: 0
                      story_scene: 13
                      story_scene_hd: 20
                  message: Credits retrieved successfully
                properties:
                  statusCode:
                    type: integer
                    const: 200
                  errorMessage:
                    type: 'null'
                  data:
                    type: object
                    properties:
                      balance:
                        type: integer
                      costs:
                        type: object
                        properties:
                          image:
                            type: integer
                            const: 2
                          clip:
                            type: integer
                            const: 7
                          clip_10s:
                            type: integer
                            const: 13
                          motion_per_second:
                            type: integer
                            const: 3
                          motion_wan_per_second:
                            type: integer
                            const: 2
                          scene_replace_per_second:
                            type: integer
                            const: 3
                          motion_max_seconds:
                            type: integer
                            const: 30
                          scene_staged:
                            type: integer
                            const: 9
                          merge:
                            type: integer
                          story_scene:
                            type: integer
                            const: 13
                          story_scene_hd:
                            type: integer
                            const: 20
                        required:
                        - image
                        - clip
                        - clip_10s
                        - motion_per_second
                        - motion_wan_per_second
                        - scene_replace_per_second
                        - motion_max_seconds
                        - scene_staged
                        - merge
                        - story_scene
                        - story_scene_hd
                    required:
                    - balance
                    - costs
                  message:
                    type: string
                    const: Credits retrieved successfully
                required:
                - statusCode
                - errorMessage
                - data
                - message
        '402':
          description: Your plan does not include API access (app code 1002).
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    const: 1002
                  errorMessage:
                    type: string
                    examples:
                    - API keys need the Professional or Business plan. Upgrade at https://clipugc.com/#pricing
                  data:
                    type: object
                    description: Details, such as pricing_url or retry_after.
                  message:
                    type: 'null'
                required:
                - statusCode
                - errorMessage
                - data
                - message
        '429':
          description: Rate limit for this API key. Wait `data.retry_after` seconds (also in the Retry-After header).
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    const: 429
                  errorMessage:
                    type: string
                    examples:
                    - 'Too many requests for this API key: 60 per minute. Retry after 42 seconds.'
                  data:
                    type: object
                    description: Details, such as pricing_url or retry_after.
                  message:
                    type: 'null'
                required:
                - statusCode
                - errorMessage
                - data
                - message
  /user:
    get:
      operationId: v2.user.index
      description: 'The account the API key belongs to and its plan. Your balance is `credits.general_credits`.

        The other `credits` fields count usage of the older product and can be ignored.'
      summary: Get your account
      tags:
      - Credits
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                examples:
                - statusCode: 200
                  errorMessage: null
                  data:
                    id: 19
                    name: Your Name
                    email: you@example.com
                    email_verified_at: null
                    created_at: '2026-09-30T19:27:25.000000Z'
                    subscription:
                      is_subscribed: true
                      is_trialing: false
                      active_subscription:
                        uuid: e5a2c21b-7315-41f3-96be-c3b7589b6c21
                        status: active
                        ends_at: '2027-09-30 19:27:25'
                      plan_name: Professional Monthly
                    credits:
                      general_credits: 200
                      video_credits_used: 0
                      video_credits_limit: 0
                      video_credits_remaining: 0
                      video_generation_cost: 1
                      ai_model_credits_used: 0
                      ai_model_credits_limit: 15
                      ai_model_credits_remaining: 15
                      ai_model_generation_cost: 5
                      has_enough_video_credits: true
                      has_enough_ai_model_credits: true
                    permissions:
                      can_generate_ai_influencer: true
                      visible_ai_influencer_count: -1
                      should_add_watermark: false
                  message: User info is retrieved successfully
                properties:
                  statusCode:
                    type: integer
                    const: 200
                  errorMessage:
                    type: 'null'
                  data:
                    $ref: '#/components/schemas/Account'
                  message:
                    type: string
                    const: User info is retrieved successfully
                required:
                - statusCode
                - errorMessage
                - data
                - message
        '402':
          description: Your plan does not include API access (app code 1002).
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    const: 1002
                  errorMessage:
                    type: string
                    examples:
                    - API keys need the Professional or Business plan. Upgrade at https://clipugc.com/#pricing
                  data:
                    type: object
                    description: Details, such as pricing_url or retry_after.
                  message:
                    type: 'null'
                required:
                - statusCode
                - errorMessage
                - data
                - message
        '429':
          description: Rate limit for this API key. Wait `data.retry_after` seconds (also in the Retry-After header).
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    const: 429
                  errorMessage:
                    type: string
                    examples:
                    - 'Too many requests for this API key: 60 per minute. Retry after 42 seconds.'
                  data:
                    type: object
                    description: Details, such as pricing_url or retry_after.
                  message:
                    type: 'null'
                required:
                - statusCode
                - errorMessage
                - data
                - message
  /credits/transactions:
    get:
      operationId: v2.credits.transactions
      description: Every credit added or spent, newest first. Paginated.
      summary: List credit transactions
      tags:
      - Credits
      parameters:
      - name: per_page
        in: query
        description: Rows per page, at most 50.
        schema:
          type: integer
          default: 12
      - name: page
        in: query
        description: Page number, starting at 1.
        schema:
          type: integer
          default: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                examples:
                - statusCode: 200
                  errorMessage: null
                  data:
                    transactions:
                    - id: 119
                      uuid: 0048583a-74e9-4d52-b96b-91c7be2a77b1
                      type: deduction
                      action: character_clip_generation
                      amount: -90
                      balance_after: 97
                      description: AI Character video clip generation (90 credits)
                      created_at: '2026-09-30T19:30:12+00:00'
                    - id: 118
                      uuid: 9185c66f-8def-4325-8e5e-d14c2cb0da23
                      type: deduction
                      action: character_clip_generation
                      amount: -7
                      balance_after: 187
                      description: AI Character video clip generation (7 credits)
                      created_at: '2026-09-30T19:29:52+00:00'
                    - id: 117
                      uuid: 273ca375-6cc6-45f1-b75e-af133bf308bc
                      type: deduction
                      action: character_image_generation
                      amount: -2
                      balance_after: 194
                      description: AI Character reference image generation
                      created_at: '2026-09-30T19:29:51+00:00'
                    pagination:
                      current_page: 1
                      last_page: 2
                      per_page: 3
                      total: 6
                      has_more_pages: true
                  message: Credit transactions retrieved successfully
                properties:
                  statusCode:
                    type: integer
                    const: 200
                  errorMessage:
                    type: 'null'
                  data:
                    type: object
                    properties:
                      transactions:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            uuid:
                              type: string
                            type:
                              type: string
                            action:
                              type: string
                            amount:
                              type: integer
                            balance_after:
                              type: integer
                            description:
                              type: string
                            created_at:
                              type:
                              - string
                              - 'null'
                          required:
                          - id
                          - uuid
                          - type
                          - action
                          - amount
                          - balance_after
                          - description
                          - created_at
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                          last_page:
                            type: integer
                          per_page:
                            type: integer
                          total:
                            type: integer
                          has_more_pages:
                            type: boolean
                        required:
                        - current_page
                        - last_page
                        - per_page
                        - total
                        - has_more_pages
                    required:
                    - transactions
                    - pagination
                  message:
                    type: string
                    const: Credit transactions retrieved successfully
                required:
                - statusCode
                - errorMessage
                - data
                - message
        '402':
          description: Your plan does not include API access (app code 1002).
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    const: 1002
                  errorMessage:
                    type: string
                    examples:
                    - API keys need the Professional or Business plan. Upgrade at https://clipugc.com/#pricing
                  data:
                    type: object
                    description: Details, such as pricing_url or retry_after.
                  message:
                    type: 'null'
                required:
                - statusCode
                - errorMessage
                - data
                - message
        '429':
          description: Rate limit for this API key. Wait `data.retry_after` seconds (also in the Retry-After header).
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    const: 429
                  errorMessage:
                    type: string
                    examples:
                    - 'Too many requests for this API key: 60 per minute. Retry after 42 seconds.'
                  data:
                    type: object
                    description: Details, such as pricing_url or retry_after.
                  message:
                    type: 'null'
                required:
                - statusCode
                - errorMessage
                - data
                - message
  /credits/packs:
    get:
      operationId: v2.credits.packs
      description: One-time credit packs you can buy. `checkout_url` opens the web checkout.
      summary: List credit packs
      tags:
      - Credits
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                examples:
                - statusCode: 200
                  errorMessage: null
                  data:
                    packs:
                    - slug: starter-pack
                      name: Starter Pack
                      credits: 50
                      revenuecat_product_id: credits_pack_50
                      checkout_url: https://clipugc.com/buy/product/starter-pack
                      prices:
                      - amount: 999
                        currency: USD
                    - slug: creator-pack
                      name: Creator Pack
                      credits: 150
                      revenuecat_product_id: credits_pack_150
                      checkout_url: https://clipugc.com/buy/product/creator-pack
                      prices:
                      - amount: 2499
                        currency: USD
                    - slug: studio-pack
                      name: Studio Pack
                      credits: 400
                      revenuecat_product_id: credits_pack_400
                      checkout_url: https://clipugc.com/buy/product/studio-pack
                      prices:
                      - amount: 5999
                        currency: USD
                  message: Credit packs retrieved successfully
                properties:
                  statusCode:
                    type: integer
                    const: 200
                  errorMessage:
                    type: 'null'
                  data:
                    type: object
                    properties:
                      packs:
                        type: array
                        items:
                          type: object
                          properties:
                            slug:
                              type: string
                            name:
                              type: string
                            credits:
                              type: integer
                            revenuecat_product_id:
                              type:
                              - string
                              - 'null'
                            checkout_url:
                              type: string
                            prices:
                              type: array
                              items:
                                type: object
                                properties:
                                  amount:
                                    type: integer
                                  currency:
                                    type: string
                                required:
                                - amount
                                - currency
                          required:
                          - slug
                          - name
                          - credits
                          - revenuecat_product_id
                          - checkout_url
                          - prices
                    required:
                    - packs
                  message:
                    type: string
                    const: Credit packs retrieved successfully
                required:
                - statusCode
                - errorMessage
                - data
                - message
        '402':
          description: Your plan does not include API access (app code 1002).
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    const: 1002
                  errorMessage:
                    type: string
                    examples:
                    - API keys need the Professional or Business plan. Upgrade at https://clipugc.com/#pricing
                  data:
                    type: object
                    description: Details, such as pricing_url or retry_after.
                  message:
                    type: 'null'
                required:
                - statusCode
                - errorMessage
                - data
                - message
        '429':
          description: Rate limit for this API key. Wait `data.retry_after` seconds (also in the Retry-After header).
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    const: 429
                  errorMessage:
                    type: string
                    examples:
                    - 'Too many requests for this API key: 60 per minute. Retry after 42 seconds.'
                  data:
                    type: object
                    description: Details, such as pricing_url or retry_after.
                  message:
                    type: 'null'
                required:
                - statusCode
                - errorMessage
                - data
                - message
components:
  schemas:
    Account:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        email:
          type: string
        email_verified_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type:
          - string
          - 'null'
          format: date-time
        subscription:
          type: object
          properties:
            is_subscribed:
              type: boolean
            is_trialing:
              type: boolean
            active_subscription:
              type:
              - object
              - 'null'
              properties:
                uuid:
                  type: string
                status:
                  type: string
                ends_at:
                  type: string
              required:
              - uuid
              - status
              - ends_at
            plan_name:
              type:
              - string
              - 'null'
              description: Your current plan.
          required:
          - is_subscribed
          - is_trialing
          - active_subscription
          - plan_name
        credits:
          type: object
          properties:
            general_credits:
              type: integer
              description: Your credit balance.
            video_credits_used:
              type: integer
            video_credits_limit:
              type: integer
            video_credits_remaining:
              type: integer
            video_generation_cost:
              type: integer
              const: 1
            ai_model_credits_used:
              type: integer
            ai_model_credits_limit:
              type: integer
            ai_model_credits_remaining:
              type: integer
            ai_model_generation_cost:
              type: integer
              const: 5
            has_enough_video_credits:
              type: boolean
            has_enough_ai_model_credits:
              type: boolean
          required:
          - general_credits
          - video_credits_used
          - video_credits_limit
          - video_credits_remaining
          - video_generation_cost
          - ai_model_credits_used
          - ai_model_credits_limit
          - ai_model_credits_remaining
          - ai_model_generation_cost
          - has_enough_video_credits
          - has_enough_ai_model_credits
        permissions:
          type: object
          properties:
            can_generate_ai_influencer:
              type: boolean
            visible_ai_influencer_count:
              type: integer
            should_add_watermark:
              type: boolean
          required:
          - can_generate_ai_influencer
          - visible_ai_influencer_count
          - should_add_watermark
      required:
      - id
      - name
      - email
      - email_verified_at
      - created_at
      - subscription
      - credits
      - permissions
      title: Account
  securitySchemes:
    http:
      type: http
      description: Your API key from Dashboard, API Keys. Needs the Professional or Business plan.
      scheme: bearer