Skip to main content
POST

Message Iris

Send Iris one change to an edit she made, in plain words, as you would type it in her chat in Submagic: b-roll, music, sound effects, voice volume, captions and their style, cuts and pauses, framing, the hook title and graphics, eye contact, clean audio, translation. Iris works in the background. This call returns a jobId at once; read the job with Get Iris Job until its status is no longer running. A change saves a new version of the edit, and the versions before it are kept.
This endpoint requires authentication and has a rate limit of 500 requests per hour. Messages to Iris do not use credits.

Limits

  • Iris only changes projects she edited: ones made with Create Iris Project or an Iris template in the Submagic app. Their aiEditTemplate in Get Project starts with ref:.
  • The edit must be finished: wait until the project’s status is completed.
  • Iris needs a paid plan.
  • Iris works on one message at a time. A message sent while she is still working is refused with 409 and the jobId to wait for.
  • Each video allows a limited number of messages, the same as in the app, and an account can send up to 30 messages an hour. Send everything you want changed in one message rather than one message per change.
  • The messages show in the project’s chat in Submagic.

Authentication

string
required
Your Submagic API key starting with sk-

Path Parameters

string
required
The unique identifier (UUID) of the project Iris edited

Request Body

string
required
What to change, in your words (1-4000 characters), e.g. “make the music quieter” or “add a b-roll of a city at night when I mention New York”

Response

string
The message’s job ID. Read it with Get Iris Job.
string
The project’s ID
number
The version of the edit Iris is changing
string
Always running

Error Responses

string
Error code: VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT, RATE_LIMIT_EXCEEDED or INTERNAL_SERVER_ERROR
string
What went wrong, in plain words
string
When Iris refused the message, the refusal’s code, e.g. not_iris, iris_making, no_edit, iris_paid_plan or chat_limit
string
On a 409 while Iris works on an earlier message: that message’s job, to wait for