Complete an upload

Checks the uploaded bytes and makes them a Library asset to use as a run input. Completing again returns the same asset. Takes no body.

Needs the uploads:create scope.

POST /uploads/{id}/complete

Complete an upload

cURL

curl --request POST \
  --url https://api.zerogen.com/v1/uploads/{id}/complete \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "projectId": "<string>",
  "status": "upload_required",
  "assetId": "<string>",
  "upload": {
    "method": "PUT",
    "url": "<string>",
    "headers": {},
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "folder": {
    "id": "<string>",
    "filed": true,
    "error": "<string>"
  }
}

Authorizations

Authorization · string · header · required

A ZeroGen API key: zg_ for a live key, zg_test_ for a test key.

Headers

Idempotency-Key · string

Makes retries safe: a retry with the same key and body returns the first response for 24 hours instead of repeating the work. Reusing a key with a different body returns 409.

Required string length: 1 - 255

Pattern: ^[\x21-\x7e]+$

Path Parameters

id · string · required

The upload's ID, as create returned it

Response

200

application/json

The ready upload.

id · string · required

The upload's ID, which completes it

projectId · string · required

status · enum<string> · required

upload_required: PUT the bytes, then complete; ready: the asset can be used

Available options: upload_required, ready

assetId · string | null · required

Once ready, the Library asset to send as a run input; an identical file already in the project is reused

upload · object | null · required

Where to PUT the file's exact bytes, with these headers, before expiresAt

Show child attributes

folder · object

Whether the asset was added to the folder named at create

Show child attributes