Create a public delivery link

POST

/v1/workspaces/{workspaceId}/assets/collections/{collectionId}/share

const url = 'https://shareout.site/v1/workspaces/example/assets/collections/example/share';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"expiresAt":"2026-04-15T12:00:00Z","gate":"none","password":"example","domains":["example"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://shareout.site/v1/workspaces/example/assets/collections/example/share \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expiresAt": "2026-04-15T12:00:00Z", "gate": "none", "password": "example", "domains": [ "example" ] }'

Mint an unguessable /d/<token> download page for a collection. Optional gate (none, password, domain), expiresAt, and gate inputs. Protected deliveries stream bytes through /d/<token>/file/<blobId>.

Authorizations

bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

collectionId

required

string

Request Body

application/json

object

expiresAt

string format: date-time

nullable

gate

string

default: none

Allowed values: none password domain

password

Required when gate=password.

string

domains

Required when gate=domain (e.g. acme.com).

Array<string>

Responses

201

Share link created

application/json

object

string

url

string format: uri

collectionName

string

fileCount

integer

gate

string

Allowed values: none password domain

expiresAt

string format: date-time

nullable

viewCount

integer

revoked

boolean

expired

boolean

Example

{
  "gate": "none"
}

400

Invalid request

application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}

403

Access denied

application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}