MOmockflow
Boards

Create a board

A new board in a space, or in the default space when spaceId is omitted. Basic makes three boards, trashed ones included; the cap answers 402. With prompt, Mida fills the new board in the background and the response carries the Job to poll.

post/boards

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

titlestring required
spaceIdstring

Omit for the default space.

promptstring

Have Mida build the board from this. Needs the ai:generate scope and a Plus or Max plan.

outputTypesItemType[]
skillstring

A skill id from GET /skills to apply to the prompt.

withImagesboolean

Example request

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

Response

Created.

idstring
titlestring
spaceIdstring nullable

The design space, or null for the default space.

urlstring uri

Opens the board in the editor.

publicUrlstring uri nullable

The public viewer link, when the public link is on.

role'owner' | 'admin' | 'editor' | 'reviewer'

The product's roles. Owner is the workspace that holds the board or space and cannot be granted or transferred. Admin can rename and share, editor can edit, reviewer can view, export and add comment items. There is no viewer role and no pending state.

lockedboolean

Locked boards are read only for everyone.

positioninteger nullable

Manual order inside the space, lowest first.

createdBystring
createdAtstring date-time
updatedAtstring date-time
deletedAtstring date-time nullable

Set while the board is in the trash.

Changes

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