[{"data":1,"prerenderedAt":455},["ShallowReactive",2],{"guide-\u002Fguides\u002Foverview":3,"developer-code-eb0qrl":450,"developer-code-r5o41j":451,"developer-code-1kb15yj":452,"developer-code-1kdaqai":453,"developer-code-13r784n":454},{"id":4,"title":5,"body":6,"description":441,"extension":442,"meta":443,"navigation":444,"path":446,"seo":447,"stem":448,"__hash__":449},"guides\u002Fguides\u002Foverview.md","VisionStory API Overview",{"type":7,"value":8,"toc":431},"minimark",[9,13,18,21,71,74,85,94,105,112,188,192,197,200,231,242,246,253,275,284,288,291,313,320,324,331,396,399,403,427],[10,11,12],"p",{},"The VisionStory API is a REST API for creating talking-avatar videos and programmable AI media. Send text or audio, choose an avatar and voice, submit an asynchronous generation job, and download the finished video from your backend, automation, or AI agent.",[14,15,17],"h2",{"id":16},"how-the-visionstory-api-works","How the VisionStory API works",[10,19,20],{},"Every integration follows the same loop:",[22,23,24,32,47,61],"ol",{},[25,26,27,31],"li",{},[28,29,30],"strong",{},"Discover resources"," — list available models, avatars, and voices.",[25,33,34,37,38,42,43,46],{},[28,35,36],{},"Submit a generation task"," — ",[39,40,41],"code",{},"POST \u002Fapi\u002Fv1\u002Fvideo"," returns a ",[39,44,45],{},"video_id"," immediately.",[25,48,49,52,53,56,57,60],{},[28,50,51],{},"Poll until done"," — call ",[39,54,55],{},"GET \u002Fapi\u002Fv1\u002Fvideo?video_id=..."," until the status is ",[39,58,59],{},"created",".",[25,62,63,66,67,70],{},[28,64,65],{},"Download the result"," — fetch ",[39,68,69],{},"video_url"," from the response.",[10,72,73],{},"All requests go to one base URL and authenticate with one header:",[75,76,83],"pre",{"className":77,"code":79,"filename":80,"language":81,"meta":82},[78],"language-text","X-API-Key: $VISIONSTORY_API_KEY\n","Request header","text","",[39,84,79],{"__ignoreMap":82},[10,86,87,90,91],{},[28,88,89],{},"Base URL:"," ",[39,92,93],{},"https:\u002F\u002Fopenapi.visionstory.ai",[10,95,96,97,104],{},"Create your API key at ",[98,99,103],"a",{"href":100,"rel":101},"https:\u002F\u002Fwww.visionstory.ai\u002Fopenapi",[102],"nofollow","visionstory.ai\u002Fopenapi",". Keep the key on your server — never expose it in browser code or a public repository.",[10,106,107,108,111],{},"Every response shares one envelope. Read successful payloads from the top-level ",[39,109,110],{},"data"," field:",[75,113,117],{"className":114,"code":115,"language":116,"meta":82,"style":82},"language-json shiki shiki-themes github-light github-dark","{\n  \"data\": {\n    \"video_id\": \"YOUR_VIDEO_ID\"\n  },\n  \"message\": \"success\",\n  \"server_time\": \"2026-08-20T06:15:18Z\"\n}\n","json",[39,118,119,128,138,151,157,171,182],{"__ignoreMap":82},[120,121,124],"span",{"class":122,"line":123},"line",1,[120,125,127],{"class":126},"sVt8B","{\n",[120,129,131,135],{"class":122,"line":130},2,[120,132,134],{"class":133},"sj4cs","  \"data\"",[120,136,137],{"class":126},": {\n",[120,139,141,144,147],{"class":122,"line":140},3,[120,142,143],{"class":133},"    \"video_id\"",[120,145,146],{"class":126},": ",[120,148,150],{"class":149},"sZZnC","\"YOUR_VIDEO_ID\"\n",[120,152,154],{"class":122,"line":153},4,[120,155,156],{"class":126},"  },\n",[120,158,160,163,165,168],{"class":122,"line":159},5,[120,161,162],{"class":133},"  \"message\"",[120,164,146],{"class":126},[120,166,167],{"class":149},"\"success\"",[120,169,170],{"class":126},",\n",[120,172,174,177,179],{"class":122,"line":173},6,[120,175,176],{"class":133},"  \"server_time\"",[120,178,146],{"class":126},[120,180,181],{"class":149},"\"2026-08-20T06:15:18Z\"\n",[120,183,185],{"class":122,"line":184},7,[120,186,187],{"class":126},"}\n",[14,189,191],{"id":190},"core-api-resources","Core API resources",[193,194,196],"h3",{"id":195},"avatar","Avatar",[10,198,199],{},"An avatar is the on-screen character that speaks your script. Use a ready-made avatar from the public library, or create your own from a single photo:",[75,201,205],{"className":202,"code":203,"language":204,"meta":82,"style":82},"language-bash shiki shiki-themes github-light github-dark","curl -s -H \"X-API-Key: $VISIONSTORY_API_KEY\" https:\u002F\u002Fopenapi.visionstory.ai\u002Fapi\u002Fv1\u002Favatars\n","bash",[39,206,207],{"__ignoreMap":82},[120,208,209,213,216,219,222,225,228],{"class":122,"line":123},[120,210,212],{"class":211},"sScJk","curl",[120,214,215],{"class":133}," -s",[120,217,218],{"class":133}," -H",[120,220,221],{"class":149}," \"X-API-Key: ",[120,223,224],{"class":126},"$VISIONSTORY_API_KEY",[120,226,227],{"class":149},"\"",[120,229,230],{"class":149}," https:\u002F\u002Fopenapi.visionstory.ai\u002Fapi\u002Fv1\u002Favatars\n",[10,232,233,234,237,238,241],{},"The response contains ",[39,235,236],{},"public_avatars",", the curated library, and ",[39,239,240],{},"my_avatars",", the avatars you created.",[193,243,245],{"id":244},"voice","Voice",[10,247,248,249,252],{},"A voice is the ",[39,250,251],{},"voice_id"," that turns text into speech inside a video. Pick from the public voice library, or clone your own voice from an audio sample:",[75,254,256],{"className":202,"code":255,"language":204,"meta":82,"style":82},"curl -s -H \"X-API-Key: $VISIONSTORY_API_KEY\" https:\u002F\u002Fopenapi.visionstory.ai\u002Fapi\u002Fv1\u002Fvoices\n",[39,257,258],{"__ignoreMap":82},[120,259,260,262,264,266,268,270,272],{"class":122,"line":123},[120,261,212],{"class":211},[120,263,215],{"class":133},[120,265,218],{"class":133},[120,267,221],{"class":149},[120,269,224],{"class":126},[120,271,227],{"class":149},[120,273,274],{"class":149}," https:\u002F\u002Fopenapi.visionstory.ai\u002Fapi\u002Fv1\u002Fvoices\n",[10,276,233,277,280,281,60],{},[39,278,279],{},"public_voices"," and ",[39,282,283],{},"my_voices",[193,285,287],{"id":286},"credit","Credit",[10,289,290],{},"A credit is the billing unit for generation. Credits come with your VisionStory subscription; every generation task consumes credits, and a failed task refunds them automatically. Check your balance at any time:",[75,292,294],{"className":202,"code":293,"language":204,"meta":82,"style":82},"curl -s -H \"X-API-Key: $VISIONSTORY_API_KEY\" https:\u002F\u002Fopenapi.visionstory.ai\u002Fapi\u002Fv1\u002Fbilling\u002Fcredits\n",[39,295,296],{"__ignoreMap":82},[120,297,298,300,302,304,306,308,310],{"class":122,"line":123},[120,299,212],{"class":211},[120,301,215],{"class":133},[120,303,218],{"class":133},[120,305,221],{"class":149},[120,307,224],{"class":126},[120,309,227],{"class":149},[120,311,312],{"class":149}," https:\u002F\u002Fopenapi.visionstory.ai\u002Fapi\u002Fv1\u002Fbilling\u002Fcredits\n",[10,314,315,316,319],{},"The credits charged for a talking-avatar video are reported as ",[39,317,318],{},"cost_credit"," on its status response, so you can see the exact cost of every finished task.",[14,321,323],{"id":322},"talking-avatar-models","Talking avatar models",[10,325,326,327,330],{},"Talking-avatar models render your avatar. Query ",[39,328,329],{},"GET \u002Fapi\u002Fv1\u002Fmodels"," for the machine-readable catalog.",[332,333,334,356],"table",{},[335,336,337],"thead",{},[338,339,340,344,347,350,353],"tr",{},[341,342,343],"th",{},"model_id",[341,345,346],{},"Best for",[341,348,349],{},"Aspect ratios",[341,351,352],{},"Resolutions",[341,354,355],{},"Max duration",[357,358,359,379],"tbody",{},[338,360,361,367,370,373,376],{},[362,363,364],"td",{},[39,365,366],{},"vs_character_v4",[362,368,369],{},"Recommended default — improved motion quality and stability",[362,371,372],{},"9:16, 16:9, 1:1",[362,374,375],{},"720p, 1080p, 2k",[362,377,378],{},"600 s",[338,380,381,386,389,391,394],{},[362,382,383],{},[39,384,385],{},"vs_talk_v1",[362,387,388],{},"Speech Mode — focused mouth movement and clear lip-syncing",[362,390,372],{},[362,392,393],{},"480p, 720p, 1080p",[362,395,378],{},[10,397,398],{},"Beyond talking avatars, the API exposes frontier AI video generation models for text-to-video and image-to-video workflows. These capabilities are currently in beta.",[14,400,402],{"id":401},"start-building-with-the-visionstory-api","Start building with the VisionStory API",[404,405,406,413,420],"ul",{},[25,407,408,412],{},[98,409,411],{"href":410},"\u002Fguides\u002Fquick-start","Quick start"," — create your first video in five steps.",[25,414,415,419],{},[98,416,418],{"href":417},"\u002Freference","API reference"," — explore the available endpoints, schemas, and examples.",[25,421,422,426],{},[98,423,425],{"href":100,"rel":424},[102],"Get an API key"," — configure a server-side integration.",[428,429,430],"style",{},"html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}",{"title":82,"searchDepth":130,"depth":130,"links":432},[433,434,439,440],{"id":16,"depth":130,"text":17},{"id":190,"depth":130,"text":191,"children":435},[436,437,438],{"id":195,"depth":140,"text":196},{"id":244,"depth":140,"text":245},{"id":286,"depth":140,"text":287},{"id":322,"depth":130,"text":323},{"id":401,"depth":130,"text":402},"Learn how the VisionStory AI video API authenticates requests, creates talking avatar videos, polls jobs, and manages models, avatars, voices, and credits.","md",{},{"title":445,"order":123},"Overview","\u002Fguides\u002Foverview",{"title":5,"description":441},"guides\u002Foverview","HVbk6QqPPFdf3Vot_MlAsbeoymLIPFpwfPfQo25U8C4","\u003Cpre class=\"shiki github-dark-default\" style=\"background-color:#0d1117;color:#e6edf3\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan>X-API-Key: $VISIONSTORY_API_KEY\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>","\u003Cpre class=\"shiki github-dark-default\" style=\"background-color:#0d1117;color:#e6edf3\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:#E6EDF3\">{\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:#7EE787\">  \"data\"\u003C\u002Fspan>\u003Cspan style=\"color:#E6EDF3\">: {\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:#7EE787\">    \"video_id\"\u003C\u002Fspan>\u003Cspan style=\"color:#E6EDF3\">: \u003C\u002Fspan>\u003Cspan style=\"color:#A5D6FF\">\"YOUR_VIDEO_ID\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:#E6EDF3\">  },\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:#7EE787\">  \"message\"\u003C\u002Fspan>\u003Cspan style=\"color:#E6EDF3\">: \u003C\u002Fspan>\u003Cspan style=\"color:#A5D6FF\">\"success\"\u003C\u002Fspan>\u003Cspan style=\"color:#E6EDF3\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:#7EE787\">  \"server_time\"\u003C\u002Fspan>\u003Cspan style=\"color:#E6EDF3\">: \u003C\u002Fspan>\u003Cspan style=\"color:#A5D6FF\">\"2026-08-20T06:15:18Z\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:#E6EDF3\">}\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>","\u003Cpre class=\"shiki github-dark-default\" style=\"background-color:#0d1117;color:#e6edf3\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:#FFA657\">curl\u003C\u002Fspan>\u003Cspan style=\"color:#79C0FF\"> -s\u003C\u002Fspan>\u003Cspan style=\"color:#79C0FF\"> -H\u003C\u002Fspan>\u003Cspan style=\"color:#A5D6FF\"> \"X-API-Key: \u003C\u002Fspan>\u003Cspan style=\"color:#E6EDF3\">$VISIONSTORY_API_KEY\u003C\u002Fspan>\u003Cspan style=\"color:#A5D6FF\">\"\u003C\u002Fspan>\u003Cspan style=\"color:#A5D6FF\"> https:\u002F\u002Fopenapi.visionstory.ai\u002Fapi\u002Fv1\u002Favatars\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>","\u003Cpre class=\"shiki github-dark-default\" style=\"background-color:#0d1117;color:#e6edf3\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:#FFA657\">curl\u003C\u002Fspan>\u003Cspan style=\"color:#79C0FF\"> -s\u003C\u002Fspan>\u003Cspan style=\"color:#79C0FF\"> -H\u003C\u002Fspan>\u003Cspan style=\"color:#A5D6FF\"> \"X-API-Key: \u003C\u002Fspan>\u003Cspan style=\"color:#E6EDF3\">$VISIONSTORY_API_KEY\u003C\u002Fspan>\u003Cspan style=\"color:#A5D6FF\">\"\u003C\u002Fspan>\u003Cspan style=\"color:#A5D6FF\"> https:\u002F\u002Fopenapi.visionstory.ai\u002Fapi\u002Fv1\u002Fvoices\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>","\u003Cpre class=\"shiki github-dark-default\" style=\"background-color:#0d1117;color:#e6edf3\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:#FFA657\">curl\u003C\u002Fspan>\u003Cspan style=\"color:#79C0FF\"> -s\u003C\u002Fspan>\u003Cspan style=\"color:#79C0FF\"> -H\u003C\u002Fspan>\u003Cspan style=\"color:#A5D6FF\"> \"X-API-Key: \u003C\u002Fspan>\u003Cspan style=\"color:#E6EDF3\">$VISIONSTORY_API_KEY\u003C\u002Fspan>\u003Cspan style=\"color:#A5D6FF\">\"\u003C\u002Fspan>\u003Cspan style=\"color:#A5D6FF\"> https:\u002F\u002Fopenapi.visionstory.ai\u002Fapi\u002Fv1\u002Fbilling\u002Fcredits\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",1788166855860]