Run the editing agent

POSThttps://api.vidmoat.com/v1/ai/agent

Bearer tokenScope ai.agent5 creditsTry it in the playground

Describe an edit in message and let the agent emit and apply the commands. One turn per call, charged once: you drive the loop. Works on every plan.

Body#

projectIdstringrequired
The project to edit.
messagestringrequired
The edit, in plain words. Up to 2,000 characters.
dryRunbooleandefault false
Return the planned commands without applying them.

Response#

Returns 200.

Response fields#

projectIdstring
The project.
appliedboolean
Whether the commands were saved.
plannerstring
Which model planned the turn.
messagestring
The agent's reply.
commandsarray
The commands it planned.
resultsarray
One entry per command: { op, ok, error?, data? }. A failed command is reported here, not as an HTTP error.
verificationobject
What happened: accepted (count), failed ([{ op, error }]), blocked, layout warnings, and outcome (executed, needs-repair or blocked).
lintarray
Layout warnings: { severity: "warn" | "note", time, message }.
suggestedPreviewTimesarray of numbers
Timestamps worth looking at with the preview endpoint before you render.
projectobject
The project after the turn, summary view.
creditsobject
{ charged, remaining }: what this call cost and the balance after it.

Errors#

Besides the errors any request can get (authentication, rate limits):

Status	Code	When
400	`invalid_request`	`message` or `projectId` is missing.
404	`not_found`	No such project, or it is not yours. The two are indistinguishable on purpose.
402	`insufficient_credits`	The balance cannot cover the call. Nothing ran. `remaining` is the balance.
422	`prompt_rejected`	The prompt failed the safety check. Nothing was charged. `field` names the field.
502	`provider_error`	No planner answered. The charge is refunded.

curl

curl -X POST https://api.vidmoat.com/v1/ai/agent \
  -H "Authorization: Bearer $VIDMOAT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"'$ID'","message":"cut the silences and add captions"}'

Response 200

{
  "projectId": "cm1abc",
  "applied": true,
  "planner": "deepseek",
  "message": "Added captions.",
  "commands": [{ "op": "addTextClip", "text": "Hi", "start": 0, "duration": 2 }],
  "results": [{ "op": "addTextClip", "ok": true }],
  "lint": [],
  "suggestedPreviewTimes": [1],
  "project": { "id": "cm1abc", "name": "Demo", "clipCount": 1, "durationSec": 2 },
  "credits": { "charged": 5, "remaining": 4495 }
}