Get profile by profile id

GET 
/bv/configuration/v1/profiles/:id

Fetches the Profile resource using the specified id.

---

Required field(s):

• id

---

Request

Path Parameters

id stringrequired

Required. The resource identifier of profile.

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.

Responses

200

A successful response.

application/json

Schema

Schema

profile object

id string

Output only. The resource identifier of profile.

name string

Input only. The name of profile.

video_codec - VIDEO_CODEC_H264: VIDEO_CODEC_H264 Indicates video code H.264 - VIDEO_CODEC_H265: VIDEO_CODEC_H265 Indicates video code H.265 (string)

Possible values: [VIDEO_CODEC_H264, VIDEO_CODEC_H265]

Input only. The video codec.

video_width int32

Input only. The video width in pixels.

video_height int32

Input only. The video height in pixels.

video_bitrate int64

Input only. The video bitrate.

audio_bitrate int64

Input only. The audio bitrate.

codec_profile string

Possible values: [CODEC_PROFILE_AUTO, CODEC_PROFILE_BASELINE, CODEC_PROFILE_MAIN, CODEC_PROFILE_HIGH, CODEC_PROFILE_MAIN10]

Input only. H.264/H.265 codec profile.

level string

Possible values: [CODEC_PROFILE_LEVEL_AUTO, CODEC_PROFILE_LEVEL_1, CODEC_PROFILE_LEVEL_1_1, CODEC_PROFILE_LEVEL_1_2, CODEC_PROFILE_LEVEL_1_3, CODEC_PROFILE_LEVEL_2, CODEC_PROFILE_LEVEL_2_1, CODEC_PROFILE_LEVEL_2_2, CODEC_PROFILE_LEVEL_3, CODEC_PROFILE_LEVEL_3_1, CODEC_PROFILE_LEVEL_3_2, CODEC_PROFILE_LEVEL_4, CODEC_PROFILE_LEVEL_4_1, CODEC_PROFILE_LEVEL_4_2, CODEC_PROFILE_LEVEL_5, CODEC_PROFILE_LEVEL_5_1, CODEC_PROFILE_LEVEL_5_2, CODEC_PROFILE_LEVEL_6]

Input only. Specify level for H.264/H.265.

b_frame boolean

Input only. Enable/Disable B-frame.

frame_rate string

Possible values: [FRAME_RATE_10, FRAME_RATE_15, FRAME_RATE_23_97, FRAME_RATE_24, FRAME_RATE_25, FRAME_RATE_29_97, FRAME_RATE_30, FRAME_RATE_50, FRAME_RATE_59_94, FRAME_RATE_60, FRAME_RATE_SOURCE]

Input only. The video frame rate.

gop_size int32

Input only. GOP size (keyframe interval) in seconds.

segment_duration int32

Input only. Length of video duration for each segment package in seconds.

preset Output only. Preset is system or custom (boolean)

standard Output only. Standard is sd|hd|fhd|4k (string)

Possible values: [RESOLUTION_TYPE_SD, RESOLUTION_TYPE_HD, RESOLUTION_TYPE_FHD, RESOLUTION_TYPE_4K]

Example (from schema)

{
  "profile": {
    "audio_bitrate": "24",
    "b_frame": true,
    "codec_profile": "CODEC_PROFILE_AUTO",
    "frame_rate": "FRAME_RATE_SOURCE",
    "gop_size": 2,
    "id": "e9f5ca1c-1d38-4baf-9527-96fde619f496",
    "level": "CODEC_PROFILE_LEVEL_AUTO",
    "name": "test",
    "preset": false,
    "segment_duration": 6,
    "standard": "RESOLUTION_TYPE_SD",
    "video_bitrate": "60",
    "video_codec": "VIDEO_CODEC_H264",
    "video_height": 800,
    "video_width": 800
  }
}

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...