API Reference
API Reference

Get Takeout

GET/api/v1/takeouts/get/{job_id}

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

job_id string path required

Responses

200Successful Response

application/json

response TakeoutStatusResponse required
4 fields
job_idstringrequired
statusenum<string>required

Status of a takeout request.

Allowed values ["pending","in_progress","completed","failed","canceled"]
updated_atstring (date-time)required
file_namesstring[] | nulloptional
Item schema
itemsstringrequired
Response example
{
  "job_id": "string",
  "status": "string",
  "updated_at": "string",
  "file_names": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}