Upload an image file directly
Uploads multipart/form-data directly through TokPortal and returns storage details. Use the returned storage_path — NOT public_url — for carousel_images and profile_picture_url. HEIF/HEIC may be converted to JPEG. purpose is validated like it is on the JSON upload endpoints: an explicit value other than carousel or profile_picture is refused with INVALID_FIELD for MCP callers and reported in meta.ignored_fields for direct REST callers — it is no longer quietly rounded down to carousel. Omitting purpose still means carousel, which is the documented default. Confirm the destination with the returned bucket.
Request
- Base URL: https://app.tokportal.com/api/ext
- URL: https://app.tokportal.com/api/ext/upload/image/direct
- Auth: API key in header X-API-Key
Headers
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).
Response
Uploaded image URL.
Changes
No recorded changes to this operation across all 1 revision of this API.