Rewrite one item from an instruction

POST /boards/{boardId}/ai/modify

Updated 8 Oct 20263 min read

POST/boards/{boardId}/ai/modifyTry it

Basehttps://api.mockflow.com/v1Scopesai:generateboards:write

Request

curl https://api.mockflow.com/v1/boards/brd_3f9e2a/ai/modify \
  -X POST \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "itemId": "itm_k9",
  "instruction": "Add a \"Blocked\" column and move anything mentioning legal into it."
}'

const response = await fetch("https://api.mockflow.com/v1/boards/brd_3f9e2a/ai/modify", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "itemId": "itm_k9",
  "instruction": "Add a \"Blocked\" column and move anything mentioning legal into it."
})
});

const data = await response.json();

import os, requests

response = requests.post(
    "https://api.mockflow.com/v1/boards/brd_3f9e2a/ai/modify",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
    json={
  "itemId": "itm_k9",
  "instruction": "Add a \"Blocked\" column and move anything mentioning legal into it."
},
)

response.raise_for_status()
data = response.json()

Response

{
  "id": "job_7hd2",
  "kind": "item.create",
  "status": "queued",
  "progress": 0,
  "message": "Interview 5 users",
  "result": {
    "itemIds": [
      "string"
    ],
    "updated": [
      "string"
    ],
    "deleted": [
      "string"
    ],
    "creditsUsed": 0,
    "boardTitle": "Q4 Launch Planning",
    "skill": "string"
  }
}

{
  "error": {
    "code": "plan_limit",
    "message": "AI credits exhausted. 0 of 2000 remaining this month.",
    "upgradeUrl": "https://mockflow.com/pricing"
  },
  "requestId": "req_01ja"
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "docsUrl": "https://mockflow.com/developers/concepts/errors#rate_limited"
  },
  "requestId": "req_45d49816999bac40"
}

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

Authorization

Authorizationstringheaderrequired

Bearer <key>. The key needs ai:generate and boards:write scopes. Create and manage keys in the developer console, or use an OAuth app to act for other people; what each scope unlocks is on the scopes page.

Path parameters

boardIdstringpathrequired

Headers

Idempotency-Keystringheader

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

Body

application/json

callbackUrlstring

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}.

itemIdstringrequired

instructionstringrequired

withImagesboolean

Response

202 · application/json

idstring

kindenum<string>

One of item.create, item.update, item.delete, item.batch, ai.generate, ai.modify, skill.apply or board.export.

statusenum<string>

One of queued, running, succeeded or failed.

progressinteger

messagestring

Human readable progress, for example "Placing kanban".

resultobject | null

Child attributes

itemIdsstring[]

updatedstring[]

deletedstring[]

creditsUsedinteger

boardTitlestring | null

skillstring | null

convertedFromstring

sourceDeletedboolean

targetenum<string>

board.export. What was drawn. One of board, frame or item.

formatenum<string>

board.export. One of png.

scaleenum<integer>

board.export. One of 1 or 2.

imageUrlstring

board.export. The PNG. Anyone with this URL can open it.

widthinteger

board.export. The image's width in pixels.

heightinteger

board.export. The image's height in pixels.

errorerror

Child attributes

codeenum<string>required

One of unauthorized, forbidden, not_found, validation_failed, conflict, plan_limit, rate_limited or internal.

messagestringrequired

detailsobject[]

docsUrlstring

upgradeUrlstring

createdAtstring

finishedAtstring | null

callbackUrlstring | null

Where the job's result is POSTed

callbackobject | null

The newest delivery to callbackUrl, once the job has finished. Null until then, and when there is no callbackUrl.

Child attributes

urlstring

deliveryIdstring

statusenum<string>

One of pending, retrying, succeeded, failed or cancelled.

attemptsinteger

responseStatusinteger | null

errorstring | null

deliveredAtstring | null

nextRetryAtstring | null

Errors

402plan_limit

The workspace plan does not allow this, or AI credits are exhausted.

429rate_limited

Too many requests.

Was this page helpful?