{"openapi":"3.1.0","info":{"title":"DEV3 Opalframe API","version":"1.0.0"},"servers":[{"url":"/api/v1"}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"n3k_…"}}},"paths":{"/me":{"get":{"summary":"The workspace this key belongs to","tags":["Workspace"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"plan":{"type":"string"},"members":{"type":"number"}},"required":["id","name","plan","members"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/members":{"get":{"summary":"List members","tags":["Workspace"],"security":[{"bearer":[]}],"x-scope":"read","parameters":[{"name":"role","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"role":{"type":"string"}},"required":["id","name","email","role"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/usage":{"get":{"summary":"Usage for the current billing period","tags":["Billing"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"plan":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string"},"used":{"type":"number"},"limit":{"type":"number"}},"required":["metric","used","limit"],"additionalProperties":false}}},"required":["plan","rows"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/events":{"post":{"summary":"Record a metered usage event","tags":["Billing"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"metric":{"type":"string","pattern":"^[a-z0-9._-]+$"},"quantity":{"type":"integer","exclusiveMinimum":0,"maximum":1000000}},"required":["metric","quantity"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/credits":{"get":{"summary":"Credit balance and recent ledger entries","tags":["Billing"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"balance":{"type":"number"},"locked":{"type":"boolean"},"storageBytes":{"type":"number"},"ledger":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"amount":{"type":"number"},"jobId":{"type":["string","null"]},"createdAt":{}},"required":["kind","amount","jobId","createdAt"],"additionalProperties":false}}},"required":["balance","locked","storageBytes","ledger"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/models":{"get":{"summary":"Models you can use (simulated tiers and configured adapters)","tags":["Catalogue"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"provider":{"type":"string"},"status":{"type":"string"},"simulated":{"type":"boolean"},"capabilities":{"type":"array","items":{"type":"string"}},"creditCost":{"type":"number"}},"required":["key","label","provider","status","simulated","capabilities","creditCost"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/styles":{"get":{"summary":"Style presets","tags":["Catalogue"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"swatch":{"type":"array","items":{"type":"string"}}},"required":["key","label","swatch"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/generations":{"post":{"summary":"Start a text-to-image generation job","tags":["Generations"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":2000},"negative":{"type":"string","maxLength":1000},"style":{"type":"string","maxLength":40},"ratio":{"default":"1:1","type":"string","enum":["1:1","3:2","2:3","4:3","3:4","16:9","9:16","21:9"]},"count":{"default":1,"type":"integer","minimum":1,"maximum":4},"seed":{"type":"integer","minimum":0,"maximum":2147483648},"model":{"default":"draft","type":"string","maxLength":40},"brandKitId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"boardId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"idempotencyKey":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9._:-]+$"}},"required":["prompt","ratio","count","model"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"status":{"type":"string"},"model":{"type":"string"},"seed":{"type":"number"},"count":{"type":"number"},"imagesDone":{"type":"number"},"imagesFailed":{"type":"number"},"progress":{"type":"number"},"credits":{"type":"object","properties":{"reserved":{"type":"number"},"settled":{"type":"number"},"refunded":{"type":"number"}},"required":["reserved","settled","refunded"],"additionalProperties":false},"simulated":{"type":"boolean"},"driver":{"type":"string"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]},"batchId":{"type":["string","null"]},"createdAt":{},"finishedAt":{}},"required":["id","kind","status","model","seed","count","imagesDone","imagesFailed","progress","credits","simulated","driver","error","batchId","createdAt","finishedAt"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"get":{"summary":"List jobs","tags":["Generations"],"security":[{"bearer":[]}],"x-scope":"read","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"status":{"type":"string"},"model":{"type":"string"},"seed":{"type":"number"},"count":{"type":"number"},"imagesDone":{"type":"number"},"imagesFailed":{"type":"number"},"progress":{"type":"number"},"credits":{"type":"object","properties":{"reserved":{"type":"number"},"settled":{"type":"number"},"refunded":{"type":"number"}},"required":["reserved","settled","refunded"],"additionalProperties":false},"simulated":{"type":"boolean"},"driver":{"type":"string"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]},"batchId":{"type":["string","null"]},"createdAt":{},"finishedAt":{}},"required":["id","kind","status","model","seed","count","imagesDone","imagesFailed","progress","credits","simulated","driver","error","batchId","createdAt","finishedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/jobs/{id}":{"get":{"summary":"Get a job with its images","tags":["Generations"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"job":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"status":{"type":"string"},"model":{"type":"string"},"seed":{"type":"number"},"count":{"type":"number"},"imagesDone":{"type":"number"},"imagesFailed":{"type":"number"},"progress":{"type":"number"},"credits":{"type":"object","properties":{"reserved":{"type":"number"},"settled":{"type":"number"},"refunded":{"type":"number"}},"required":["reserved","settled","refunded"],"additionalProperties":false},"simulated":{"type":"boolean"},"driver":{"type":"string"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]},"batchId":{"type":["string","null"]},"createdAt":{},"finishedAt":{}},"required":["id","kind","status","model","seed","count","imagesDone","imagesFailed","progress","credits","simulated","driver","error","batchId","createdAt","finishedAt"],"additionalProperties":false},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"jobId":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"seed":{"type":"number"},"prompt":{"type":"string"},"style":{"type":"string"},"model":{"type":"string"},"kind":{"type":"string"},"simulated":{"type":"boolean"},"favourite":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"flagged":{"type":"boolean"},"parentImageId":{"type":["string","null"]},"createdAt":{},"urls":{"anyOf":[{"type":"object","properties":{"thumb":{"type":"string"},"preview":{"type":"string"},"original":{"type":"string"}},"required":["thumb","preview"],"additionalProperties":false},{"type":"null"}]}},"required":["id","jobId","width","height","seed","prompt","style","model","kind","simulated","favourite","tags","flagged","parentImageId","createdAt","urls"],"additionalProperties":false}}},"required":["job","images"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/jobs/{id}/cancel":{"post":{"summary":"Cancel a queued or running job (send an empty JSON object; unrendered images are refunded)","tags":["Generations"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"status":{"type":"string"},"model":{"type":"string"},"seed":{"type":"number"},"count":{"type":"number"},"imagesDone":{"type":"number"},"imagesFailed":{"type":"number"},"progress":{"type":"number"},"credits":{"type":"object","properties":{"reserved":{"type":"number"},"settled":{"type":"number"},"refunded":{"type":"number"}},"required":["reserved","settled","refunded"],"additionalProperties":false},"simulated":{"type":"boolean"},"driver":{"type":"string"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]},"batchId":{"type":["string","null"]},"createdAt":{},"finishedAt":{}},"required":["id","kind","status","model","seed","count","imagesDone","imagesFailed","progress","credits","simulated","driver","error","batchId","createdAt","finishedAt"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/edits":{"post":{"summary":"Image-to-image, inpaint, outpaint or variations","tags":["Edits"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"mode":{"type":"string","enum":["img2img","inpaint","outpaint","variations"]},"imageId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"imageBase64":{"type":"string","maxLength":30000000},"maskBase64":{"type":"string","maxLength":30000000},"prompt":{"default":"","type":"string","maxLength":2000},"negative":{"type":"string","maxLength":1000},"style":{"type":"string","maxLength":40},"strength":{"type":"number","minimum":0.05,"maximum":1},"outpaint":{"type":"object","properties":{"ratio":{"type":"string","enum":["1:1","3:2","2:3","4:3","3:4","16:9","9:16","21:9"]},"width":{"type":"integer","minimum":64,"maximum":4096},"height":{"type":"integer","minimum":64,"maximum":4096},"anchor":{"type":"string","enum":["center","top","bottom","left","right"]}},"additionalProperties":false},"count":{"default":1,"type":"integer","minimum":1,"maximum":4},"seed":{"type":"integer","minimum":0,"maximum":2147483648},"model":{"default":"draft","type":"string","maxLength":40},"brandKitId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"idempotencyKey":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9._:-]+$"}},"required":["mode","prompt","count","model"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"status":{"type":"string"},"model":{"type":"string"},"seed":{"type":"number"},"count":{"type":"number"},"imagesDone":{"type":"number"},"imagesFailed":{"type":"number"},"progress":{"type":"number"},"credits":{"type":"object","properties":{"reserved":{"type":"number"},"settled":{"type":"number"},"refunded":{"type":"number"}},"required":["reserved","settled","refunded"],"additionalProperties":false},"simulated":{"type":"boolean"},"driver":{"type":"string"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]},"batchId":{"type":["string","null"]},"createdAt":{},"finishedAt":{}},"required":["id","kind","status","model","seed","count","imagesDone","imagesFailed","progress","credits","simulated","driver","error","batchId","createdAt","finishedAt"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/tools/remove-background":{"post":{"summary":"Remove the background (transparent PNG)","tags":["Tools"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"imageId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"imageBase64":{"type":"string","maxLength":30000000},"model":{"default":"draft","type":"string","maxLength":40},"idempotencyKey":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9._:-]+$"}},"required":["model"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"status":{"type":"string"},"model":{"type":"string"},"seed":{"type":"number"},"count":{"type":"number"},"imagesDone":{"type":"number"},"imagesFailed":{"type":"number"},"progress":{"type":"number"},"credits":{"type":"object","properties":{"reserved":{"type":"number"},"settled":{"type":"number"},"refunded":{"type":"number"}},"required":["reserved","settled","refunded"],"additionalProperties":false},"simulated":{"type":"boolean"},"driver":{"type":"string"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]},"batchId":{"type":["string","null"]},"createdAt":{},"finishedAt":{}},"required":["id","kind","status","model","seed","count","imagesDone","imagesFailed","progress","credits","simulated","driver","error","batchId","createdAt","finishedAt"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/tools/upscale":{"post":{"summary":"Upscale 2x or 4x","tags":["Tools"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"imageId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"imageBase64":{"type":"string","maxLength":30000000},"factor":{"default":2,"anyOf":[{"type":"number","const":2},{"type":"number","const":4}]},"model":{"default":"draft","type":"string","maxLength":40},"idempotencyKey":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9._:-]+$"}},"required":["factor","model"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"status":{"type":"string"},"model":{"type":"string"},"seed":{"type":"number"},"count":{"type":"number"},"imagesDone":{"type":"number"},"imagesFailed":{"type":"number"},"progress":{"type":"number"},"credits":{"type":"object","properties":{"reserved":{"type":"number"},"settled":{"type":"number"},"refunded":{"type":"number"}},"required":["reserved","settled","refunded"],"additionalProperties":false},"simulated":{"type":"boolean"},"driver":{"type":"string"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]},"batchId":{"type":["string","null"]},"createdAt":{},"finishedAt":{}},"required":["id","kind","status","model","seed","count","imagesDone","imagesFailed","progress","credits","simulated","driver","error","batchId","createdAt","finishedAt"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/images":{"get":{"summary":"List library images","tags":["Library"],"security":[{"bearer":[]}],"x-scope":"read","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string"}},{"name":"style","in":"query","required":false,"schema":{"type":"string"}},{"name":"model","in":"query","required":false,"schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"schema":{"type":"string"}},{"name":"boardId","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$"}},{"name":"favourite","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}},{"name":"trash","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"jobId":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"seed":{"type":"number"},"prompt":{"type":"string"},"style":{"type":"string"},"model":{"type":"string"},"kind":{"type":"string"},"simulated":{"type":"boolean"},"favourite":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"flagged":{"type":"boolean"},"parentImageId":{"type":["string","null"]},"createdAt":{},"urls":{"anyOf":[{"type":"object","properties":{"thumb":{"type":"string"},"preview":{"type":"string"},"original":{"type":"string"}},"required":["thumb","preview"],"additionalProperties":false},{"type":"null"}]}},"required":["id","jobId","width","height","seed","prompt","style","model","kind","simulated","favourite","tags","flagged","parentImageId","createdAt","urls"],"additionalProperties":false}},"total":{"type":"number"}},"required":["data","total"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/images/{id}":{"get":{"summary":"Get an image with signed URLs and its edit chain","tags":["Library"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"image":{"type":"object","properties":{"id":{"type":"string"},"jobId":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"seed":{"type":"number"},"prompt":{"type":"string"},"style":{"type":"string"},"model":{"type":"string"},"kind":{"type":"string"},"simulated":{"type":"boolean"},"favourite":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"flagged":{"type":"boolean"},"parentImageId":{"type":["string","null"]},"createdAt":{},"urls":{"anyOf":[{"type":"object","properties":{"thumb":{"type":"string"},"preview":{"type":"string"},"original":{"type":"string"}},"required":["thumb","preview"],"additionalProperties":false},{"type":"null"}]}},"required":["id","jobId","width","height","seed","prompt","style","model","kind","simulated","favourite","tags","flagged","parentImageId","createdAt","urls"],"additionalProperties":false},"chain":{"type":"object","properties":{"ancestors":{"type":"array","items":{"type":"string"}},"children":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"parent":{"type":"string"}},"required":["id","parent"],"additionalProperties":false}}},"required":["ancestors","children"],"additionalProperties":false}},"required":["image","chain"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"patch":{"summary":"Favourite, tag or restore an image","tags":["Library"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"favourite":{"type":"boolean"},"tags":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":32}},"restore":{"type":"boolean"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"delete":{"summary":"Move an image to the trash (30 days)","tags":["Library"],"security":[{"bearer":[]}],"x-scope":"write","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/boards":{"get":{"summary":"List boards","tags":["Boards"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"images":{"type":"number"}},"required":["id","name","images"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"post":{"summary":"Create a board","tags":["Boards"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120}},"required":["name"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/boards/{id}/images":{"post":{"summary":"Add images to a board","tags":["Boards"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"imageIds":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{24}$"}}},"required":["imageIds"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"added":{"type":"number"}},"required":["added"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/share-links":{"post":{"summary":"Create a share link for an image or a board","tags":["Sharing"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"kind":{"type":"string","enum":["image","board"]},"targetId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"ttlDays":{"type":"integer","minimum":1,"maximum":365},"allowDownload":{"type":"boolean"}},"required":["kind","targetId"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"token":{"type":"string"},"expiresAt":{}},"required":["id","url","token","expiresAt"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"get":{"summary":"List share links","tags":["Sharing"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/share-links/{id}":{"delete":{"summary":"Revoke a share link","tags":["Sharing"],"security":[{"bearer":[]}],"x-scope":"write","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/batches":{"post":{"summary":"Create a batch from CSV text (prompt,style,ratio,seed)","tags":["Batches"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"csv":{"type":"string","minLength":1,"maxLength":200000},"name":{"type":"string","maxLength":120},"model":{"default":"draft","type":"string","maxLength":40},"style":{"type":"string","maxLength":40},"ratio":{"type":"string","enum":["1:1","3:2","2:3","4:3","3:4","16:9","9:16","21:9"]},"brandKitId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"idempotencyKey":{"type":"string","minLength":8,"maxLength":80,"pattern":"^[A-Za-z0-9._:-]+$"}},"required":["csv","model"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"rows":{"type":"number"},"skipped":{"type":"number"}},"required":["id","status","rows","skipped"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/batches/{id}":{"get":{"summary":"Batch progress","tags":["Batches"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"total":{"type":"number"},"jobs":{"type":"number"},"succeeded":{"type":"number"},"open":{"type":"number"},"skipped":{"type":"number"},"progress":{"type":"number"}},"required":["id","status","total","jobs","succeeded","open","skipped","progress"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}}}}