OpenShorts Social API

The Social API from OpenShorts — 9 operation(s) for social.

GitHub OpenAPI

Operations 9

POST /api/social/connect Social Connect #
POST /api/social/post Post To Socials #
GET /api/social/post-status/{request_id} Social Post Status #
GET /api/social/user Get Social User #
GET /api/social/analytics Social Profile Analytics #
GET /api/social/analytics/posts Social Post Analytics #
GET /api/social/analytics/impressions Social Total Impressions #
GET /api/social/scheduled Social Scheduled #
DELETE /api/social/scheduled/{job_id} Social Cancel Scheduled #

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/openshorts-app:openshorts-app-social-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

openshorts-app-social-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fast Social API
  version: 0.1.0
tags:
- name: Social
paths:
  /api/social/connect:
    post:
      summary: Social Connect
      description: 'Return a branded Upload-Post connection URL for the signed-in managed

        user. Paid plans only (``require_paid_plan_to_connect``).'
      operationId: social_connect_api_social_connect_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Social
  /api/social/post:
    post:
      summary: Post To Socials
      operationId: post_to_socials_api_social_post_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SocialPostRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Social
  /api/social/post-status/{request_id}:
    get:
      summary: Social Post Status
      description: 'Where an async upload started by /api/social/post really ended up.


        A 200 from the upload only means Upload-Post accepted the file; the post

        itself can still fail per platform, and the dashboard used to say "Posted

        successfully!" either way.'
      operationId: social_post_status_api_social_post_status__request_id__get
      parameters:
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          title: Request Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Social
  /api/social/user:
    get:
      summary: Get Social User
      description: 'Proxy to fetch user profiles from Upload-Post.


        BYOK: uses the caller''s key and returns all profiles on that account.

        Managed: uses the server key but returns ONLY the caller''s own profile.'
      operationId: get_social_user_api_social_user_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Social
  /api/social/analytics:
    get:
      summary: Social Profile Analytics
      description: 'Aggregated profile analytics: followers, views, engagement per platform.'
      operationId: social_profile_analytics_api_social_analytics_get
      parameters:
      - name: platforms
        in: query
        required: false
        schema:
          type: string
          default: tiktok,instagram,youtube
          title: Platforms
      - name: user
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Social
  /api/social/analytics/posts:
    get:
      summary: Social Post Analytics
      description: Per-post metrics for the profile's published posts (Upload-Post cache).
      operationId: social_post_analytics_api_social_analytics_posts_get
      parameters:
      - name: platform
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Platform
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      - name: since
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Since
      - name: until
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Until
      - name: user
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Social
  /api/social/analytics/impressions:
    get:
      summary: Social Total Impressions
      description: 'Views of the posts published through OpenShorts in a window.


        Computed by aggregating the profile-scoped post cache instead of proxying

        Upload-Post''s /total-impressions: that endpoint echoes the requested

        profile but returns account-wide numbers (observed 2026-08-21 — a profile

        with zero posts got 85K Instagram impressions), which for managed users

        would leak other tenants'' aggregates. The cache endpoint IS scoped by

        ?user=, but its ``since`` is the snapshot date and it carries the creator''s

        native posts too: social_metrics.summarise keeps only our posts published

        in the window, latest snapshot each.'
      operationId: social_total_impressions_api_social_analytics_impressions_get
      parameters:
      - name: period
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Period
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Start Date
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: End Date
      - name: platform
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Platform
      - name: breakdown
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Breakdown
      - name: user
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Social
  /api/social/scheduled:
    get:
      summary: Social Scheduled
      description: Pending scheduled posts for the caller's profile, soonest first.
      operationId: social_scheduled_api_social_scheduled_get
      parameters:
      - name: user
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Social
  /api/social/scheduled/{job_id}:
    delete:
      summary: Social Cancel Scheduled
      description: Cancel one pending scheduled post, if it belongs to the caller.
      operationId: social_cancel_scheduled_api_social_scheduled__job_id__delete
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: user
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Social
components:
  schemas:
    SocialPostRequest:
      properties:
        job_id:
          type: string
          title: Job Id
        clip_index:
          type: integer
          title: Clip Index
        api_key:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Key
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
        platforms:
          items:
            type: string
          type: array
          title: Platforms
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        scheduled_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Scheduled Date
        timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Timezone
          default: UTC
      type: object
      required:
      - job_id
      - clip_index
      - platforms
      title: SocialPostRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError