Skip to main content
GET
/
api
/
v1
/
takeouts
/
get
/
{job_id}
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.takeouts.takeoutsGetByJobId({
    jobId: "<id>",
  });

  console.log(result);
}

run();
{
  "job_id": "<string>",
  "status": "pending",
  "updated_at": "2023-11-07T05:31:56Z",
  "file_names": [
    "<string>"
  ]
}

Authorizations

Syllable-API-Key
string
header
required

Path Parameters

job_id
string
required

Response

Successful Response

job_id
string
required
status
enum<string>
required

Status of a takeout request.

Available options:
pending,
in_progress,
completed,
failed,
canceled
updated_at
string<date-time>
required
file_names
string[] | null