{"openapi":"3.1.0","info":{"title":"vehicleimages.ai API","version":"1.0.0","description":"Generate finished UK right-hand-drive vehicle catalogue renders, including optional plate text in the initial generation prompt."},"servers":[{"url":"/api/public/v1","description":"Production"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/renders":{"post":{"summary":"Create a vehicle render","description":"Generates a single vehicle image at the one production quality setting.","operationId":"createRender","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderRequest"},"example":{"make":"BMW","model":"M2 Competition","year":"2022","bodyStyle":"coupe","colour":"Hockenheim Silver metallic","angle":"front-3q-right","plateText":"MAGNITUDE","extra":"black M alloy wheels with blue brake calipers"}}}},"responses":{"200":{"description":"Render created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Render"}}}},"400":{"description":"Invalid request"},"401":{"description":"Missing or invalid API key"},"502":{"description":"Upstream generation failure"}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RenderRequest":{"type":"object","required":["make","model"],"properties":{"make":{"type":"string","example":"BMW"},"model":{"type":"string","example":"M2 Competition"},"year":{"type":"string","example":"2022"},"bodyStyle":{"type":"string","example":"coupe"},"colour":{"type":"string","example":"Metallic Blue"},"angle":{"type":"string","enum":["front-3q-right","front-3q-left","front","side-right","side-left","rear-3q-right","rear-3q-left","rear","top","interior"],"default":"front-3q-right"},"extra":{"type":"string","description":"Free-text trim, wheel or detail guidance."},"plateText":{"type":"string","description":"Exact wording requested inside the physical number plate during initial generation."},"logoPng":{"type":"string","description":"Not currently supported. Send the logo's brand wording as plateText."}}},"Render":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"format":{"type":"string","example":"png"},"transparent":{"type":"boolean"},"transparentRatio":{"type":"number","description":"Share of output pixels with alpha below 250."},"plateBranded":{"type":"boolean"},"brandingStatus":{"type":"string","enum":["not_requested","requested_unverified","logo_input_unsupported"]},"brandingMessage":{"type":"string"},"image":{"type":"string","description":"Data URL of the generated PNG."},"prompt":{"type":"string"}}}}}}