Download file

POST 
/bv/cms/v1/library/files/:id:download

Provides the download link and its expiration time for a specified file. Ensure the id parameter is provided to identify the target file.

---

Required field(s):

• id

---

Request

Path Parameters

id stringrequired

Required. The unique id of the file.

Header Parameters

x-bv-org-id stringrequired

To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.

application/json

Body

required

content_disposition Optional. The content disposition of the download uri. Default: CONTENT_DISPOSITION_ATTACHMENT (string)

Possible values: [CONTENT_DISPOSITION_ATTACHMENT, CONTENT_DISPOSITION_INLINE]

Responses

200

A successful response.

application/json

Schema

Schema

id string

The unique identifier of the file.

download_uri string

The URI that can be used to download the file.

download_filename string

The original name that of the file.

expiration_time date-time

Indicating until when the download uri will be valid

Example (from schema)

{
  "download_filename": "bbb.mp4",
  "download_uri": "https://kks-platform-orbit-content-store-dev.s3.ap-northeast-1.amazonaws.com/42f6c33e-f632-44e5-8042-05abb5fa2223/video/3aabf3ce-9bf8-4dba-bc8b-274ffbf9e328/3aabf3ce-9bf8-4dba-bc8b-274ffbf9e328.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAX2E7FTDHKGGDCDJQ%2F20230605%2Fap-northeast-1%2Fs3%2Faws4_request&X-Amz-Date=20230605T064205Z&X-Amz-Expires=86400&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEN7%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDmFwLW5vcnRoZWFzdC0xIkYwRAIgNu3YMuJ6uc%2FJruKiidRkpZYaKmncu5FCTuiDaXlUpxkCIHVozC2wgJ2c%2FKrI6oY1rpWvVyw7qagzbZIKogL%2B3Nl2KoIFCCcQABoMNTM3MjA0NzI1OTY2Igy1wqCc0on8ijL7Bmcq3wRGN07HslpaTfEloTQG7fnZbRTakABjXRsUczdjT%2Be6NRpxMbBKts0w0cIozcYtNZ2EBx41WcxKsD%2B6HIQbCsGOWRVhMWd23KnpHx0Y4xUttm8kHxNCmfOO%2FfmKWkzmlr4YbKty80urraJrWPnGfxRdZO3YwPaitQHZCJu9khonzDUtKkw27jPM1YxTulWoMh9GCrzhauNJP1Vq%2FUJDg%2BFNfQKls6XGA%2FZ0iFZzcZX8ZNoeIpvY6SLY7ocfzghljMYQCY3wPHUlP641owEXg%2BQWGVVFzdlQaM8sgQtbZAyPSVKT2306g12%2FppEBW9fxfto9i4GRptda%2F55a1%2Fn68JonfAUgJclxVgBK5T9hhtwe8kDWOuDMBQimtKm7zc2EO28lmMD0cMjp%2BwXtyllxd7C8H8zcOMnEUMrCycWuwQDYBFsLCrS3Tprcvw65mLxjrB%2FfyLSkwZrfTG3pGFVnCR3hGsBWM67QFMjpzRyarUo9nzcWPNtk77DxvKM3cE4PmcL%2FxPsE4pWuUFbo5xpzKdTZvmUDX8IdYb2KNQHvVrLqnvuwYru%2FtlXYD2W5DQsu7EmIOZdW%2Fow0zg%2B2IjzZzqlhWZUlLKzf6OJULSpZEYo59H12ybV4Mz7mfGdiMe74j4Sli0PSk8%2BQPTZJHSA3WlQQCdT%2FZ94IYX6tBjA0MSP28CjAjS82im2RcET%2BXMTF0yo2rzTohw8zSFjhvPmfV7KoN%2BlNrUSiAz5Aj3MxdhwViXz%2F3WDFbTp9Qp8bVn2FqhbBLiwGJRJHy2WbuHdnycJNrbQR0tW%2FEPybOcnGnWQOMIzv9aMGOpsBNd0A5xN%2BeKE%2FAzQ8KL1X%2BmMkqCv1z3Nhv1tmZcQJEF0BhSZfIWSCfOq9I3jAt4Hi5yZRNt3tj4n39IHUu6VXSUZqZdw2FgY5A9PTLN%2Fhj538d%2BrXLL85mlA8RaDO96dqZEN9G0mhePMZWx1zeLY123UUgUmudYLWkPFAxK6TMhx6GGuXtOgNEncRjE9DH5CiCAE9udmpzYcOLrE%3D&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=946bbe3bdaa6e0ecff9279cb3db2f304e8b2b1a6b7595bc85a02bc14312610c5",
  "expiration_time": "2023-06-06T06:42:05.381265582Z",
  "id": "63df97e3-519b-4426-bf01-d1841cdc2ccd"
}

400

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

401

A unauthenticated response. The header authorization was missing or unidentified.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

403

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

500

A server error response. There are more HTTP status code mappings listed on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...