Uploads operations

Bring-your-own-data upload sessions.

Each operation below is reachable at POST /v1/op/{operation_id} or the resource path POST /v1/{resource}/{action}, with a Bearer token (a gpra_ API key or a session token). Back to the Operations Reference index.

uploads.complete

Invoke Uploads Complete.

Scopeuploads:write
Side-effectcompute
HTTPPOST /v1/op/uploads.complete · POST /v1/uploads/complete
Python / TypeScriptclient.uploads.complete(…)
CLIgeopera uploads complete …

Request — a free-form JSON object.

uploads.fail

Mark an upload session failed, releasing its storage reservation.

Scopeuploads:write
Side-effectcompute
HTTPPOST /v1/op/uploads.fail · POST /v1/uploads/fail
Python / TypeScriptclient.uploads.fail(…)
CLIgeopera uploads fail …

Request — UploadFailInput

FieldTypeRequiredDescription
upload_idstringyes
error_messagestringyes
error_stepstring—

Response — UploadOutput.

uploads.initiate

Start an upload session, reserving storage quota (editor/admin on the project).

Scopeuploads:write
Side-effectcompute
HTTPPOST /v1/op/uploads.initiate · POST /v1/uploads/initiate
Python / TypeScriptclient.uploads.initiate(…)
CLIgeopera uploads initiate …

Request — UploadInitiate

FieldTypeRequiredDescription
project_idstringyes
transfer_methodstring—
file_countinteger—
total_bytesinteger—
target_collection_idstring—
target_item_idstring—
asset_keystring—
is_categoricalboolean—

Response — UploadOutput.

uploads.progress

Update an upload session’s progress.

Scopeuploads:write
Side-effectcompute
HTTPPOST /v1/op/uploads.progress · POST /v1/uploads/progress
Python / TypeScriptclient.uploads.progress(…)
CLIgeopera uploads progress …

Request — UploadProgressInput

FieldTypeRequiredDescription
upload_idstringyes
statusstring—
bytes_uploadedinteger—

Response — UploadOutput.

uploads.signed_url

Mint a signed URL for uploading a file into an upload session.

Scopeuploads:write
Side-effectcompute
HTTPPOST /v1/op/uploads.signed_url · POST /v1/uploads/signed_url
Python / TypeScriptclient.uploads.signed_url(…)
CLIgeopera uploads signed-url …

Request — SignedUrlInput

FieldTypeRequiredDescription
upload_idstringyes
file_namestringyes
content_typestring—

Response — SignedUrlOutput.