| external help file | PSOpenAI-help.xml |
|---|---|
| Module Name | PSOpenAI |
| online version | https://github.com/mkht/PSOpenAI/blob/main/Docs/Get-Video.md |
| schema | 2.0.0 |
Retrieves one or more video generation jobs.
Get-Video
[-VideoId] <String>
[-TimeoutSec <Int32>]
[-MaxRetryCount <Int32>]
[-ApiBase <Uri>]
[-ApiKey <SecureString>]
[-Organization <String>]
[<CommonParameters>]
Get-Video
[-All]
[-Limit <Int32>]
[-Order <String>]
[-TimeoutSec <Int32>]
[-MaxRetryCount <Int32>]
[-ApiBase <Uri>]
[-ApiKey <SecureString>]
[-Organization <String>]
[<CommonParameters>]
Retrieves a specific video generation job or lists recent jobs. Use the job metadata to track progress or to download video content once processing finishes.
PS C:\> Get-Video -VideoId 'video_fb4e'Gets the job details for the specified video ID.
PS C:\> Get-Video -Limit 5 -Order descLists the five most recent video jobs.
PS C:\> Get-Video -AllLists all available video jobs by paging through the API.
The identifier of the video to retrieve.
Type: String
Parameter Sets: Get
Aliases: video_id, Id
Required: True
Position: 0
Accept pipeline input: True (ByPropertyName, ByValue)A number of items to retrieve. Limit can range between 1 and 100, and the default is 20.
Type: Int32
Parameter Sets: List
Required: False
Position: Named
Default value: 20Sort order by the created timestamp of the objects. asc for ascending order and desc for descending order. The default is asc.
Type: String
Parameter Sets: List
Accepted values: asc, desc
Required: False
Position: Named
Default value: ascWhen this switch is specified, all video jobs will be retrieved.
Type: SwitchParameter
Parameter Sets: List
Required: False
Position: NamedSpecifies how long the request can be pending before it times out.
The default value is 0 (infinite).
Type: Int32
Required: False
Position: Named
Default value: 0Number between 0 and 100.
Specifies the maximum number of retries if the request fails.
The default value is 0 (No retry).
Note : Retries will only be performed if the request fails with a 429 (Rate limit reached) or 5xx (Server side errors) error. Other errors (e.g., authentication failure) will not be performed.
Type: Int32
Required: False
Position: Named
Default value: 0Specifies an API endpoint URL such like: https://your-api-endpoint.test/v1
If not specified, it will use https://api.openai.com/v1
Type: System.Uri
Required: False
Position: Named
Default value: https://api.openai.com/v1Specifies API key for authentication.
The type of data should [string] or [securestring].
If not specified, it will try to use $global:OPENAI_API_KEY or $env:OPENAI_API_KEY
Type: Object
Required: False
Position: NamedSpecifies Organization ID which used for an API request.
If not specified, it will try to use $global:OPENAI_ORGANIZATION or $env:OPENAI_ORGANIZATION
Type: string
Aliases: OrgId
Required: False
Position: Namedhttps://platform.openai.com/docs/api-reference/videos/retrieve https://platform.openai.com/docs/api-reference/videos/list