Skip to content

Upload source file

POST
/v1/uploads

Stream a file (a book to translate) straight into storage and get back an uploadKey. Pass that key to POST /projects to create a project from it. Keeping the upload separate from project creation keeps the large binary off the JSON create call and lets your client show upload progress.

Authorizations

Bearer

JWT bearer token from POST /v1/auth/login.

Type
HTTP (bearer)
or
ApiKey

Scoped API key for non-interactive clients (issued by PBI #1426).

Type
API Key (header: X-Api-Key)

Request Body

multipart/form-data
Format"binary"

Responses

OK

application/json

Success body for POST /uploads.

The uploaded file's sanitized name.

The uploaded file's size, in bytes.

Format"int64"
Pattern"^-?(?:0|[1-9]\\d*)$"

Pass this to POST /projects as uploadKey to create a project
from this file.

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI