Compelling Credits API

AI usage credits consumed by research and generation operations.

GitHub OpenAPI

Operations 2

GET /workspaces/{workspace_id}/credits Get credit balance #
GET /workspaces/{workspace_id}/credits/transactions List credit transactions #

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/compelling-ai:compelling-ai-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

compelling-ai-credits-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Compelling Ai Credits API
  version: 1.0.0
  contact:
    name: Compelling
    url: https://compelling.ai
  description: 'Operations tagged Credits across 2 of this provider''s published API definitions: compelling-ai-openapi.yaml, compelling-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.compelling.ai/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Credits
  description: AI usage credits consumed by research and generation operations.
paths:
  /workspaces/{workspace_id}/credits:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    get:
      tags:
      - Credits
      summary: Get credit balance
      description: Returns the current credit balance and a usage summary for the billing period.
      operationId: getCredits
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditBalance'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/credits/transactions:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    get:
      tags:
      - Credits
      summary: List credit transactions
      description: Paginated history of credit consumption events.
      operationId: getCreditTransactions
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/size'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCreditTransactions'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
components:
  schemas:
    Pagination:
      type: object
      properties:
        page:
          type: integer
          example: 1
        size:
          type: integer
          example: 25
        total:
          type: integer
          example: 342
        total_pages:
          type: integer
          example: 14
    CreditTransaction:
      type: object
      properties:
        id:
          type: string
        amount:
          type: integer
          description: Credits consumed (negative) or added (positive).
          example: -5
        operation:
          type: string
          example: account_insight_answer
        list_id:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
    CreditBalance:
      type: object
      properties:
        balance:
          type: integer
          description: Remaining credits.
          example: 4200
        used_this_period:
          type: integer
          example: 800
        total_this_period:
          type: integer
          example: 5000
        resets_at:
          type: string
          format: date-time
    PaginatedCreditTransactions:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CreditTransaction'
        pagination:
          $ref: '#/components/schemas/Pagination'
  parameters:
    size:
      name: size
      in: query
      schema:
        type: integer
        default: 25
        maximum: 100
    page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
    workspace_id:
      name: workspace_id
      in: path
      required: true
      schema:
        type: string
      example: ws_01HX
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API key issued from your workspace settings. Pass as `Authorization: Bearer <token>`.'
x-refined-from:
- compelling-ai-openapi.yaml
- compelling-ai-openapi.yml