> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs-staging.joytokens.ai/llms.txt.

# Get Video Task

GET https://api-staging.joytokens.ai/openai/v1/videos/{task_id}

Returns the current status of a video task (generation or editing). Tasks belong to the API key that created them; querying another key's task returns 403. Task records are kept for 24 hours and return 404 afterwards. Poll every 3~10 seconds until the task reaches a terminal state (completed / failed). When the upstream query is temporarily unreachable, the gateway returns the cached status without blocking task progress. On failure, pre-deducted fees are automatically refunded.


Reference: https://docs-staging.joytokens.ai/open-api/api-reference/compatible-model-ap-is/videos/get-video-task

## Authentication

- `Authorization` header (bearer token, required) — Use `Authorization: Bearer $JOY_TOKEN_API_KEY`.

## Request

### Path parameters

- `task_id` (string, required) — The task id returned by the creation endpoint.

## Response

### 200

Current task status.

- `task_id` (string, required) — Task id.
- `status` (enum, required) — Task state; stop polling once completed or failed.
  - Allowed values: `processing`, `completed`, `failed`
- `model` (string, required) — The actually selected model name.
- `progress` (integer, required) — Progress percentage, 0~100.
- `created` (long, required) — Unix timestamp (seconds) of task creation.
- `result_url` (string, optional) — Present when completed. Upstream result URL, time-limited; download promptly or use GET /openai/v1/videos/\{task\_id}/content.
- `duration` (double, optional) — Present when completed. Actual video length in seconds (may be fractional).
- `completed_at` (long, optional) — Present when completed. Unix timestamp (seconds) of task completion.
- `error` (VideoTaskError, optional)

## Errors

### 401 Unauthorized Error

Missing Authorization header.

- `error` (ErrorResponseError, required)

### 403 Forbidden Error

Querying or downloading a task that belongs to another API key.

- `error` (ErrorResponseError, required)

### 404 Not Found Error

Task id does not exist or has expired (records are kept for 24 hours).

- `error` (ErrorResponseError, required)

### 405 Method Not Allowed Error

A non-GET method was used on the query endpoint.

- `error` (ErrorResponseError, required)

### 503 Service Unavailable Error

Task store temporarily unavailable.

- `error` (ErrorResponseError, required)

## Types

### VideoTaskError

- `message` (string, required) — Failure description.
- `code` (string, required) — Error code, always a string.

### ErrorResponseError

- `message` (string, required)
- `type` (string, optional)
- `code` (ErrorResponseErrorCode, optional, nullable)

### ErrorResponseErrorCode

- string
- integer

## Examples

### Processing

**Response**

```json
{
  "task_id": "vtask-8f3a1c2d9e4b5f6a",
  "status": "processing",
  "model": "Doubao-Seedance-2.5",
  "progress": 45,
  "created": 1760000000
}
```

**SDK Code**

```python Processing
import requests

url = "https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Processing
const url = 'https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Processing
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Processing
require 'uri'
require 'net/http'

url = URI("https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Processing
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Processing
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Processing
using RestSharp;

var client = new RestClient("https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Processing
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Completed

**Response**

```json
{
  "task_id": "vtask-8f3a1c2d9e4b5f6a",
  "status": "completed",
  "model": "Doubao-Seedance-2.5",
  "progress": 100,
  "created": 1760000000,
  "result_url": "https://upstream.example.com/result/abc.mp4",
  "duration": 8,
  "completed_at": 1760000180
}
```

**SDK Code**

```python Completed
import requests

url = "https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Completed
const url = 'https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Completed
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Completed
require 'uri'
require 'net/http'

url = URI("https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Completed
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Completed
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Completed
using RestSharp;

var client = new RestClient("https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Completed
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Failed

**Response**

```json
{
  "task_id": "vtask-8f3a1c2d9e4b5f6a",
  "status": "failed",
  "model": "Doubao-Seedance-2.5",
  "progress": 0,
  "created": 1760000000,
  "error": {
    "message": "content policy violation",
    "code": "40050"
  }
}
```

**SDK Code**

```python Failed
import requests

url = "https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Failed
const url = 'https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Failed
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Failed
require 'uri'
require 'net/http'

url = URI("https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Failed
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Failed
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Failed
using RestSharp;

var client = new RestClient("https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Failed
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-staging.joytokens.ai/openai/v1/videos/vtask-8f3a1c2d9e4b5f6a")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```