Get a project's on-screen translation state
curl --request GET \
--url https://api.rask.ai/v3/projects/{project_id}/onscreen \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.rask.ai/v3/projects/{project_id}/onscreen"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.rask.ai/v3/projects/{project_id}/onscreen', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rask.ai/v3/projects/{project_id}/onscreen",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.rask.ai/v3/projects/{project_id}/onscreen"
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(string(body))
}HttpResponse<String> response = Unirest.get("https://api.rask.ai/v3/projects/{project_id}/onscreen")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rask.ai/v3/projects/{project_id}/onscreen")
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{
"object": "onscreen_state",
"id": "6f1c2b7e-8a4d-4e3f-9b5c-1d0a7e2f3c58",
"available": true,
"latest_job": {
"object": "job",
"id": "7e2b5d9f-1c4a-4e8b-b6d3-9f2a5c8e1b47",
"workspace_id": "b2e0c6d4-5b1a-4f7e-9a3c-2d8f1e6a7b90",
"type": "onscreen",
"status": "running",
"progress": 35,
"stage": "translating",
"queue_position": null,
"estimated_finish_at": "2026-11-03T11:01:00Z",
"overdue": false,
"project_id": "6f1c2b7e-8a4d-4e3f-9b5c-1d0a7e2f3c58",
"media_id": null,
"parent_job_id": null,
"channel": "api",
"params": {
"type": "onscreen",
"source_kind": "dubbed",
"ui_language": "en",
"expected_cost_minutes": 2
},
"details": {
"type": "onscreen",
"target_language": "es-es",
"ui_language": "en",
"queue_position": null,
"eta_seconds": 1260,
"attempt": 1,
"activity": [
{
"text": "Found 4 text overlays; translating the title card.",
"at": "2026-11-03T10:05:12Z"
}
],
"draft": {
"number": 1,
"created_at": "2026-11-03T10:09:30Z",
"url": "https://storage.example.com/draft-1.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Signature=3b9f0c",
"download_url": "https://storage.example.com/draft-1.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Signature=3b9f0c&response-content-disposition=attachment",
"expires_at": "2026-11-03T11:15:02Z"
}
},
"stages": null,
"cost": {
"credit_type": "minutes",
"minutes": 2,
"charged": true,
"refunded": false,
"refunded_at": null
},
"result": null,
"error": null,
"created_at": "2026-11-03T09:12:44Z",
"started_at": "2026-11-03T10:01:00Z",
"finished_at": null,
"links": {
"self": "/v3/jobs/7e2b5d9f-1c4a-4e8b-b6d3-9f2a5c8e1b47",
"project": "/v3/projects/6f1c2b7e-8a4d-4e3f-9b5c-1d0a7e2f3c58",
"outputs": null,
"media": null
}
},
"current_result": null,
"auto_start": null
}Onscreen
Get a project's on-screen translation state
Returns whether on-screen translation is available for the project, the latest on-screen job started through v3, the latest successful result from any channel.
GET
/
projects
/
{project_id}
/
onscreen
Get a project's on-screen translation state
curl --request GET \
--url https://api.rask.ai/v3/projects/{project_id}/onscreen \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.rask.ai/v3/projects/{project_id}/onscreen"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.rask.ai/v3/projects/{project_id}/onscreen', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rask.ai/v3/projects/{project_id}/onscreen",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.rask.ai/v3/projects/{project_id}/onscreen"
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(string(body))
}HttpResponse<String> response = Unirest.get("https://api.rask.ai/v3/projects/{project_id}/onscreen")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rask.ai/v3/projects/{project_id}/onscreen")
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{
"object": "onscreen_state",
"id": "6f1c2b7e-8a4d-4e3f-9b5c-1d0a7e2f3c58",
"available": true,
"latest_job": {
"object": "job",
"id": "7e2b5d9f-1c4a-4e8b-b6d3-9f2a5c8e1b47",
"workspace_id": "b2e0c6d4-5b1a-4f7e-9a3c-2d8f1e6a7b90",
"type": "onscreen",
"status": "running",
"progress": 35,
"stage": "translating",
"queue_position": null,
"estimated_finish_at": "2026-11-03T11:01:00Z",
"overdue": false,
"project_id": "6f1c2b7e-8a4d-4e3f-9b5c-1d0a7e2f3c58",
"media_id": null,
"parent_job_id": null,
"channel": "api",
"params": {
"type": "onscreen",
"source_kind": "dubbed",
"ui_language": "en",
"expected_cost_minutes": 2
},
"details": {
"type": "onscreen",
"target_language": "es-es",
"ui_language": "en",
"queue_position": null,
"eta_seconds": 1260,
"attempt": 1,
"activity": [
{
"text": "Found 4 text overlays; translating the title card.",
"at": "2026-11-03T10:05:12Z"
}
],
"draft": {
"number": 1,
"created_at": "2026-11-03T10:09:30Z",
"url": "https://storage.example.com/draft-1.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Signature=3b9f0c",
"download_url": "https://storage.example.com/draft-1.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Signature=3b9f0c&response-content-disposition=attachment",
"expires_at": "2026-11-03T11:15:02Z"
}
},
"stages": null,
"cost": {
"credit_type": "minutes",
"minutes": 2,
"charged": true,
"refunded": false,
"refunded_at": null
},
"result": null,
"error": null,
"created_at": "2026-11-03T09:12:44Z",
"started_at": "2026-11-03T10:01:00Z",
"finished_at": null,
"links": {
"self": "/v3/jobs/7e2b5d9f-1c4a-4e8b-b6d3-9f2a5c8e1b47",
"project": "/v3/projects/6f1c2b7e-8a4d-4e3f-9b5c-1d0a7e2f3c58",
"outputs": null,
"media": null
}
},
"current_result": null,
"auto_start": null
}Returns whether on-screen translation is available for the project, the latest on-screen job started through v3, the latest successful result from any channel (kept even if a newer job failed) and the auto-start state requested at creation (with a rejection shown until a newer job exists).
When to use: to show on-screen status or download the result.
Side effects: None.
Cost: Free.
Idempotency: safe and pure (never writes); retry freely.
Required scopes:
projects:readAuthorizations
API key from Settings -> API keys, sent as Authorization: Bearer <key> (SDK environment variable RASK_API_KEY). Bound to one workspace and one acting user. Operations list the scopes they need (OpenAPI 3.1 scopes on a bearer scheme).
Scopes
projects:read
Path Parameters
Project id (from createProject or listProjects).
Maximum string length:
64Response
OK: OnscreenState.
On-screen translation state of a project.
Always onscreen_state.
Available options:
onscreen_state The project id.
On-screen translation is available for this project now.
Latest on-screen job started through v3; null when there is none or after job retention.
Show child attributes
Show child attributes
Latest done result from any channel; null when there is none.
Show child attributes
Show child attributes
Auto-start requested at creation.
Show child attributes
Show child attributes