MOmockflow
AI

Rewrite one item from an instruction

Mida rewrites a frame in place, as the component's own "modify with AI" does. One item per call.

post/boards/{boardId}/ai/modify

Request

  • Base URL
    https://api.mockflow.com/v1
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

A unique key per logical request. Replays within 24 hours return the original response.

Request body

callbackUrlstring uri

Optional. When the job this request starts finishes or fails, a short body is POSTed here once: { eventId, status, boardId, boardUrl, imageUrl }, where status is succeeded or failed and imageUrl is a picture of what the job drew, or null. Signed with the workspace's callback secret (GET /webhooks/callback-secret). https to a public host. The full job is on GET /jobs/{jobId}.

itemIdstring required
instructionstring required
withImagesboolean

Example request

{
  "callbackUrl": "https://hooks.zapier.com/hooks/standard/123/abc"
}

Response

Rewrite started.

idstring
kind'item.create' | 'item.update' | 'item.delete' | 'item.batch' | 'item.record' | 'ai.generate' | 'ai.modify' | 'skill.apply' | 'board.export'
status'queued' | 'running' | 'succeeded' | 'failed'
progressinteger
messagestring

Human readable progress, for example "Placing kanban".

errorError (unresolved $ref)
createdAtstring date-time
finishedAtstring date-time nullable
callbackUrlstring nullable

Where the job's result is POSTed

Changes

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