Mida's review of the board

POST /boards/{boardId}/ai/review

Updated 17 Sep 20261 min read

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

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

Request

curl https://api.mockflow.com/v1/boards/brd_3f9e2a/ai/review \
  -X POST \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "focus": "string"
}'

const response = await fetch("https://api.mockflow.com/v1/boards/brd_3f9e2a/ai/review", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "focus": "string"
})
});

const data = await response.json();

import os, requests

response = requests.post(
    "https://api.mockflow.com/v1/boards/brd_3f9e2a/ai/review",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
    json={
  "focus": "string"
},
)

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

Response

{
  "overallScore": 0,
  "feedback": [
    {
      "type": "string",
      "comment": "string",
      "score": 0
    }
  ],
  "creditsUsed": 0
}

{
  "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"
}

Feedback on the board's content, scored per aspect and overall, in the shape the editor's AI review uses. Charged in AI credits.

Authorization

Authorizationstringheaderrequired

Bearer <key>. The key needs ai:generate and boards:read scopes. Create and manage keys in the developer console; what each scope unlocks is on the scopes page.

Path parameters

boardIdstringpathrequired

Body

application/json

focusstring

What to review for, for example "completeness of the launch plan".

Response

200 · application/json

overallScoreinteger | null

feedbackobject[]

Child attributes

typestring

commentstring

scoreinteger | null

creditsUsedinteger

Errors

402plan_limit

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

429rate_limited

Too many requests.

Was this page helpful?