Skip to main content
POST
Upload raw content to Google Drive asynchronously

Authorizations

Authorization
string
header
required

IDM-issued JWT. Obtain via the IDM authentication flow and pass as: Bearer

Headers

X-ActionId
string
default:""

A logging ID of the request. It is propagated through Phrase systems, making it easier to connect logs from various services. If no ActionId is sent with a request, one will be generated by Bifrost and returned with the response.

X-Webhook
string
default:""
required

Required on /async/... endpoints. Bifrost POSTs the operation result to this URL once the connector finishes processing. Omitting this header on an async endpoint returns 400.

Body

application/json

Request payload for uploading raw content to Google Drive.

When X-Upload-Mode=STORAGE, storageId refers to content previously persisted in the connector's file storage. When X-Upload-Mode=STREAM, storageId must be omitted and the request registers a stream ticket. If X-Upload-Mode is omitted, STORAGE is used. For async uploads, storageId is required.

The path defines the Drive location where the file should be created or updated.

connectorUuid
string
default:""
required

UUID of a configured connector that holds stored Google Drive credentials.

Example:

"b9c06f76-4a44-4d2e-8a26-3d1e4b47e123"

configuration
any
default:""

Connector configuration for this request. Currently unused, but reserved for future configuration flags.

Example:
path
object
locale
string
default:""

Locale code associated with the raw content being uploaded, if applicable. Optional. Use a BCP 47 or Phrase locale code (for example, "en", "de", "cs").

Example:

"en"

storageId
string
default:""

Storage ID of the raw file to upload to Google Drive. Must reference content previously stored in the connector's file storage.

Required when X-Upload-Mode=STORAGE. Must be omitted when X-Upload-Mode=STREAM.

Example:

"fs_5f1d2a4c-0e89-4af7-9e4b-3b4a2d1e9c01"

name
string
default:""

Name of the file to be uploaded. Used in STREAM mode.

Example:

"large_file.zip"

size
integer<int64>
default:""

Size of the file in bytes. Used in STREAM mode.

Example:

10857600

{key}
any

Response

Successful operation. If X-ResponseType is set to 'ID' or no value is sent in the header, the file is saved and can be retrieved by sending a GET request to this endpoint. If X-ResponseType is set to 'OBJECT', the file is returned as a stream.

webhookUrl
string
default:""

Webhook URL you supplied in the request

requestId
string
default:""

Request ID you can use to retrieve the result

{key}
any