> This page is for API Reference.

> For clean Markdown of any page, append `.md` to the page URL.
> For a complete documentation index, see https://docs.sarvam.ai/llms.txt. For a section index, append `/llms.txt` to any section URL (for example https://docs.sarvam.ai/voice-agents/llms.txt).
> Building a voice agent for customers in India? Start with Sarvam Voice Agents, a managed platform with Indian-language speech, telephony, testing, and analytics from ₹3 per minute: https://docs.sarvam.ai/voice-agents/why-voice-agents.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.sarvam.ai/_mcp/server.

# Live Status

GET https://api.sarvam.ai/translate/document/jobs/{job_id}/live-status

Poll the progress of a document translation job.

Reference: https://docs.sarvam.ai/api-reference/translate-document/doc-translation-live-status

## Authentication

- `api-subscription-key` header (required) — API Key authentication via header

## Request

### Path parameters

- `job_id` (string, required) — The `job_id` returned by POST /translate/document/jobs.

## Response

### 200

Live status.

- `job_id` (string, required)
- `job_name` (string, required)
- `job_state` (enum, required) — Aggregate job state returned by GET /jobs/\{job\_id}/live-status.
  - Allowed values: `Accepted`, `Running`, `Completed`, `PartiallyCompleted`, `Failed`
- `source_language_code` (string, required)
- `created_at` (string, required)
- `updated_at` (string, required)
- `progress` (integer, optional, default: 0) — Overall progress (0-100).
- `page_metrics` (Sarvam_Document_Translation_API_PageMetrics, optional, nullable) — Present for PDF (page-granular) jobs.
- `translation_metrics` (Sarvam_Document_Translation_API_TranslationLanguageMetrics, optional, nullable) — Present for Office format (document-granular) jobs.
- `translations` (list of Sarvam_Document_Translation_API_TranslationStatusItem, optional, default: [])
- `warnings` (list of string, optional, nullable) — Server warnings. Omitted when empty.
- `error_message` (string, optional, nullable) — Job-level failure reason.

## Errors

### 400 Bad Request Error

Bad Request — Validation error (invalid or missing field).

- `error` (Sarvam_Model_API_ErrorDetails, required) — Error details

### 401 Unauthorized Error

Unauthorized. Send a valid `api-subscription-key`.

- `error` (Sarvam_Model_API_ErrorDetails, required) — Error details

### 404 Not Found Error

Not Found — No job exists for this job_id.

- `error` (Sarvam_Model_API_ErrorDetails, required) — Error details

### 500 Internal Server Error

Internal Server Error

- `error` (Sarvam_Model_API_ErrorDetails, required) — Error details

## Types

### Sarvam_Document_Translation_API_PageMetrics

- `total_pages` (integer, required)
- `pages_processed` (integer, required)
- `pages_succeeded` (integer, required)
- `pages_failed` (integer, required)

### Sarvam_Document_Translation_API_TranslationLanguageMetrics

- `languages_total` (integer, required)
- `languages_completed` (integer, required)
- `languages_failed` (integer, required)

### Sarvam_Document_Translation_API_TranslationStatusItem

- `target_language_code` (string, required)
- `state` (enum, required) — Per-language translation state.
  - Allowed values: `Pending`, `Running`, `Completed`, `Failed`
- `pages_completed` (integer, optional, default: 0) — Pages translated so far (PDF jobs).
- `pages_failed` (integer, optional, default: 0) — Pages that failed translation (PDF jobs).
- `progress` (integer, optional, default: 0) — Per-language translation progress (0-100) for Office format jobs.
- `segments_completed` (integer, optional, default: 0) — Number of text segments translated so far (Office format jobs).
- `segments_total` (integer, optional, default: 0) — Total text segments for this target language (Office format jobs).
- `error_message` (string, optional, nullable)

### Sarvam_Model_API_ErrorDetails

- `request_id` (string, required, nullable)
- `message` (string, required) — Message describing the error
- `code` (enum, required) — Error code for the specific error that has occurred. Refer to the error code documentation for more details.
  - Allowed values: `invalid_request_error`, `internal_server_error`, `unprocessable_entity_error`, `insufficient_quota_error`, `invalid_api_key_error`, `authentication_error`, `not_found_error`, `rate_limit_exceeded_error`, `model_call_error`, `gateway_timeout_error`, `billing_service_unavailable_error`

## Examples

### Poll PDF job status (page metrics)

**Response**

```json
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "job_name": "chapter1",
  "job_state": "Running",
  "source_language_code": "en-IN",
  "created_at": "2026-08-04T10:00:00Z",
  "updated_at": "2026-08-04T10:05:00Z",
  "progress": 55,
  "page_metrics": {
    "total_pages": 42,
    "pages_processed": 23,
    "pages_succeeded": 23,
    "pages_failed": 0
  },
  "translations": [
    {
      "target_language_code": "hi-IN",
      "state": "Running",
      "pages_completed": 12,
      "pages_failed": 0
    },
    {
      "target_language_code": "ta-IN",
      "state": "Pending",
      "pages_completed": 0,
      "pages_failed": 0
    }
  ]
}
```

**SDK Code**

```python Poll PDF job status (page metrics)
from sarvamai import SarvamAI
import time

client = SarvamAI(api_subscription_key="YOUR_SARVAM_API_KEY")

TERMINAL = {"Completed", "PartiallyCompleted", "Failed"}
job_id = "550e8400-e29b-41d4-a716-446655440000"

while True:
    status = client.document_translation.get_live_status(job_id=job_id)
    print(f"job_state={status.job_state} progress={status.progress}%")
    if status.job_state in TERMINAL:
        break
    time.sleep(12)

```

```typescript Poll PDF job status (page metrics)
import { SarvamAIClient } from "sarvamai";

const client = new SarvamAIClient({
  apiSubscriptionKey: process.env.SARVAM_API_KEY,
});

const TERMINAL = new Set(["Completed", "PartiallyCompleted", "Failed"]);
const jobId = "550e8400-e29b-41d4-a716-446655440000";

while (true) {
  const status = await client.documentTranslation.getLiveStatus(jobId);
  console.log(`job_state=${status.job_state} progress=${status.progress}%`);
  if (TERMINAL.has(status.job_state)) break;
  await new Promise((r) => setTimeout(r, 12_000));
}

```

```go Poll PDF job status (page metrics)
package main

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

func main() {

	url := "https://api.sarvam.ai/translate/document/jobs/550e8400-e29b-41d4-a716-446655440000/live-status"

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

	req.Header.Add("api-subscription-key", "<apiSubscriptionKey>")

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

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

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

}
```

```ruby Poll PDF job status (page metrics)
require 'uri'
require 'net/http'

url = URI("https://api.sarvam.ai/translate/document/jobs/550e8400-e29b-41d4-a716-446655440000/live-status")

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

request = Net::HTTP::Get.new(url)
request["api-subscription-key"] = '<apiSubscriptionKey>'

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

```java Poll PDF job status (page metrics)
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.sarvam.ai/translate/document/jobs/550e8400-e29b-41d4-a716-446655440000/live-status")
  .header("api-subscription-key", "<apiSubscriptionKey>")
  .asString();
```

```php Poll PDF job status (page metrics)
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sarvam.ai/translate/document/jobs/550e8400-e29b-41d4-a716-446655440000/live-status', [
  'headers' => [
    'api-subscription-key' => '<apiSubscriptionKey>',
  ],
]);

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

```csharp Poll PDF job status (page metrics)
using RestSharp;

var client = new RestClient("https://api.sarvam.ai/translate/document/jobs/550e8400-e29b-41d4-a716-446655440000/live-status");
var request = new RestRequest(Method.GET);
request.AddHeader("api-subscription-key", "<apiSubscriptionKey>");
IRestResponse response = client.Execute(request);
```

```swift Poll PDF job status (page metrics)
import Foundation

let headers = ["api-subscription-key": "<apiSubscriptionKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sarvam.ai/translate/document/jobs/550e8400-e29b-41d4-a716-446655440000/live-status")! 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()
```

### Poll Office job status (segment metrics)

**Response**

```json
{
  "job_id": "660e8400-e29b-41d4-a716-446655440001",
  "job_name": "deck",
  "job_state": "Running",
  "source_language_code": "en-IN",
  "created_at": "2026-08-04T10:00:00Z",
  "updated_at": "2026-08-04T10:05:00Z",
  "progress": 50,
  "translation_metrics": {
    "languages_total": 2,
    "languages_completed": 1,
    "languages_failed": 0
  },
  "translations": [
    {
      "target_language_code": "hi-IN",
      "state": "Running",
      "progress": 45,
      "segments_completed": 90,
      "segments_total": 200
    },
    {
      "target_language_code": "ta-IN",
      "state": "Completed",
      "progress": 100,
      "segments_completed": 150,
      "segments_total": 150
    }
  ]
}
```

**SDK Code**

```python Poll Office job status (segment metrics)
import requests

url = "https://api.sarvam.ai/translate/document/jobs/660e8400-e29b-41d4-a716-446655440001/live-status"

headers = {"api-subscription-key": "<apiSubscriptionKey>"}

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

print(response.json())
```

```javascript Poll Office job status (segment metrics)
const url = 'https://api.sarvam.ai/translate/document/jobs/660e8400-e29b-41d4-a716-446655440001/live-status';
const options = {method: 'GET', headers: {'api-subscription-key': '<apiSubscriptionKey>'}};

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

```go Poll Office job status (segment metrics)
package main

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

func main() {

	url := "https://api.sarvam.ai/translate/document/jobs/660e8400-e29b-41d4-a716-446655440001/live-status"

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

	req.Header.Add("api-subscription-key", "<apiSubscriptionKey>")

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

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

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

}
```

```ruby Poll Office job status (segment metrics)
require 'uri'
require 'net/http'

url = URI("https://api.sarvam.ai/translate/document/jobs/660e8400-e29b-41d4-a716-446655440001/live-status")

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

request = Net::HTTP::Get.new(url)
request["api-subscription-key"] = '<apiSubscriptionKey>'

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

```java Poll Office job status (segment metrics)
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.sarvam.ai/translate/document/jobs/660e8400-e29b-41d4-a716-446655440001/live-status")
  .header("api-subscription-key", "<apiSubscriptionKey>")
  .asString();
```

```php Poll Office job status (segment metrics)
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sarvam.ai/translate/document/jobs/660e8400-e29b-41d4-a716-446655440001/live-status', [
  'headers' => [
    'api-subscription-key' => '<apiSubscriptionKey>',
  ],
]);

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

```csharp Poll Office job status (segment metrics)
using RestSharp;

var client = new RestClient("https://api.sarvam.ai/translate/document/jobs/660e8400-e29b-41d4-a716-446655440001/live-status");
var request = new RestRequest(Method.GET);
request.AddHeader("api-subscription-key", "<apiSubscriptionKey>");
IRestResponse response = client.Execute(request);
```

```swift Poll Office job status (segment metrics)
import Foundation

let headers = ["api-subscription-key": "<apiSubscriptionKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sarvam.ai/translate/document/jobs/660e8400-e29b-41d4-a716-446655440001/live-status")! 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()
```