OpenPost Capabilities API

The Capabilities API from OpenPost — 3 operation(s) for capabilities.

GitHub OpenAPI

Operations 3

GET /capabilities List provider publishing capabilities #
POST /capabilities/resolve Resolve publishing capabilities for connected accounts #
POST /engagement-and-messaging/refresh Queue engagement and message collection #

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-capabilities-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-capabilities-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 Capabilities 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: Capabilities
paths:
  /capabilities:
    get:
      operationId: list-capabilities
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapabilitiesOutputBody'
          description: OK
          headers:
            Cache-Control:
              schema:
                type: string
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security: []
      summary: List provider publishing capabilities
      tags:
      - Capabilities
  /capabilities/resolve:
    post:
      operationId: resolve-publishing-capabilities
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResolveCapabilitiesInputBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResolveCapabilitiesOutputBody'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Found
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
        '502':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Gateway
      summary: Resolve publishing capabilities for connected accounts
      tags:
      - Capabilities
      x-openpost-automation:
        access: read
        effect: query
        exposure: disabled
        idempotency: none
        retry: transient
  /engagement-and-messaging/refresh:
    post:
      operationId: refresh-engagement-and-messaging
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefreshCapabilitiesInputBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefreshCapabilitiesResult'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      summary: Queue engagement and message collection
      tags:
      - Capabilities
components:
  schemas:
    ResolvedAccountCapability:
      additionalProperties: false
      properties:
        account_id:
          type: string
        active_constraints:
          additionalProperties: {}
          type: object
        available_formats:
          items:
            $ref: '#/components/schemas/DestinationFormat'
          type:
          - array
          - 'null'
        capability_revision:
          type: string
        caveats:
          items:
            type: string
          type:
          - array
          - 'null'
        compatible:
          type: boolean
        content:
          $ref: '#/components/schemas/ContentConstraint'
        description_required:
          type: boolean
        dynamic_options:
          additionalProperties:
            items:
              $ref: '#/components/schemas/Option'
            type:
            - array
            - 'null'
          type: object
        expires_at:
          type: string
        format_selection_required:
          type: boolean
        immediate_readiness:
          $ref: '#/components/schemas/Decision'
        intents:
          items:
            type: string
          type:
          - array
          - 'null'
        issues:
          items:
            $ref: '#/components/schemas/ValidationIssue'
          type:
          - array
          - 'null'
        label:
          type: string
        media:
          $ref: '#/components/schemas/MediaConstraint'
        media_shapes:
          items:
            type: string
          type:
          - array
          - 'null'
        metadata:
          additionalProperties:
            type: string
          type: object
        native_scheduling:
          type: boolean
        openpost_queued:
          type: boolean
        output_profile:
          type: string
        profile:
          type: string
        provider:
          type: string
        requires_app_review:
          type: boolean
        requires_public_media:
          type: boolean
        scheduled_readiness:
          $ref: '#/components/schemas/Decision'
        segment_strategy:
          enum:
          - preserve
          - join
          type: string
        setting_groups:
          items:
            $ref: '#/components/schemas/ResolvedSettingGroup'
          type:
          - array
          - 'null'
        settings:
          items:
            $ref: '#/components/schemas/SettingDefinition'
          type:
          - array
          - 'null'
        text_limit:
          format: int64
          type: integer
        title_required:
          type: boolean
        unavailable_reason:
          type: string
        validation_categories:
          items:
            type: string
          type:
          - array
          - 'null'
      required:
      - account_id
      - immediate_readiness
      - scheduled_readiness
      - compatible
      - format_selection_required
      - segment_strategy
      - available_formats
      - active_constraints
      - setting_groups
      - issues
      - provider
      - profile
      - output_profile
      - intents
      - media_shapes
      - label
      - native_scheduling
      - openpost_queued
      - requires_app_review
      - requires_public_media
      - media
      - content
      - capability_revision
      type: object
    Capability:
      additionalProperties: false
      properties:
        capability_revision:
          type: string
        caveats:
          items:
            type: string
          type:
          - array
          - 'null'
        content:
          $ref: '#/components/schemas/ContentConstraint'
        description_required:
          type: boolean
        expires_at:
          type: string
        intents:
          items:
            type: string
          type:
          - array
          - 'null'
        label:
          type: string
        media:
          $ref: '#/components/schemas/MediaConstraint'
        media_shapes:
          items:
            type: string
          type:
          - array
          - 'null'
        metadata:
          additionalProperties:
            type: string
          type: object
        native_scheduling:
          type: boolean
        openpost_queued:
          type: boolean
        output_profile:
          type: string
        profile:
          type: string
        provider:
          type: string
        requires_app_review:
          type: boolean
        requires_public_media:
          type: boolean
        settings:
          items:
            $ref: '#/components/schemas/SettingDefinition'
          type:
          - array
          - 'null'
        text_limit:
          format: int64
          type: integer
        title_required:
          type: boolean
        unavailable_reason:
          type: string
        validation_categories:
          items:
            type: string
          type:
          - array
          - 'null'
      required:
      - provider
      - profile
      - output_profile
      - intents
      - media_shapes
      - label
      - native_scheduling
      - openpost_queued
      - requires_app_review
      - requires_public_media
      - media
      - content
      - capability_revision
      type: object
    SettingConstraint:
      additionalProperties: false
      properties:
        accept:
          items:
            type: string
          type:
          - array
          - 'null'
        date_time:
          description: Value must be an RFC 3339 timestamp with a timezone
          type: boolean
        local_date_time:
          type: boolean
        max_items:
          format: int64
          type: integer
        max_length:
          format: int64
          type: integer
        maximum:
          format: double
          type: number
        min_items:
          format: int64
          type: integer
        min_length:
          format: int64
          type: integer
        minimum:
          format: double
          type: number
        pattern:
          type: string
        unique_items:
          type: boolean
      type: object
    ResolveCapabilitiesOutputBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/ResolveCapabilitiesOutputBody.json
          format: uri
          readOnly: true
          type: string
        accounts:
          items:
            $ref: '#/components/schemas/ResolvedAccountCapability'
          type:
          - array
          - 'null'
      required:
      - accounts
      type: object
    SettingDefinition:
      additionalProperties: false
      properties:
        access_requirements:
          items:
            type: string
          type:
          - array
          - 'null'
        capability:
          type: string
        conflicts:
          items:
            $ref: '#/components/schemas/SettingCondition'
          type:
          - array
          - 'null'
        constraints:
          $ref: '#/components/schemas/SettingConstraint'
        control:
          type: string
        default: {}
        dependencies:
          items:
            $ref: '#/components/schemas/SettingCondition'
          type:
          - array
          - 'null'
        group:
          enum:
          - content
          - conversation
          - distribution
          - disclosure
          - media_accessibility
          type: string
        help:
          type: string
        intents:
          items:
            type: string
          type:
          - array
          - 'null'
        key:
          type: string
        label:
          type: string
        media_shapes:
          items:
            type: string
          type:
          - array
          - 'null'
        message_key:
          type: string
        options:
          items:
            type: string
          type:
          - array
          - 'null'
        options_source:
          type: string
        output_profiles:
          items:
            type: string
          type:
          - array
          - 'null'
        post_only:
          description: Choose this setting on each post, never in reusable Social Set defaults
          type: boolean
        required:
          type: boolean
        required_policy:
          enum:
          - never
          - always
          - when_available
          type: string
        scope:
          enum:
          - destination
          - segment
          - media_item
          type: string
        type:
          type: string
        unavailable_reason:
          type: string
      required:
      - key
      - message_key
      - label
      - group
      - control
      - type
      - scope
      - required
      type: object
    RefreshCapabilitiesInputBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/RefreshCapabilitiesInputBody.json
          format: uri
          readOnly: true
          type: string
        workspace_id:
          type: string
      required:
      - workspace_id
      type: object
    RefreshCapabilityOutcome:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/RefreshCapabilityOutcome.json
          format: uri
          readOnly: true
          type: string
        error_code:
          type: string
        job_ids:
          description: Durable collection jobs to observe before presenting upstream refresh completion
          items:
            type: string
          type:
          - array
          - 'null'
        queued:
          format: int64
          type: integer
        status:
          enum:
          - queued
          - failed
          - unavailable
          type: string
      required:
      - status
      - queued
      type: object
    ContentConstraint:
      additionalProperties: false
      properties:
        alt_text:
          $ref: '#/components/schemas/TextConstraint'
        body:
          $ref: '#/components/schemas/TextConstraint'
        description:
          $ref: '#/components/schemas/TextConstraint'
        title:
          $ref: '#/components/schemas/TextConstraint'
      required:
      - body
      - title
      - description
      - alt_text
      type: object
    Decision:
      additionalProperties: false
      properties:
        advertisable:
          type: boolean
        analytics_ready:
          type: boolean
        blockers:
          items:
            $ref: '#/components/schemas/Blocker'
          type:
          - array
          - 'null'
        connectable:
          type: boolean
        contract_digest:
          type: string
        discoverable:
          type: boolean
        executable:
          type: boolean
        facts:
          $ref: '#/components/schemas/Facts'
        observable:
          type: boolean
        publishable:
          type: boolean
        state:
          type: string
      required:
      - state
      - executable
      - connectable
      - publishable
      - discoverable
      - observable
      - analytics_ready
      - advertisable
      - facts
      type: object
    DestinationFormat:
      additionalProperties: false
      properties:
        compatible:
          type: boolean
        label:
          type: string
        output_profile:
          type: string
        profile:
          type: string
      required:
      - output_profile
      - profile
      - label
      - compatible
      type: object
    TextConstraint:
      additionalProperties: false
      properties:
        max_length:
          format: int64
          type: integer
        min_length:
          format: int64
          type: integer
        recommended_max_length:
          format: int64
          type: integer
        required:
          type: boolean
      required:
      - required
      type: object
    Blocker:
      additionalProperties: false
      properties:
        code:
          type: string
        detail:
          type: string
      required:
      - code
      type: object
    ResolveCapabilitySegmentInput:
      additionalProperties: false
      properties:
        content:
          description: Canonical segment body
          type: string
        description:
          description: Canonical segment description
          type: string
        id:
          description: Stable segment ID
          type: string
        media:
          description: Ordered segment media
          items:
            $ref: '#/components/schemas/ResolveCapabilityMediaInput'
          type:
          - array
          - 'null'
        settings:
          additionalProperties: {}
          description: Authored segment settings, including attachment requirements
          type: object
        title:
          description: Canonical segment title
          type: string
        url:
          description: Canonical segment URL
          type: string
      required:
      - id
      type: object
    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
    Facts:
      additionalProperties: false
      properties:
        approval:
          type: string
        authorization:
          type: string
        configuration:
          type: string
        control:
          type: string
        live_certification:
          type: string
        local_test:
          type: string
        policy:
          type: string
      required:
      - configuration
      - local_test
      - live_certification
      - approval
      - authorization
      - control
      - policy
      type: object
    ResolvedSettingGroup:
      additionalProperties: false
      properties:
        key:
          type: string
        settings:
          items:
            $ref: '#/components/schemas/SettingDefinition'
          type:
          - array
          - 'null'
      required:
      - key
      - settings
      type: object
    SettingCondition:
      additionalProperties: false
      properties:
        key:
          type: string
        operator:
          enum:
          - equals
          - not_equals
          - present
          - absent
          - in
          type: string
        value: {}
      required:
      - key
      - operator
      type: object
    ValidationIssue:
      additionalProperties: false
      properties:
        code:
          type: string
        fallback_message:
          type: string
        field:
          type: string
        media_id:
          type: string
        message:
          type: string
        output_profile:
          type: string
        parameters:
          additionalProperties: {}
          type: object
        profile:
          type: string
        provider:
          type: string
        scope:
          type: string
        scope_id:
          type: string
        segment_id:
          type: string
        severity:
          type: string
      required:
      - severity
      - code
      - message
      - fallback_message
      type: object
    RefreshCapabilitiesResult:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/RefreshCapabilitiesResult.json
          format: uri
          readOnly: true
          type: string
        engagement:
          $ref: '#/components/schemas/RefreshCapabilityOutcome'
        messaging:
          $ref: '#/components/schemas/RefreshCapabilityOutcome'
      required:
      - engagement
      - messaging
      type: object
    Profile:
      additionalProperties: false
      properties:
        description:
          type: string
        key:
          type: string
        name:
          type: string
      required:
      - key
      - name
      - description
      type: object
    Option:
      additionalProperties: false
      properties:
        label:
          type: string
        value:
          type: string
      required:
      - value
      - label
      type: object
    MediaConstraint:
      additionalProperties: false
      properties:
        allowed_audio_codecs:
          items:
            type: string
          type:
          - array
          - 'null'
        allowed_mimes:
          items:
            type: string
          type:
          - array
          - 'null'
        allowed_video_codecs:
          items:
            type: string
          type:
          - array
          - 'null'
        aspect_ratios:
          items:
            type: string
          type:
          - array
          - 'null'
        audio_policy:
          enum:
          - optional
          - required
          - forbidden
          type: string
        max_count:
          format: int64
          type: integer
        max_duration_seconds:
          format: int64
          type: integer
        max_frame_rate:
          format: double
          type: number
        max_height:
          format: int64
          type: integer
        max_image_size_bytes:
          format: int64
          type: integer
        max_pixels:
          description: Maximum total decoded image pixels, width times height
          format: int64
          type: integer
        max_short_side:
          description: Maximum image dimension on its shorter side
          format: int64
          type: integer
        max_size_bytes:
          format: int64
          type: integer
        max_video_aspect_ratio:
          type: string
        max_width:
          format: int64
          type: integer
        min_count:
          format: int64
          type: integer
        min_height:
          format: int64
          type: integer
        min_video_aspect_ratio:
          type: string
        min_width:
          format: int64
          type: integer
        requires_https_fetchable:
          type: boolean
        requires_public_url:
          type: boolean
        video_exclusive:
          description: A video must be the only attachment in a segment
          type: boolean
      required:
      - min_count
      - max_count
      - allowed_mimes
      - requires_public_url
      - requires_https_fetchable
      type: object
    ResolveCapabilitiesInputBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/ResolveCapabilitiesInputBody.json
          format: uri
          readOnly: true
          type: string
        account_ids:
          description: Connected account IDs
          items:
            type: string
          minItems: 1
          type:
          - array
          - 'null'
          uniqueItems: true
        account_segments:
          additionalProperties:
            items:
              $ref: '#/components/schemas/ResolveCapabilitySegmentInput'
            type:
            - array
            - 'null'
          description: Effective segments for customized destinations, keyed by selected connected account ID
          type: object
        account_settings:
          additionalProperties:
            additionalProperties: {}
            type: object
          description: Destination settings keyed by connected account ID
          type: object
        creation_preset:
          description: Starter preset used only to choose initial destination formats
          enum:
          - post
          - thread
          - story
          - short_video
          - video
          type: string
        intent:
          description: Deprecated compatibility alias for creation_preset
          enum:
          - post
          - thread
          - story
          - short_video
          - video
          type: string
        locale:
          description: BCP 47 locale for option labels
          type: string
        region:
          description: ISO 3166-1 alpha-2 region
          type: string
        requested_output_profiles:
          additionalProperties:
            type: string
          description: Explicit or saved output profiles keyed by connected account ID
          type: object
        segments:
          description: Ordered canonical segments
          items:
            $ref: '#/components/schemas/ResolveCapabilitySegmentInput'
          minItems: 1
          type:
          - array
          - 'null'
        source_url:
          description: Canonical source URL
          type: string
      required:
      - account_ids
      - segments
      type: object
    CapabilitiesOutputBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/CapabilitiesOutputBody.json
          format: uri
          readOnly: true
          type: string
        capabilities:
          description: Provider/profile capability matrix
          items:
            $ref: '#/components/schemas/Capability'
          type:
          - array
          - 'null'
        profiles:
          description: Content profiles supported by OpenPost
          items:
            $ref: '#/components/schemas/Profile'
          type:
          - array
          - 'null'
      required:
      - profiles
      - capabilities
      type: object
    ResolveCapabilityMediaInput:
      additionalProperties: false
      properties:
        alt_text:
          description: Destination alt-text override
          type: string
        media_id:
          description: Media attachment ID
          type: string
      required:
      - media_id
      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
  securitySchemes:
    bearerAuth:
      bearerFormat: OpenPost API token or session JWT
      scheme: bearer
      type: http
    sessionCookie:
      in: cookie
      name: openpost_session
      type: apiKey