Skip to main content
POST
Accept one source URL for durable ingestion

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Workspace-scoped key for safe ingestion creation replay

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9._~-]+$

Body

application/json
url
string
required
Required string length: 1 - 2048
refresh
boolean
default:false
purpose
string
default:reference_library
Allowed value: "reference_library"
mediaProfile
enum<string>
default:analysis
Available options:
none,
analysis,
full
transcript
boolean
default:true

Response

Ingestion durably accepted

id
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
workspaceId
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
jobId
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
sourceUrl
string
required
Required string length: 1 - 2048
mediaProfile
enum<string>
required
Available options:
none,
analysis,
full
transcript
boolean
required
state
enum<string>
required
Available options:
accepted,
queued,
running,
retry_wait,
succeeded,
failed,
cancelled
progress
object | null
required
attempts
object[]
required
Maximum array length: 10
referenceId
string | null
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
outcomeCode
enum<string> | null
required
Available options:
invalid_input,
unauthenticated,
invalid_credential,
credential_conflict,
forbidden,
policy_blocked,
route_disabled,
route_degraded,
not_found,
bootstrap_conflict,
last_owner_conflict,
revision_conflict,
idempotency_conflict,
unavailable_private,
unavailable_restricted,
unavailable_removed,
unsupported_object,
unsupported_media,
limit_exceeded,
rate_limited,
source_changed,
network_timeout,
network_transport,
media_invalid,
storage_unavailable,
retry_exhausted,
internal_error
outcomeMessage
string | null
required
Required string length: 1 - 240
cancelRequested
boolean
required
createdAt
string
required
Pattern: ^\d{4}-(0[1-9]|1[0-2])-([0-2]\d|3[01])T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,9})?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)$
updatedAt
string
required
Pattern: ^\d{4}-(0[1-9]|1[0-2])-([0-2]\d|3[01])T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,9})?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)$
finishedAt
string | null
required
Pattern: ^\d{4}-(0[1-9]|1[0-2])-([0-2]\d|3[01])T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,9})?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)$
revision
integer
required
Required range: 0 <= x <= 9007199254740991