Skip to content
calternal docs

Start a public file drop upload

POST
/api/v1/public/{slug}/uploads
curl --request POST \
  --url https://example.com/api/v1/public/example/uploads \
  --header 'Tus-Resumable: example' \
  --header 'Upload-Length: example' \
  --header 'Upload-Metadata: example'

Route: /api/v1/public/{slug}/uploads. Inputs: slug, Tus-Resumable, Upload-Length, Upload-Metadata, Upload-Conflict-Policy, Upload-Checksum, X-Public-Password. Do not automatically replay this operation after an uncertain result.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Header Parameters

Section titled “Header Parameters”
Tus-Resumable
required
string

Tus protocol version 1.0.0

Upload-Length
required
string

Total upload length in bytes

Upload-Metadata
required
string

Base64 encoded upload filename and path

Upload-Conflict-Policy
string | null
Upload-Checksum
string | null
X-Public-Password
string

Responses

Section titled “Responses”

201

Section titled “201”

403

Section titled “403”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

429

Section titled “429”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

507

Section titled “507”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}