Generation

Run the editing agent

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.

Add dryRun: true to get the plan back without applying it. The credits are still spent, because the model call is what they pay for, and so is a turn that plans nothing.

post/ai/agent

Request

  • Base URL: https://api.vidmoat.com/v1
  • URL: https://api.vidmoat.com/v1/ai/agent
  • Auth: HTTP bearer

Request body

projectIdstring required

The project to edit.

messagestring required

The edit, in plain words. Up to 2,000 characters.

dryRunboolean

Return the planned commands without applying them.

Response

Run the editing agent

projectIdstring

The project.

appliedboolean

Whether the commands were saved.

plannerstring

Which model planned the turn.

messagestring

The agent's reply.

verificationobject

What happened: accepted (count), failed ([{ op, error }]), blocked, layout warnings, and outcome (executed, needs-repair or blocked).

suggestedPreviewTimesnumber[]

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.

Changes

No recorded changes to this operation across all 1 revision of this API.