Generate

Create a mascot from a brand book

One call that turns a brand book into a mascot. Send the brand book as public links (a PDF up to 50 MB, or PNG, JPEG or WebP pages up to 10 MB each) or images from POST /v1/upload, at most 30 pages in total. The job reads the brand book for free, generates every mascot view and prop it finds as a clean image for 1 credit each (at most 5 views and 12 props, so at most 17 credits), then creates the mascot in project_id with the views as labeled references and the description, colors, style, don'ts and props filled in. Poll GET /v1/jobs/{job_id}: step reports progress, and a completed job returns result.mascot_id with what it cost. Nothing is charged when the brand book has no mascot, costs more than max_credits, or the balance is short; each image that fails is refunded. Takes about 2 to 4 minutes. Counts toward the limit of 15 brand book readings per day. Use Idempotency-Key to retry without starting a second job.

post/v1/mascots/from-brand-book

Request

  • Base URL: https://api.masko.ai
  • URL: https://api.masko.ai/v1/mascots/from-brand-book
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Account-scoped key (1 to 255 characters, ideally a UUID). Retries must preserve the credential workspace, effective API version, URL, content type and exact body bytes, including multipart boundaries; different inputs return 409 idempotency_key_reused. Completed responses, including 500 errors, replay for 24 hours after completion with current resource access checked again. Running or unconfirmed executions return 409 idempotency_request_in_progress and do not expire automatically. A receipt persistence failure returns 503 idempotency_persistence_failed: retry only with the same key and inspect the operation outcome before starting a new request.

Request body

project_idstring uuid required

Project to create the mascot in.

namestring

Mascot name. When omitted, the name written in the brand book is used.

max_creditsinteger

Spending cap. Each view and prop generated costs 1 credit, at most 17 in total. When the brand book costs more, the job fails after the free reading and nothing is charged.

Response

Brand book accepted

Changes

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