Skip to main content
POST
Create a document

Authorizations

Authorization
string
header
required

Workspace API key, prefixed rqk_.

Path Parameters

url
string
required

Workspace slug.

Body

multipart/form-data
file
file
required

The file to upload.

name
string

Display name. Defaults to the filename.

domain
string

Custom domain for the generated link. Must already belong to the workspace, else 422. Defaults to rqk.sh. Send this to get a branded link in a single call.

key
string

Short key for the generated link. A random key is minted when omitted.

title
string
description
string
card
file

Social card image.

password
string
expiresAt
string<date-time>
ios
string
android
string

Response

Created

id
string
name
string
file
string

Storage key or URL.

size
integer

Bytes.

type
string
workspaceId
string
createdAt
string<date-time>
updatedAt
string<date-time>