Skip to main content
GET

Get Iris Job

Read the job a Message Iris call started. While Iris works, status is running. An answer takes from a few seconds (a question back) to a few minutes (new b-roll, a re-cut), so read the job again every few seconds until status is done or error. When the job is done, Iris did one of three things:
  • Changed the edit: version is the new version and reply says what she changed. To get the video file, call Export Project: it renders Iris’s latest version.
  • Asked a question: question holds it, with the answers she offers. Send your answer with another Message Iris call.
  • Changed nothing: version and question are null. reply, when set, says why.
This endpoint requires authentication and has a rate limit of 1000 requests per hour. It does not use credits.

Authentication

string
required
Your Submagic API key starting with sk-

Path Parameters

string
required
The unique identifier (UUID) of the project
string
required
The jobId returned by Message Iris

Response

string
The project’s ID
string
The job’s ID
string
running, done or error
number | null
The edit’s new version, or null when nothing changed (yet)
string | null
What Iris says she did, in plain words
object | null
Iris’s question back, when she needs an answer
string | null
Why Iris could not do it, when status is error