Skip to content
Press.js Press.js Press.js Docs

Create an upload session

POST
/v1/upload-sessions
 
curl --request POST \
  --url https://api.pressjs.dev/v1/upload-sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '"example"'

Creates an upload session for artifact ingestion and version preparation.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
deployId
string
>= 1 characters
createDeploy
object
slug
required
string
>= 1 characters
name
required
string
>= 1 characters
temporaryRender

Internal flag used by Press.js CLI temporary remote renders. Temporary deploys are deleted after the render job reaches a terminal state.

boolean
files
required
Array<object>
>= 1 items
object
path
required
string
>= 1 characters
sha256
required
string
>= 1 characters
size
required
integer
mime
string
One of:
Example generated
example

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Upload session created.

Media type application/json
object
uploadSession
required
object
id
required
string
deployId
string
status
required
string
Allowed values: open committed expired
requestedFileCount
required
integer
requestedBytes
required
integer
createdAt
required
integer
expiresAt
required
integer
uploadToken
required
string
>= 1 characters
Example 
{
  "uploadSession": {
    "status": "open"
  }
}

400

Section titled “400 ”

Invalid request payload or parameters.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

409

Section titled “409 ”

Requested operation conflicts with the current resource state.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

501

Section titled “501 ”

Route is defined but not implemented yet.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}