Atlas

Atlas Usage API

The Usage API from Atlas — 2 operation(s) for usage.

GitHub OpenAPI

Operations 2

GET /v1/workspaces/{workspaceId}/usage Get usage #
GET /v1/workspaces/{workspaceId}/usage/ledger List usage ledger #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/atlas-compiler-com/openapi/atlas-compiler-com-usage-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/atlas-compiler-com/json-schema/atlas-compiler-com-execution-result-artifact-schema.json
📊
JSONSchema
https://artifacts.apis.io/atlas-compiler-com/json-schema/atlas-compiler-com-health-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/atlas-compiler-com/json-schema/atlas-compiler-com-json-value-schema.json
📊
JSONSchema
https://artifacts.apis.io/atlas-compiler-com/json-schema/atlas-compiler-com-plan-catalog-schema.json

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/atlas-compiler-com:atlas-compiler-com-usage-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

atlas-compiler-com-usage-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Customer API for Atlas Compiler. Public health is included; operator readiness and provider ingress are excluded.
  title: Atlas Backend Usage API
  version: 0.1.0
servers:
- url: https://api.atlas-compiler.com
tags:
- name: Usage
paths:
  /v1/workspaces/{workspaceId}/usage:
    get:
      operationId: getUsage
      parameters:
      - in: path
        name: workspaceId
        required: true
        schema:
          maxLength: 64
          minLength: 5
          pattern: ^[a-z]+_[0-9A-Z]+$
          type: string
      - in: query
        name: periodStart
        required: false
        schema:
          format: date-time
          type: string
      - in: query
        name: projectId
        required: false
        schema:
          maxLength: 64
          minLength: 5
          pattern: ^[a-z]+_[0-9A-Z]+$
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  accounts:
                    items:
                      additionalProperties: false
                      properties:
                        allowance:
                          minimum: 0
                          type: integer
                        blockReason:
                          maxLength: 100
                          type:
                          - string
                          - 'null'
                        blockedAt:
                          format: date-time
                          type:
                          - string
                          - 'null'
                        consumed:
                          minimum: 0
                          type: integer
                        metric:
                          enum:
                          - credits
                          type: string
                        periodEnd:
                          format: date-time
                          type: string
                        periodStart:
                          format: date-time
                          type: string
                        reserved:
                          minimum: 0
                          type: integer
                        updatedAt:
                          format: date-time
                          type: string
                      required:
                      - metric
                      - periodStart
                      - periodEnd
                      - allowance
                      - reserved
                      - consumed
                      - blockedAt
                      - blockReason
                      - updatedAt
                      type: object
                    maxItems: 2
                    type: array
                  grants:
                    items:
                      additionalProperties: false
                      properties:
                        consumed:
                          minimum: 0
                          type: integer
                        expiresAt:
                          format: date-time
                          type:
                          - string
                          - 'null'
                        id:
                          maxLength: 128
                          minLength: 1
                          type: string
                        metric:
                          enum:
                          - credits
                          type: string
                        source:
                          maxLength: 100
                          type: string
                        units:
                          exclusiveMinimum: 0
                          type: integer
                      required:
                      - metric
                      - units
                      - consumed
                      - expiresAt
                      type: object
                    maxItems: 100
                    type: array
                  plan:
                    additionalProperties: false
                    properties:
                      code:
                        maxLength: 100
                        minLength: 1
                        type: string
                      version:
                        exclusiveMinimum: 0
                        type: integer
                    required:
                    - code
                    - version
                    type: object
                required:
                - plan
                - accounts
                - grants
                type: object
          description: Quota account snapshots.
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: RFC 9457 problem.
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: RFC 9457 problem.
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: RFC 9457 problem.
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: RFC 9457 problem.
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: RFC 9457 problem.
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: RFC 9457 problem.
      security:
      - clerkBearer: []
      - atlasApiKey: []
      tags:
      - Usage
      summary: Get usage
      x-summary-source: derived
  /v1/workspaces/{workspaceId}/usage/ledger:
    get:
      operationId: listUsageLedger
      parameters:
      - in: path
        name: workspaceId
        required: true
        schema:
          maxLength: 64
          minLength: 5
          pattern: ^[a-z]+_[0-9A-Z]+$
          type: string
      - in: query
        name: limit
        required: false
        schema:
          default: 50
          maximum: 100
          minimum: 1
          type: integer
      - in: query
        name: cursor
        required: false
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - in: query
        name: metric
        required: false
        schema:
          enum:
          - credits
          type: string
      - in: query
        name: projectId
        required: false
        schema:
          maxLength: 64
          minLength: 5
          pattern: ^[a-z]+_[0-9A-Z]+$
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      additionalProperties: false
                      properties:
                        consumedDelta:
                          type: integer
                        createdAt:
                          format: date-time
                          type: string
                        entryType:
                          enum:
                          - reserve
                          - settle
                          - release
                          - adjustment
                          - credit
                          type: string
                        eventKey:
                          maxLength: 255
                          minLength: 1
                          type: string
                        id:
                          maxLength: 64
                          minLength: 5
                          pattern: ^[a-z]+_[0-9A-Z]+$
                          type: string
                        metadata:
                          additionalProperties:
                            $ref: '#/components/schemas/JsonValue'
                          description: Intentionally open JSON metadata emitted by the usage ledger.
                          type:
                          - object
                          - 'null'
                        metric:
                          enum:
                          - credits
                          type: string
                        periodStart:
                          format: date-time
                          type: string
                        reservationId:
                          maxLength: 64
                          minLength: 5
                          pattern: ^[a-z]+_[0-9A-Z]+$
                          type:
                          - string
                          - 'null'
                        reservedDelta:
                          type: integer
                        source:
                          maxLength: 100
                          minLength: 1
                          type: string
                      required:
                      - id
                      - metric
                      - periodStart
                      - reservationId
                      - eventKey
                      - entryType
                      - reservedDelta
                      - consumedDelta
                      - source
                      - metadata
                      - createdAt
                      type: object
                    maxItems: 100
                    type: array
                  nextCursor:
                    maxLength: 1024
                    type:
                    - string
                    - 'null'
                required:
                - data
                - nextCursor
                type: object
          description: Immutable usage ledger.
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: RFC 9457 problem.
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: RFC 9457 problem.
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: RFC 9457 problem.
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: RFC 9457 problem.
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: RFC 9457 problem.
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: RFC 9457 problem.
      security:
      - clerkBearer: []
      - atlasApiKey: []
      tags:
      - Usage
      summary: List usage ledger
      x-summary-source: derived
components:
  schemas:
    Problem:
      additionalProperties: false
      properties:
        code:
          type: string
        detail:
          type: string
        documentationUrl:
          format: uri
          type: string
        instance:
          type: string
        invalidParams:
          items:
            additionalProperties: false
            properties:
              name:
                type: string
              reason:
                type: string
            required:
            - name
            - reason
            type: object
          type: array
        requestId:
          type: string
        resourceId:
          type: string
        retryable:
          type: boolean
        status:
          maximum: 599
          minimum: 400
          type: integer
        title:
          type: string
        type:
          format: uri
          type: string
      required:
      - type
      - title
      - status
      - detail
      - instance
      - requestId
      - code
      - retryable
      type: object
    JsonValue:
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      items:
        $ref: '#/components/schemas/JsonValue'
      type:
      - 'null'
      - boolean
      - number
      - string
      - array
      - object
  securitySchemes:
    atlasApiKey:
      description: Bearer Atlas API key (starts with atlas_).
      scheme: bearer
      type: http
    clerkBearer:
      bearerFormat: JWT
      description: A short-lived Clerk session JWT supplied by the Dashboard BFF.
      scheme: bearer
      type: http