OpenPost System API

The System API from OpenPost — 5 operation(s) for system.

GitHub OpenAPI

Operations 5

GET /github-stars Get the OpenPost GitHub star count #
GET /health Health check #
GET /ready Readiness check #
GET /telemetry/config Get browser telemetry configuration #
GET /version Running version #

Specifications

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/openpo-st:openpo-st-system-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

openpo-st-system-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  contact:
    email: hello@openpo.st
    name: OpenPost support
    url: https://openpo.st/contact
  description: OpenPost HTTP API for workspace-scoped social publishing. Use it to inspect accounts and provider readiness, manage media and publications, schedule work, and read publishing results. Every operation still follows token scopes, workspace roles, plan limits, provider capabilities, and destination validation.
  license:
    identifier: AGPL-3.0-only
    name: AGPL-3.0-only
  termsOfService: https://openpo.st/terms
  title: OpenPost System API
  version: 1.0.0
servers:
- description: OpenPost Hosted service
  url: https://app.openpo.st/api/v1
- description: The OpenPost instance serving this contract
  url: /api/v1
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: System
paths:
  /github-stars:
    get:
      description: Returns a cached public count for the OpenPost GitHub repository when GitHub is available.
      operationId: get-github-star-count
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitHubStarsResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security: []
      summary: Get the OpenPost GitHub star count
      tags:
      - System
  /health:
    get:
      operationId: health-check
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health-checkResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security: []
      summary: Health check
      tags:
      - System
  /ready:
    get:
      operationId: readiness-check
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Readiness-checkResponse'
          description: OK
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Service Unavailable
      security: []
      summary: Readiness check
      tags:
      - System
  /telemetry/config:
    get:
      description: Returns only the browser-safe project token and ingestion hosts. Self-hosted telemetry is disabled unless the operator enables it.
      operationId: get-telemetry-config
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrowserConfig'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security: []
      summary: Get browser telemetry configuration
      tags:
      - System
  /version:
    get:
      description: Returns the public release and source revision currently serving requests.
      operationId: get-running-version
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Get-running-versionResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security: []
      summary: Running version
      tags:
      - System
components:
  schemas:
    ErrorModel:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/ErrorModel.json
          format: uri
          readOnly: true
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          examples:
          - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
          - array
          - 'null'
        instance:
          description: A URI reference that identifies the specific occurrence of the problem.
          examples:
          - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
          - 400
          format: int64
          type: integer
        title:
          description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
          examples:
          - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
          - https://example.com/errors/example
          format: uri
          type: string
      type: object
    Health-checkResponse:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/Health-checkResponse.json
          format: uri
          readOnly: true
          type: string
        status:
          description: Health status
          type: string
      required:
      - status
      type: object
    Readiness-checkResponse:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/Readiness-checkResponse.json
          format: uri
          readOnly: true
          type: string
        database:
          description: Database dependency status
          type: string
        status:
          description: Readiness status
          type: string
        storage:
          description: Required object storage dependency status
          type: string
      required:
      - status
      - database
      type: object
    BrowserConfig:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/BrowserConfig.json
          format: uri
          readOnly: true
          type: string
        api_host:
          description: PostHog browser ingestion endpoint or proxy
          type: string
        edition:
          description: Configured OpenPost edition
          type: string
        enabled:
          description: Whether browser telemetry is enabled for this OpenPost instance
          type: boolean
        environment:
          description: Deployment environment attached to telemetry
          type: string
        project_token:
          description: Browser-safe PostHog project token
          type: string
        revision:
          description: Running OpenPost source revision
          type: string
        ui_host:
          description: PostHog user interface host used for generated links
          type: string
        version:
          description: Running OpenPost version
          type: string
      required:
      - enabled
      - environment
      - edition
      - version
      - revision
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Get-running-versionResponse:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/Get-running-versionResponse.json
          format: uri
          readOnly: true
          type: string
        edition:
          description: Configured OpenPost edition
          type: string
        revision:
          description: Full source revision embedded in the server
          type: string
        version:
          description: Release version embedded in the server
          type: string
      required:
      - version
      - revision
      - edition
      type: object
    GitHubStarsResponse:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/GitHubStarsResponse.json
          format: uri
          readOnly: true
          type: string
        count:
          description: Current public repository star count
          format: int64
          type: integer
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: OpenPost API token or session JWT
      scheme: bearer
      type: http
    sessionCookie:
      in: cookie
      name: openpost_session
      type: apiKey