Skip to content

Options

storage

Host the image on the CDN and return its link. Set it to false to get the image only as base64, for 0.25 credits.

Type
boolean
Default
true
Group
Output
On this page

OverviewLink to this section

With storage on, the PNG is uploaded to a global CDN and its permanent link comes back in scrUrl. The link never expires and has unlimited bandwidth, so you can put it straight into a page, an email or a database.

Set it to false when you keep the image yourself. Nothing is stored, scrUrl is null, the image comes back only in scrBase64, and the capture costs 0.25 credits instead of 1.

ExampleLink to this section

The same request with the SDK, with cURL and as the raw JSON body.

screenshot.ts
import { Url2Image } from '@url2image/sdk'

const { success, data, message } = await Url2Image({
    url: 'https://example.com',
    token: process.env.URL2IMAGE_TOKEN,
    options: {
        storage: false
    }
})

Good to knowLink to this section

Related optionsLink to this section

Every option, grouped, is in the options overview.

Something unclear or missing on this page?

Tell us
Made with Modulify