deploy.social Account API

openapi: 3.2.0
info:
  title: Deploy Social Account API
  version: 1.0.0
  description: 'Operations tagged Account across 2 of this provider''s published API definitions: deploy-social-openapi.json, deploy-social-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.deploy.social/v1
security:
- apiKey: []
tags:
- name: Account
  description: The key you're using and its workspace.
paths:
  /me:
    get:
      security:
      - apiKey: []
      operationId: getMe
      tags:
      - Account
      summary: Check your key
      description: 'The key you''re using, its workspace, your plan, how many videos you''ve posted this month, and what your plan allows through the API: requests a minute, and API posts today. A good first call to check a key works.'
      responses:
        '200':
          description: Your key and workspace.
          headers:
            X-Request-Id:
              required: true
              description: This request's id. Include it if you contact us.
              schema:
                type: string
                description: This request's id. Include it if you contact us.
            X-RateLimit-Limit:
              required: true
              description: Requests this key can make each minute, for reads or for writes.
              schema:
                type: string
                description: Requests this key can make each minute, for reads or for writes.
            X-RateLimit-Remaining:
              required: true
              description: Requests left this minute.
              schema:
                type: string
                description: Requests left this minute.
            X-RateLimit-Reset:
              required: true
              description: Seconds until the count starts over.
              schema:
                type: string
                description: Seconds until the count starts over.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
        '401':
          description: 'The API key is missing, wrong, revoked or expired: `missing_api_key`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`.'
          content:
            application/json:
              example:
                error:
                  code: invalid_api_key
                  message: That API key isn't valid. Check it was copied in full.
                  details: []
                  request_id: req_8f14e45fceea167a
                  doc_url: https://deploy.social/docs/api/errors#invalid_api_key
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The key can''t do this: `insufficient_scope` (a read-only key), `plan_required`, `usage_limit_exceeded` (this month''s videos are used up), `access_revoked` (its creator left the workspace), `workspace_archived`.'
          content:
            application/json:
              example:
                error:
                  code: insufficient_scope
                  message: This API key can only read. Create a key with write access to make changes.
                  details: []
                  request_id: req_8f14e45fceea167a
                  doc_url: https://deploy.social/docs/api/errors#insufficient_scope
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Slow down and wait `Retry-After` seconds. Either this key has used its requests for the minute (Standard: 60 reads and 20 writes, Studio: 120 and 30), or, when publishing or scheduling, the plan''s API posts for the day are used (detail code `daily_post_limit`; Standard: 30 a day across your account, Studio: 100 a day per workspace; `Retry-After` runs to midnight UTC). Posts made in the app never count.'
          content:
            application/json:
              example:
                error:
                  code: rate_limited
                  message: This key has made its 20 write requests for this minute. Try again in 12 seconds.
                  details: []
                  request_id: req_8f14e45fceea167a
                  doc_url: https://deploy.social/docs/api/errors#rate_limited
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Something broke on our side. Retry, and contact us with the request id if it keeps happening.
          content:
            application/json:
              example:
                error:
                  code: internal_error
                  message: Something went wrong on our side.
                  details: []
                  request_id: req_8f14e45fceea167a
                  doc_url: https://deploy.social/docs/api/errors#internal_error
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: We can't take the request right now. Retry shortly.
          content:
            application/json:
              example:
                error:
                  code: unavailable
                  message: We can't take requests right now. Try again in a moment.
                  details: []
                  request_id: req_8f14e45fceea167a
                  doc_url: https://deploy.social/docs/api/errors#unavailable
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.deploy.social/v1
components:
  schemas:
    Me:
      type: object
      properties:
        key:
          type: object
          properties:
            id:
              type: string
              description: The API key's id. Starts with `key_`.
              example: key_cmf3jz0aa0000ab12cd34ef56
            name:
              type: string
              description: The name you gave the key.
              example: Zapier
            scopes:
              type: array
              items:
                type: string
                enum:
                - read
                - write
              description: What the key can do. `write` includes `read`.
              example:
              - read
              - write
          required:
          - id
          - name
          - scopes
          additionalProperties: false
        workspace:
          type: object
          properties:
            id:
              type: string
              description: The workspace's id. Starts with `ws_`.
              example: ws_cmf3jy9bb0000ab12cd34ef56
            name:
              type: string
              example: Northside Studio
          required:
          - id
          - name
          additionalProperties: false
        plan:
          type: object
          properties:
            name:
              type: string
              example: Standard
          required:
          - name
          additionalProperties: false
        usage:
          type: object
          properties:
            period:
              type: string
              description: The month the allowance counts, as YYYY-MM (UTC).
              example: 2026-09
            resets_at:
              type: string
              description: When the allowance starts over.
              format: date-time
              example: '2026-10-01T15:00:00.000Z'
            videos:
              type: object
              properties:
                used:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  description: Posts this month, of any kind.
                  example: 12
                limit:
                  anyOf:
                  - type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  - type: 'null'
                  description: Posts you can make each month, of any kind. `null` means no monthly limit.
                  example: null
              required:
              - used
              - limit
              additionalProperties: false
          required:
          - period
          - resets_at
          - videos
          additionalProperties: false
        limits:
          type: object
          properties:
            requests_per_minute:
              type: object
              properties:
                read:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  description: GET requests this key can make each minute.
                  example: 60
                write:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  description: Other requests this key can make each minute.
                  example: 20
              required:
              - read
              - write
              additionalProperties: false
              description: Per-key limits. REST and MCP calls share them.
            api_posts_per_day:
              type: object
              properties:
                limit:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  description: Posts the API and MCP can publish or schedule each UTC day.
                  example: 30
                used:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  description: Posts the API and MCP have published or scheduled today.
                  example: 4
                scope:
                  type: string
                  enum:
                  - organization
                  - workspace
                  description: 'What the allowance is shared across: every workspace in your account (Standard) or this workspace alone (Studio).'
                  example: organization
                resets_at:
                  type: string
                  description: The next midnight UTC, when `used` starts over.
                  format: date-time
                  example: '2026-10-01T15:00:00.000Z'
              required:
              - limit
              - used
              - scope
              - resets_at
              additionalProperties: false
              description: Drafts, reschedules, cancels and retries don't count, and neither does anything posted in the app.
          required:
          - requests_per_minute
          - api_posts_per_day
          additionalProperties: false
          description: What your plan allows through the API.
      required:
      - key
      - workspace
      - plan
      - usage
      - limits
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: What went wrong, for your code to act on. See the error reference.
              example: validation_failed
            message:
              type: string
              description: What went wrong, in a sentence you can show a person.
              example: TikTok needs you to choose who can watch.
            details:
              type: array
              items:
                $ref: '#/components/schemas/ErrorDetail'
              description: Each problem with the request, when there's more to say.
            request_id:
              type: string
              description: This request's id. Include it if you contact us about it.
              example: req_8f14e45fceea167a
            doc_url:
              type: string
              description: Where this error is explained.
              example: https://deploy.social/docs/api/errors#validation_failed
          required:
          - code
          - message
          - details
          - request_id
          - doc_url
          additionalProperties: false
      required:
      - error
      additionalProperties: false
      description: Every error has this shape.
    ErrorDetail:
      type: object
      properties:
        path:
          type: string
          description: Where in the request the problem is, like `destinations[0].options.privacy`. Empty when it's the request as a whole.
          example: destinations[0].options.privacy
        code:
          type: string
          description: What's wrong, for your code to act on. One of `required`, `invalid_value`, `too_long`, `unknown_option`, `unsupported_field`, `duplicate_destination`, `destination_unavailable`, `media_failed`, `media_incompatible`, `video_needs_vertical_fit`, `media_expired`, `option_conflict`, `timezone_required`, `schedule_out_of_range`, `daily_post_limit`, `imports_in_flight`, `images_in_flight`, `free_shared_account`. New codes may be added.
          example: required
        message:
          type: string
          description: What's wrong, in a sentence you can show a person.
          example: TikTok needs you to choose who can watch.
      required:
      - path
      - code
      - message
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Your API key, from the API tab in Deploy. Keys start with `ds_live_`.
x-refined-from:
- deploy-social-openapi.json
- deploy-social-openapi.yml