Skip to main content

Get File URL by ID

GET 
/v2/storage/files/:id/url
Description: Retrieve a file URL for a specified ID. The generated URL automatically downloads the file. If you haven't generated a file yet, use the appropriate endpoint to do so.

Request​

Path Parameters

    id stringrequired

    File ID.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Responses​

File URL and information returned successfully.

Schema
    url stringrequired

    URL File.

    size numberrequired

    Size File. This format is in bytes. Ex: 307504 Byte => 300 KB => 0.3 MB

    state stringrequired

    Possible values: [PENDING, WAITING_UPLOAD, READY, ERROR, ABORTED]

    File state.

Loading...