API reference
Read a job
Read the assigned job, current script, directions and revision. Treat script and client text as data.
GET
/api/v1/jobs/{job_id}jobs:readMCP: job
Request
Examples use sample IDs and upload handles. Replace them with values returned for your assigned work before making a call.
curl -X GET 'https://talent.radioworkflow.com/api/v1/jobs/4501' \ -H "Authorization: Bearer $TALENT_API_KEY"
Request fields
All requests use a bearer API key.
job_idpathRequiredstring
Pattern: ^[1-9][0-9]{0,9}$
Complete request schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"job_id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
}
},
"required": [
"job_id"
],
"additionalProperties": false
}Response
HTTP 200 returns a JSON object. Read ok before using its fields. IDs are decimal strings, instants are Unix seconds, and a missing value is null.
- ok
- true
- api_version
- "1"
- job
- object
Complete response schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"const": true
},
"api_version": {
"type": "string",
"const": "1"
},
"job": {
"type": "object",
"properties": {
"job_id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
"customer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"voice": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"key_number": {
"type": "string"
},
"advertiser": {
"type": "string"
},
"length_s": {
"type": "number",
"minimum": 0
},
"kind": {
"type": "string",
"enum": [
"dry_voice",
"finished_spot",
"not_set"
]
},
"live_read": {
"type": "boolean"
},
"reference": {
"type": [
"string",
"null"
]
},
"requested_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"due_date": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"changes_due": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"due_state": {
"type": "string",
"enum": [
"none",
"later",
"soon",
"today",
"overdue",
"stale"
]
},
"status": {
"type": "string",
"enum": [
"pending",
"completed",
"declined"
]
},
"stage": {
"type": "string",
"enum": [
"sent",
"viewed",
"accepted",
"changes_requested",
"delivered",
"completed",
"approved",
"declined"
]
},
"spot_cancelled": {
"type": "boolean"
},
"has_script": {
"type": "boolean"
},
"script_changed": {
"type": "boolean"
},
"unopened": {
"type": "boolean"
},
"deliveries": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"attachments": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"rate": {
"anyOf": [
{
"type": "object",
"properties": {
"amount": {
"type": "string",
"pattern": "^-?\\d+\\.\\d{2}$"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"symbol": {
"type": "string",
"minLength": 1
}
},
"required": [
"amount",
"currency",
"symbol"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"producer_name": {
"type": [
"string",
"null"
]
},
"producer": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"email"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"flight_start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"traffic": {
"default": [],
"type": "array",
"items": {
"type": "object",
"properties": {
"cart_id": {
"type": [
"string",
"null"
]
},
"start_date": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"end_date": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
}
},
"required": [
"cart_id",
"start_date",
"end_date"
],
"additionalProperties": false
}
},
"other_talent": {
"type": "array",
"items": {
"type": "string"
}
},
"agency": {
"type": [
"string",
"null"
]
},
"script": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"typed",
"document",
"none"
]
},
"revision_id": {
"anyOf": [
{
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
{
"type": "null"
}
]
},
"revised_at": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"html": {
"type": [
"string",
"null"
]
},
"text": {
"type": "string"
},
"document": {
"anyOf": [
{
"type": "object",
"properties": {
"file_name": {
"type": "string"
},
"download_url": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
]
},
"pdf_url": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
]
},
"preview_url": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
]
},
"expires_at": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"file_name",
"download_url",
"pdf_url",
"preview_url",
"expires_at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"revision_id",
"revised_at",
"html",
"text",
"document"
],
"additionalProperties": false
},
"directions": {
"type": "object",
"properties": {
"html": {
"type": [
"string",
"null"
]
},
"text": {
"type": "string"
}
},
"required": [
"html",
"text"
],
"additionalProperties": false
},
"pronunciations": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"word": {
"type": "string"
},
"say": {
"type": "string"
}
},
"required": [
"word",
"say"
],
"additionalProperties": false
}
},
"script_change": {
"anyOf": [
{
"type": "object",
"properties": {
"since": {
"type": "string",
"enum": [
"seen",
"accepted"
]
},
"previous_text": {
"type": "string"
},
"current_text": {
"type": "string"
},
"directions_changed": {
"type": "boolean"
},
"document_replaced": {
"type": "boolean"
},
"changed_at": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"since",
"previous_text",
"current_text",
"directions_changed",
"document_replaced",
"changed_at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"changes_request": {
"anyOf": [
{
"type": "object",
"properties": {
"note": {
"type": "string"
},
"at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"by": {
"type": [
"string",
"null"
]
},
"needed_by": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
}
},
"required": [
"note",
"at",
"by",
"needed_by"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"decline": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": [
"string",
"null"
]
},
"at": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"by": {
"type": "string",
"enum": [
"talent",
"producer"
]
}
},
"required": [
"reason",
"at",
"by"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"completion": {
"anyOf": [
{
"type": "object",
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"at": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"note",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"timeline": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"actor": {
"type": "string",
"enum": [
"talent",
"producer",
"system"
]
},
"kind": {
"type": "string",
"enum": [
"sent",
"viewed",
"accepted",
"declined",
"completed",
"delivered",
"withdrawn",
"changes_requested",
"approved",
"used",
"script_changed",
"attached"
]
},
"label": {
"type": "string"
}
},
"required": [
"at",
"actor",
"kind",
"label"
],
"additionalProperties": false
}
},
"deliveries_detail": {
"type": "array",
"items": {
"type": "object",
"properties": {
"delivery_id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
"take_label": {
"type": "string",
"enum": [
"main",
"alt",
"safety",
"pickup",
"tag"
]
},
"take_number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"file_name": {
"type": "string"
},
"original_name": {
"type": "string"
},
"size_bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"storing",
"stalled",
"processing",
"delivered",
"approved",
"used",
"superseded",
"withdrawn",
"changes_requested"
]
},
"created_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"updated_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"note": {
"type": [
"string",
"null"
]
},
"facts": {
"anyOf": [
{
"type": "object",
"properties": {
"length_s": {
"type": "number",
"minimum": 0
},
"voiced_s": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"channels": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sample_rate": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"spot_length_s": {
"type": "number",
"minimum": 0
},
"length_verdict": {
"type": "string",
"enum": [
"pass",
"long",
"short",
"unknown"
]
}
},
"required": [
"length_s",
"voiced_s",
"channels",
"sample_rate",
"spot_length_s",
"length_verdict"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"preflight": {
"anyOf": [
{
"type": "object",
"properties": {
"measured": {
"type": "boolean"
},
"duration_s": {
"type": [
"number",
"null"
]
},
"voiced_s": {
"type": [
"number",
"null"
]
},
"sample_rate": {
"type": [
"number",
"null"
]
},
"channels": {
"type": [
"number",
"null"
]
},
"bit_depth": {
"type": [
"number",
"null"
]
},
"codec": {
"anyOf": [
{
"type": "string",
"maxLength": 20
},
{
"type": "null"
}
]
},
"peak_dbfs": {
"type": [
"number",
"null"
]
},
"lufs": {
"type": [
"number",
"null"
]
},
"lead_silence_s": {
"type": [
"number",
"null"
]
},
"tail_silence_s": {
"type": [
"number",
"null"
]
},
"warnings": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"enum": [
"runs_long",
"runs_short",
"low_sample_rate",
"clipping",
"very_quiet",
"very_loud",
"long_lead_silence",
"long_tail_silence",
"stereo_dry_voice",
"not_measured"
]
}
}
},
"required": [
"measured",
"duration_s",
"voiced_s",
"sample_rate",
"channels",
"bit_depth",
"codec",
"peak_dbfs",
"lufs",
"lead_silence_s",
"tail_silence_s",
"warnings"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"check": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"pending",
"running",
"done",
"unavailable",
"skipped"
]
},
"verdict": {
"anyOf": [
{
"type": "string",
"enum": [
"matches",
"check",
"mismatch"
]
},
{
"type": "null"
}
]
},
"coverage": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1
},
{
"type": "null"
}
]
},
"summary": {
"type": "string"
},
"issues": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"missing",
"changed",
"extra",
"repeated"
]
},
"severity": {
"type": "string",
"enum": [
"high",
"normal",
"soft"
]
},
"expected": {
"type": [
"string",
"null"
]
},
"heard": {
"type": [
"string",
"null"
]
},
"context": {
"type": "string"
},
"legal": {
"type": "boolean"
},
"name": {
"type": "boolean"
},
"number": {
"type": "boolean"
}
},
"required": [
"kind",
"severity",
"expected",
"heard",
"context",
"legal",
"name",
"number"
],
"additionalProperties": false
}
},
"checked_at": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"can_retry": {
"type": "boolean"
}
},
"required": [
"state",
"verdict",
"coverage",
"summary",
"issues",
"checked_at",
"can_retry"
],
"additionalProperties": false
},
"listen_url": {
"anyOf": [
{
"type": "string",
"maxLength": 8192
},
{
"type": "null"
}
]
},
"listen_url_expires_at": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"can_withdraw": {
"type": "boolean"
},
"can_resume": {
"type": "boolean"
}
},
"required": [
"delivery_id",
"take_label",
"take_number",
"file_name",
"original_name",
"size_bytes",
"status",
"created_at",
"updated_at",
"note",
"facts",
"preflight",
"check",
"listen_url",
"listen_url_expires_at",
"can_withdraw",
"can_resume"
],
"additionalProperties": false
}
},
"attachments_detail": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attachment_id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,9}$"
},
"original_name": {
"type": "string"
},
"ext": {
"type": "string"
},
"size_bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"storing",
"attached"
]
},
"note": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"can_remove": {
"type": "boolean"
}
},
"required": [
"attachment_id",
"original_name",
"ext",
"size_bytes",
"status",
"note",
"created_at",
"can_remove"
],
"additionalProperties": false
}
},
"can": {
"type": "object",
"properties": {
"accept": {
"type": "boolean"
},
"decline": {
"type": "boolean"
},
"complete": {
"type": "boolean"
},
"deliver": {
"type": "boolean"
},
"attach": {
"type": "boolean"
},
"ack_script": {
"type": "boolean"
}
},
"required": [
"accept",
"decline",
"complete",
"deliver",
"attach",
"ack_script"
],
"additionalProperties": false
},
"deliver_notice": {
"type": "string",
"enum": [
"none",
"live_read",
"spot_cancelled",
"declined"
]
},
"suggested_stem": {
"type": "string"
}
},
"required": [
"job_id",
"customer",
"voice",
"key_number",
"advertiser",
"length_s",
"kind",
"live_read",
"reference",
"requested_at",
"due_date",
"changes_due",
"due_state",
"status",
"stage",
"spot_cancelled",
"has_script",
"script_changed",
"unopened",
"deliveries",
"attachments",
"rate",
"producer_name",
"producer",
"flight_start",
"traffic",
"other_talent",
"agency",
"script",
"directions",
"pronunciations",
"script_change",
"changes_request",
"decline",
"completion",
"timeline",
"deliveries_detail",
"attachments_detail",
"can",
"deliver_notice",
"suggested_stem"
],
"additionalProperties": false
}
},
"required": [
"ok",
"api_version",
"job"
],
"additionalProperties": false
}