Antwork Platforms API

openapi: 3.2.0
info:
  title: Antwork Platforms API
  version: v1
  description: 'Draft, schedule and publish social posts on the accounts connected to your Antwork workspaces. Reference: https://antwork.io/docs/api'
servers:
- url: https://antwork.io/api/v1
security:
- apiKey: []
tags:
- name: Platforms
paths:
  /platforms:
    get:
      operationId: listPlatforms
      summary: Character limits, media rules, daily caps and per-post settings of every…
      description: 'Static, from the rules the publishers enforce. Holds nothing about the caller.


        Any valid key.


        Docs: https://antwork.io/docs/api/platforms'
      x-antwork-scope: null
      externalDocs:
        url: https://antwork.io/docs/api/platforms
      responses:
        '200':
          description: Every platform.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformList'
        '401':
          description: 'No usable API key. Codes: `api_key_missing`, `api_key_malformed`, `api_key_unknown`, `api_key_revoked`.'
          x-error-codes:
          - api_key_missing
          - api_key_malformed
          - api_key_unknown
          - api_key_revoked
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The key cannot do this. Codes: `subscription_inactive`.'
          x-error-codes:
          - subscription_inactive
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Rate limited. See the X-RateLimit-* and Retry-After headers. Codes: `rate_limit_burst`, `rate_limit_daily`.'
          x-error-codes:
          - rate_limit_burst
          - rate_limit_daily
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: 'Something went wrong on our end. Codes: `internal_error`.'
          x-error-codes:
          - internal_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Platforms
components:
  schemas:
    TikTokChoices:
      type: object
      description: 'With `tiktok_choices_needed`: what to put in front of the user before a TikTok post goes. Build the UI from it; never pick for the user.'
      properties:
        creator:
          type: object
          properties:
            nickname:
              type:
              - string
              - 'null'
            avatarUrl:
              type:
              - string
              - 'null'
        privacyLevel:
          type: object
          description: 'No default: `default` is always null.'
          properties:
            default:
              type: 'null'
            options:
              type: array
              items:
                type: object
                properties:
                  value:
                    type: string
                  label:
                    type: string
            notWithBrandedContent:
              type: array
              items:
                type: string
        interactions:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              label:
                type: string
              default:
                const: false
              disabledByCreator:
                type: boolean
        commercialContent:
          type: object
          description: Off by default; once on, at least one of `yourBrand` / `brandedContent`, each with the label TikTok shows.
        aiGenerated:
          type: object
        maxVideoPostDurationSec:
          type:
          - integer
          - 'null'
        videoDurationSec:
          type: number
        declaration:
          type: object
          description: 'Shown, with its links, and agreed to before `userConsented: true` is sent.'
          properties:
            text:
              type: string
            textWithBrandedContent:
              type: string
            links:
              type: object
              additionalProperties:
                type: string
            requiresConsent:
              const: true
        preview:
          type: object
          properties:
            text:
              type: string
            mediaUrls:
              type: array
              items:
                type: string
        lastUsed:
          type: object
          description: 'The account''s last answers that still apply, when it has some: ask the user once, then send `{useLast: true, userConsented: true}`.'
          properties:
            settings:
              type: object
            summary:
              type: string
        nextStep:
          type: string
    PlatformList:
      type: object
      required:
      - object
      - platforms
      properties:
        object:
          const: list
        platforms:
          type: array
          items:
            $ref: '#/components/schemas/Platform'
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - type
          - code
          - message
          properties:
            type:
              type: string
              enum:
              - authentication_error
              - permission_error
              - invalid_request_error
              - rate_limit_error
              - api_error
            code:
              type: string
              description: Stable identifier to branch on. See /docs/api/errors.
            message:
              type: string
              description: For a human reading a log; may change.
            param:
              type: string
              description: The offending field, when one can be named.
            tiktokChoices:
              $ref: '#/components/schemas/TikTokChoices'
            problems:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
              description: '`tiktok_choices_needed` after settings were sent: what was wrong with each.'
            settingsUrl:
              type: string
              description: '`tiktok_choices_needed`: the post in the composer with its settings open.'
    SettingField:
      type: object
      required:
      - key
      - label
      - type
      properties:
        key:
          type: string
        label:
          type: string
        type:
          type: string
          enum:
          - enum
          - bool
          - text
          - url
        options:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
              label:
                type: string
        default: {}
        maxLength:
          type: integer
        placeholder:
          type: string
    Platform:
      type: object
      required:
      - object
      - id
      - name
      - text
      - media
      - dailyPostCap
      - mentions
      - settings
      properties:
        object:
          const: platform
        id:
          type: string
        name:
          type: string
        text:
          type: object
          properties:
            limit:
              type:
              - integer
              - 'null'
            required:
              type: boolean
            counting:
              type: string
              enum:
              - weighted
              - graphemes
              - characters
        media:
          type: object
          properties:
            required:
              type: boolean
            maxItems:
              type: integer
            canMixImageAndVideo:
              type: boolean
            types:
              type: object
              additionalProperties:
                type: object
                properties:
                  extensions:
                    type: array
                    items:
                      type: string
                  mimeTypes:
                    type: array
                    items:
                      type: string
                  maxSizeBytes:
                    type: integer
                  maxItems:
                    type: integer
                  maxDurationSeconds:
                    type:
                    - integer
                    - 'null'
                  aspectRatios:
                    type: array
                    items:
                      type: string
        dailyPostCap:
          type: object
          properties:
            free:
              type:
              - integer
              - 'null'
            paid:
              type:
              - integer
              - 'null'
        mentions:
          type: object
          properties:
            links:
              type: string
            maxPerPost:
              type:
              - integer
              - 'null'
        derivedTitleLimit:
          type:
          - integer
          - 'null'
        settings:
          type: array
          items:
            $ref: '#/components/schemas/SettingField'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: '`Authorization: Bearer ak_...`. See /docs/api/keys.'