Raw schema
{
"type": "object",
"properties": {
"apiKey": {
"type": "string"
},
"brief": {
"type": "string",
"description": "Any amount of supporting text: outline, world bible, style notes, or a full manuscript to adapt. No length cap."
},
"attachments": {
"type": "array",
"description": "Pictures/diagrams for the production: character refs, location photos, storyboards. Each {name, mime, url or dataBase64 (max 40MB), note}.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"mime": {
"type": "string"
},
"url": {
"type": "string"
},
"dataBase64": {
"type": "string"
},
"note": {
"type": "string"
}
}
}
},
"product": {
"type": "string",
"enum": [
"book",
"manual",
"technical-spec",
"series",
"audiobook",
"short-video",
"youtube-video",
"demo",
"editor-report",
"translation",
"document-revision",
"cast-pack",
"sample-pack",
"world-pack",
"cyberpunk-set",
"creator-pack"
]
},
"premise": {
"type": "string",
"description": "what to write — premise, subject or spec"
},
"genre": {
"type": "string"
},
"language": {
"type": "string",
"description": "BCP-47, e.g. es-ES — written natively"
},
"lengthTier": {
"type": "string",
"enum": [
"novella",
"standard",
"epic"
]
},
"wordTarget": {
"type": "number"
},
"seriesBooks": {
"type": "number"
},
"sourceOrderId": {
"type": "string",
"description": "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."
},
"currency": {
"type": "string"
},
"webhookUrl": {
"type": "string",
"description": "POSTed progress + delivery events"
},
"idempotencyKey": {
"type": "string",
"description": "any unique string per intended order: a retry with the same key returns the first order instead of charging again"
},
"quoteId": {
"type": "string",
"description": "optional: the quoteId from inkflow_quote. The quoted price is charged for the same job within 24 hours of the quote."
},
"startNowConsent": {
"type": "boolean",
"description": "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."
},
"contentRules": {
"type": "string",
"description": "constraints, e.g. 'no profanity'"
},
"sourceLanguage": {
"type": "string",
"description": "translation: the language the manuscript is in (optional; detected if absent)"
},
"docStyle": {
"type": "string",
"enum": [
"standard",
"plain",
"easy-read",
"ste"
],
"description": "manual / SOP / revision: house style - plain English, Easy Read, or Simplified Technical English (ste)"
},
"productModel": {
"type": "string",
"description": "manual / technical-spec: the make and model to research, e.g. 'Bosch GSR 18V-55'"
},
"docControl": {
"type": "object",
"description": "document control block printed at the front",
"properties": {
"organisation": {
"type": "string"
},
"author": {
"type": "string"
},
"approver": {
"type": "string"
},
"distribution": {
"type": "string"
},
"reviewMonths": {
"type": "number",
"description": "1-60, default 12"
}
}
},
"revision": {
"type": "object",
"description": "document-revision: what to change",
"properties": {
"updateGuidance": {
"type": "boolean",
"description": "check against current guidance (default true)"
},
"restructure": {
"type": "boolean",
"description": "reorganise the structure (default true)"
}
}
},
"expertReview": {
"type": "boolean",
"description": "manual / SOP: add a human expert review"
},
"listingId": {
"type": "string",
"description": "creator-pack: the listing to buy"
},
"seriesPlan": {
"type": "object",
"description": "series: your own plan - {bible, volumes:[{title, tier: novella|standard|epic, outline}]}"
}
},
"required": [
"apiKey",
"product",
"premise"
]
}