Uploads

Import an image from URL

Fetches a public direct image URL and stores it permanently in TokPortal storage. Use the returned storage_path — NOT public_url — for carousel_images and profile_picture_url.

post/upload/image/from-url

Request

  • Base URL: https://app.tokportal.com/api/ext
  • URL: https://app.tokportal.com/api/ext/upload/image/from-url
  • Auth: API key in header X-API-Key

Headers

X-TokPortal-Dry-Run'true' | '1' | 'yes'

Send true (or 1/yes) to SIMULATE this call instead of executing it. A dry run performs the full validation and pricing path of the real operation and stops before the first write: no credits are debited, no rows are created, no webhooks fire, and no operator ever sees it. The response has the same shape and status as the real call and adds dry_run: true, dry_run_notice, and — on credit-spending operations — credits_would_charge carrying the real price. Errors are identical to the real call, which is the point: this is how you learn what an operation will do before paying for it. Rate limits are consumed normally, a supplied Idempotency-Key is ignored rather than burned, and identifiers returned by a dry run are synthetic (see DRY_RUN_ID_IN_LIVE_REQUEST).

Request body

urlstring uri required

Public direct image URL.

bundle_idstring uuid required
purpose'carousel' | 'profile_picture'

Response

Stored image details.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.