Skip to main content
POST

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-Upload-Mode
enum<string>
default:STORAGE

Controls how the upload payload is delivered to the connector.

  • STORAGE (default): the request body references a file already in Phrase file storage by storageId. The connector pulls the bytes itself.
  • STREAM: initialize a two-phase streaming upload. Phase 1 returns a relative uploadUrl, an X-Stream-Token, and an expiresAt timestamp. Phase 2 PUTs the raw bytes to that URL with the matching X-Stream-Token and a Content-Type reflecting the file. STREAM mode is currently supported by Google Drive. Other connectors ignore the header and behave as STORAGE.
Available options:
STORAGE,
STREAM

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

STREAM mode — streaming upload session initialized. The response carries uploadUrl, streamToken, expiresAt, and maxBytes. PUT the raw bytes to uploadUrl with header X-Stream-Token: <streamToken> before expiresAt.

Response for a registered streaming upload.

uploadUrl
string
default:""

Publicly reachable URL for the data plane (Step 2).

streamToken
string
default:""

One-time stream token for authentication in Step 2.

expiresAt
string<date-time>
default:""

Timestamp when the stream token expires.

maxBytes
integer<int64>
default:""

Maximum allowed payload size in bytes.

{key}
any