HivePost API
Menu

Media

Add a photo or video by link

POSThttps://hivepost.app/v1/media

HivePost downloads the file in the background; it starts as importing. You can use its id in POST /v1/posts right away: the post waits for the file. In test mode the file is not downloaded and comes back ready.

Send an Idempotency-Key header. If the request times out and you send it again with the same key, you get the first answer instead of a second file. How it works

Headers

  • Idempotency-Keystring

    1–255 printable characters. The same key within 24 hours returns the first response.

Body

  • urlstringRequired

    A public http or https link.

  • brand_idstring

    Needed when the workspace has more than one brand.

  • alt_textstring

    Up to 2,000 characters.

Returns

201 Created.

Errors

StatusCodeWhen
400validation_failedThe body isn't JSON, or the Idempotency-Key header isn't valid (validation_failed).
401unauthorizedNo API key, or one that isn't valid (unauthorized).
403forbidden, drafts_only, network_not_availableThe key can't do this (forbidden, drafts_only), or the network isn't open in the API (network_not_available).
409idempotency_conflictThe Idempotency-Key was used for a different request, or its first request is still running (idempotency_conflict).
413payload_too_largeThe body is over 64 KB (payload_too_large).
422validation_failed, return_url_not_allowed, account_not_connected, text_too_long, media_required, time_in_pastA field is wrong (validation_failed), a connect link's return_url isn't on an allowed domain (return_url_not_allowed), an account needs reconnecting (account_not_connected), or a network refuses the post as it is (e.g. text_too_long, media_required, time_in_past). details lists each problem with the account it is about.
429rate_limitedMore than 60 requests in a minute (rate_limited).
500internal_errorSomething went wrong on our side (internal_error). Safe to retry with the same Idempotency-Key.