getOutputFileUrl

The getOutputFileUrl endpoint generates a signed URL for downloading a processed output (audio or video) by file ID. This endpoint requires authentication.

Endpoint

POST/api/v1/getOutputFileUrl

Authentication

Bearer token required. Include Authorization: Bearer <token>.

Request Body

The request body must be a JSON object with the following structure:

{
  "fileId": "file-abc123"
}

Request Parameters

Parameter	Type	Required	Description
fileId	string	Yes	File ID to generate a download URL for.

Response

Success Response (200)

200Success

Returns a signed download URL:

{
  "url": "https://storage.example.com/file?signature=...",
  "expiry": 1234567890
}

Response Fields

Field	Type	Description
url	string	Signed URL for downloading the processed output.
expiry	integer	Unix timestamp when the download URL expires.

Error Responses

400Bad Request

Returns a ValidationErrorResponse if the request validation fails.

401Unauthorized

Returns an OperationMessage if authentication fails.

403Forbidden

Returns an OperationMessage if access is denied.

Example Request

Example Request

{
  "fileId": "file-abc123"
}

cURL Example

cURL Example

API_BASE_URL="<api-base-url>"
ACCESS_TOKEN="<access_token>"

curl -s -X POST "$API_BASE_URL/api/v1/getOutputFileUrl" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
  "fileId": "file-abc123"
}'

Notes

• This endpoint returns a processed output for the provided file ID (audio files return the processed audio; video files return the processed video).
• The signed URL is time-limited and should be used promptly.