PlatformsList platforms
Back to Sofia

Platforms

List platforms

Lists each network with its caption, media and format rules, the same ones the sandbox and dry run apply, and whether it is open to the token owner.

GEThttps://api.sofia-post.com/api/v1/platforms
GET/v1/platforms
curl -X GET 'https://api.sofia-post.com/api/v1/platforms' \
  -H "Authorization: Bearer $SOFIA_API_KEY"

Authorizations

  • Authorizationstringrequired

    Your personal key or OAuth access token, sent as Bearer <token>.

Response

200application/json

The list of platforms and their rules.

  • dataobject[]required

    The platforms

    Show child attributes
    • platformstringrequired

      Network identifier

      Allowed values: instagramfacebookxlinkedintiktok

    • namestringrequired

      Display name of the network

    • availablebooleanrequired

      Open to the person the token acts for; otherwise a post there is refused

    • captionobjectrequired

      Caption rules

      Show child attributes
      • maxLengthnumberrequired

        Maximum number of characters (weighted on X)

      • enforcedbooleanrequired

        true: the network flatly refuses beyond the limits (422 post_refused)

      • maxHashtagsnumber

        Maximum number of hashtags

      • maxMentionsnumber

        Maximum number of mentions

      • threadobject

        Present when the network publishes a thread

        Show child attributes
        • maxPostsnumberrequired

          Maximum number of posts in a thread

    • mediaobjectrequired

      Media rules

      Show child attributes
      • maxCountnumberrequired

        Maximum number of media in a post

      • enforcedbooleanrequired

        true: the network flatly refuses beyond the limit

      • mixImagesAndVideobooleanrequired

        false: photos and video cannot be mixed in one post

      • imageTypesstring[]required

        Accepted image MIME types

      • videoTypesstring[]required

        Accepted video MIME types

    • formatsobject[]required

      Formats the network accepts

      Show child attributes
      • formatstringrequired

        Name of the format

      • defaultbooleanrequired

        The format used when the target declares none

      • requiredMediastringrequired

        none: publishable without a visual; any: a visual of any kind

        Allowed values: noneimagevideoany

      • captionPublishedbooleanrequired

        false: the caption is not sent (story)

4XXapplication/json

Any other error, in the error envelope.