Orb

Orb Availability API

The Availability API from Orb — 1 operation(s) for availability.

Documentation GitHub OpenAPI

Operations 1

GET /ping Check availability #

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/orb-billing:orb-billing-availability-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Reference Availability API
  description: 'Orb''s API is built with the following principles in mind:


    1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as

    cursor-based pagination and standardized error output. To help with debugging in critical API

    actions, the API always strives to provide detailed and actionable error messages. Aliases

    such as external customer IDs aid in fast integration times.

    2. **Reliably real time**: Orb''s event-based APIs, such as event ingestion are designed to handle extremely high

    throughput and scale with concurrent load. Orb also provides a real-time event-level credits

    ledger and a highly performant webhooks architecture.

    3. **Flexibility at the forefront**: Features like timezone localization and the ability to amend historical usage

    show the flexible nature of the platform.


    You can download the latest OpenAPI spec here - pass `?version=3.0` for an

    OpenAPI 3.0-compatible spec.'
  contact:
    name: Orb, Inc.
    url: https://www.withorb.com/
    email: team@withorb.com
  version: '1.0'
servers:
- url: https://api.withorb.com/v1
  description: Production server
security:
- APIKeyAuth: []
tags:
- name: Availability
paths:
  /ping:
    get:
      tags:
      - Availability
      summary: Check availability
      description: 'This endpoint allows you to test your connection to the Orb API and check the validity of your API key, passed in

        the Authorization header. This is particularly useful for checking that your environment is set up properly, and is

        a great choice for connectors and integrations.


        This API does not have any side-effects or return any Orb resources.'
      operationId: ping
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PingResponse'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400Error'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404Error'
        '409':
          description: Conflict
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/409Error'
        '413':
          description: Content Too Large
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/413Error'
        '429':
          description: Too Many Requests
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/429Error'
        '500':
          description: Internal Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500Error'
components:
  schemas:
    PingResponse:
      properties:
        response:
          type: string
          title: Response
      type: object
      required:
      - response
      title: PingResponse
    RequestTooLargeError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#413-request-too-large
          title: Type
        status:
          type: integer
          enum:
          - 413
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: RequestTooLargeError
    401Error:
      $ref: '#/components/schemas/AuthorizationError'
      title: 401Error
    AuthorizationError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#401-authentication-error
          title: Type
        status:
          type: integer
          enum:
          - 401
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: AuthorizationError
    429Error:
      $ref: '#/components/schemas/TooManyRequests'
      title: 429Error
    FeatureNotAvailableError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#404-feature-not-available
          title: Type
        status:
          type: integer
          enum:
          - 400
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: FeatureNotAvailableError
    413Error:
      oneOf:
      - $ref: '#/components/schemas/RequestTooLargeError'
      - $ref: '#/components/schemas/ResourceTooLargeError'
      - $ref: '#/components/schemas/TooManyResultsError'
    IdempotencyRequestMismatch:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#409-resource-conflict
          title: Type
        status:
          type: integer
          enum:
          - 409
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: IdempotencyRequestMismatch
    TooManyRequests:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#429-too-many-requests
          title: Type
        status:
          type: integer
          enum:
          - 429
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: TooManyRequests
    ResourceTooLargeError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#413-resource-too-large
          title: Type
        status:
          type: integer
          enum:
          - 413
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: ResourceTooLargeError
    409Error:
      $ref: '#/components/schemas/IdempotencyRequestMismatch'
      title: 409Error
    TooManyResultsError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#413-too-many-results
          title: Type
        status:
          type: integer
          enum:
          - 413
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: TooManyResultsError
    ServerError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#500-internal-server-error
          title: Type
        status:
          type: integer
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: ServerError
    ResourceNotFoundError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#404-resource-not-found
          title: Type
        status:
          type: integer
          enum:
          - 404
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          type: string
          title: Title
      type: object
      required:
      - type
      - status
      - title
      title: ResourceNotFoundError
    404Error:
      oneOf:
      - $ref: '#/components/schemas/FeatureNotAvailableError'
      - $ref: '#/components/schemas/ResourceNotFoundError'
      - $ref: '#/components/schemas/URLNotFound'
    URLNotFound:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#404-url-not-found
          title: Type
        status:
          type: integer
          enum:
          - 404
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: URLNotFound
    DuplicateResourceCreationError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation
          title: Type
        status:
          type: integer
          enum:
          - 400
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: DuplicateResourceCreationError
    RequestValidationError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#400-request-validation-errors
          title: Type
        status:
          type: integer
          enum:
          - 400
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
        validation_errors:
          items: {}
          type: array
          title: Validation Errors
      type: object
      required:
      - type
      - status
      - validation_errors
      title: RequestValidationError
    400Error:
      oneOf:
      - $ref: '#/components/schemas/ConstraintViolationError'
      - $ref: '#/components/schemas/DuplicateResourceCreationError'
      - $ref: '#/components/schemas/RequestValidationError'
    500Error:
      $ref: '#/components/schemas/ServerError'
      title: 500Error
    ConstraintViolationError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#400-constraint-violation
          title: Type
        status:
          type: integer
          enum:
          - 400
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: ConstraintViolationError
  securitySchemes:
    APIKeyAuth:
      type: http
      description: API Keys can be issued in the Orb's web application.
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Orb
  source: https://docs.withorb.com/api-reference/orb-openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)