inkflow_order
Place a paid order: a complete book, manual, technical spec or multi-volume series; an AUDIOBOOK narrated from your manuscript; a SHORT-VIDEO for TikTok/Reels/Shorts (9:16); a YOUTUBE-VIDEO (16:9); or a cast/world/sample pack. IF YOUR KEY HAS CREDIT AND YOU QUOTE IN GBP THIS SETTLES INSTANTLY WITH NO CHECKOUT PAGE (top up via inkflow_topup); a credit order also needs startNowConsent: true, your statement that the person you buy for asked us to start straight away. Otherwise returns a Stripe payment URL — writing starts automatically the moment payment clears, with per-chapter progress via inkflow_job_status and webhooks. Requires your INKFLOW apiKey: get one free with the inkflow_register tool (or POST https://api.inkflowstudio.org/api/agents/register).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| brief | No | Any amount of supporting text: outline, world bible, style notes, or a full manuscript to adapt. No length cap. | |
| genre | No | ||
| apiKey | Yes | ||
| premise | Yes | what to write — premise, subject or spec | |
| product | Yes | ||
| quoteId | No | optional: the quoteId from inkflow_quote. The quoted price is charged for the same job within 24 hours of the quote. | |
| currency | No | ||
| docStyle | No | manual / SOP / revision: house style - plain English, Easy Read, or Simplified Technical English (ste) | |
| language | No | BCP-47, e.g. es-ES — written natively | |
| revision | No | document-revision: what to change | |
| listingId | No | creator-pack: the listing to buy | |
| docControl | No | document control block printed at the front | |
| lengthTier | No | ||
| seriesPlan | No | series: your own plan - {bible, volumes:[{title, tier: novella|standard|epic, outline}]} | |
| webhookUrl | No | POSTed progress + delivery events | |
| wordTarget | No | ||
| attachments | No | Pictures/diagrams for the production: character refs, location photos, storyboards. Each {name, mime, url or dataBase64 (max 40MB), note}. | |
| seriesBooks | No | ||
| contentRules | No | constraints, e.g. 'no profanity' | |
| expertReview | No | manual / SOP: add a human expert review | |
| productModel | No | manual / technical-spec: the make and model to research, e.g. 'Bosch GSR 18V-55' | |
| sourceOrderId | No | make this FROM a book you already bought here: an audiobook of it, or a video based on it. Must be your own delivered order. | |
| idempotencyKey | No | any unique string per intended order: a retry with the same key returns the first order instead of charging again | |
| sourceLanguage | No | translation: the language the manuscript is in (optional; detected if absent) | |
| startNowConsent | No | REQUIRED when the order settles from your credit balance (there is no checkout page): true states that the person you are buying for asked Inkflow to start straight away and understands their 14-day right to cancel ends once delivery begins. Without it a credit order is refused and nothing is charged. A card order collects this on the Stripe page. |