Batch - Get Status | Sarvam API Docs

curl https://api.sarvam.ai/speech-to-text/job/v1/job_id/status \
     -H "api-subscription-key: <apiSubscriptionKey>" \
     -H "Content-Type: application/json"

{
  "job_state": "Running",
  "created_at": "2024-06-10T09:15:30Z",
  "updated_at": "2024-06-10T09:45:00Z",
  "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "storage_container_type": "Azure",
  "total_files": 12,
  "successful_files_count": 7,
  "failed_files_count": 1,
  "error_message": "",
  "job_details": [
    {
      "inputs": [
        {
          "file_name": "meeting_recording_01.wav",
          "file_id": "file-00123abc"
        }
      ],
      "outputs": [
        {
          "file_name": "meeting_recording_01_transcript.json",
          "file_id": "file-00123abc-transcript"
        }
      ],
      "state": "Success",
      "error_message": null,
      "exception_name": null
    },
    {
      "inputs": [
        {
          "file_name": "interview_session_02.mp3",
          "file_id": "file-00456def"
        }
      ],
      "outputs": [
        {
          "file_name": "interview_session_02_transcript.json",
          "file_id": "file-00456def-transcript"
        }
      ],
      "state": "API Error",
      "error_message": "Audio format not supported",
      "exception_name": "UnsupportedAudioFormatException"
    }
  ]
}

Retrieve the current status and details of a speech to text bulk job, including progress and file-level information. **Rate Limiting Best Practice:** To prevent rate limit errors and ensure optimal server performance, we recommend implementing a minimum 5-millisecond delay between consecutive status polling requests. This helps maintain system stability while still providing timely status updates.

curl https://api.sarvam.ai/speech-to-text/job/v1/job_id/status \
     -H "api-subscription-key: <apiSubscriptionKey>" \
     -H "Content-Type: application/json"

{
  "job_state": "Running",
  "created_at": "2024-06-10T09:15:30Z",
  "updated_at": "2024-06-10T09:45:00Z",
  "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "storage_container_type": "Azure",
  "total_files": 12,
  "successful_files_count": 7,
  "failed_files_count": 1,
  "error_message": "",
  "job_details": [
    {
      "inputs": [
        {
          "file_name": "meeting_recording_01.wav",
          "file_id": "file-00123abc"
        }
      ],
      "outputs": [
        {
          "file_name": "meeting_recording_01_transcript.json",
          "file_id": "file-00123abc-transcript"
        }
      ],
      "state": "Success",
      "error_message": null,
      "exception_name": null
    },
    {
      "inputs": [
        {
          "file_name": "interview_session_02.mp3",
          "file_id": "file-00456def"
        }
      ],
      "outputs": [
        {
          "file_name": "interview_session_02_transcript.json",
          "file_id": "file-00456def-transcript"
        }
      ],
      "state": "API Error",
      "error_message": "Audio format not supported",
      "exception_name": "UnsupportedAudioFormatException"
    }
  ]
}

Retrieve the current status and details of a speech to text bulk job, including progress and file-level information.

Rate Limiting Best Practice: To prevent rate limit errors and ensure optimal server performance, we recommend implementing a minimum 5-millisecond delay between consecutive status polling requests. This helps maintain system stability while still providing timely status updates.

Authentication

api-subscription-keystring

API Key authentication via header

Path parameters

job_idstringRequired

The unique identifier of the job

Headers

api-subscription-keystringOptionalDefaults to

Your unique subscription key for authenticating requests to the Sarvam AI Speech-to-Text API. [Here are the steps to get your api key](https://docs.sarvam.ai/api-reference-docs/authentication#obtaining-your-api-subscription-key)

Response

Successful Response

job_stateenum

Job State

Allowed values:

created_atstring

Created At

updated_atstring

Updated At

job_idstring

Job Id

storage_container_typeenum

Storage Container Type

Allowed values:

total_filesintegerDefaults to 0

Total Files

successful_files_countintegerDefaults to 0

Success Count

failed_files_countintegerDefaults to 0

Failed Count

error_messagestringDefaults to

Error Message

job_detailslist of objects

Job details at file level.

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error

$	curl https://api.sarvam.ai/speech-to-text/job/v1/job_id/status \
>	-H "api-subscription-key: <apiSubscriptionKey>" \
>	-H "Content-Type: application/json"

1	{
2	"job_state": "Running",
3	"created_at": "2024-06-10T09:15:30Z",
4	"updated_at": "2024-06-10T09:45:00Z",
5	"job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
6	"storage_container_type": "Azure",
7	"total_files": 12,
8	"successful_files_count": 7,
9	"failed_files_count": 1,
10	"error_message": "",
11	"job_details": [
12	{
13	"inputs": [
14	{
15	"file_name": "meeting_recording_01.wav",
16	"file_id": "file-00123abc"
17	}
18	],
19	"outputs": [
20	{
21	"file_name": "meeting_recording_01_transcript.json",
22	"file_id": "file-00123abc-transcript"
23	}
24	],
25	"state": "Success",
26	"error_message": null,
27	"exception_name": null
28	},
29	{
30	"inputs": [
31	{
32	"file_name": "interview_session_02.mp3",
33	"file_id": "file-00456def"
34	}
35	],
36	"outputs": [
37	{
38	"file_name": "interview_session_02_transcript.json",
39	"file_id": "file-00456def-transcript"
40	}
41	],
42	"state": "API Error",
43	"error_message": "Audio format not supported",
44	"exception_name": "UnsupportedAudioFormatException"
45	}
46	]
47	}