[{"data":1,"prerenderedAt":960},["ShallowReactive",2],{"docs-navigation-en-US":3,"/docs/start/quick-start":73,"/docs/start/quick-start-surround":956},[4],{"title":5,"path":6,"stem":7,"children":8,"page":26},"Docs","/docs","docs",[9,27,56,65],{"title":10,"path":11,"stem":12,"children":13,"page":26},"Getting Started","/docs/start","docs/1.start",[14,18,22],{"title":15,"path":16,"stem":17},"Quick Start","/docs/start/quick-start","docs/1.start/1.quick-start",{"title":19,"path":20,"stem":21},"Choosing an Integration","/docs/start/guide","docs/1.start/2.guide",{"title":23,"path":24,"stem":25},"Glossary","/docs/start/glossary","docs/1.start/3.glossary",false,{"title":28,"path":29,"stem":30,"children":31,"page":26},"Open API","/docs/api","docs/2.api",[32,36,40,44,48,52],{"title":33,"path":34,"stem":35},"V1 API Common Conventions","/docs/api/conventions","docs/2.api/1.conventions",{"title":37,"path":38,"stem":39},"Models API","/docs/api/models","docs/2.api/2.models",{"title":41,"path":42,"stem":43},"Text API","/docs/api/text","docs/2.api/3.text",{"title":45,"path":46,"stem":47},"Images API","/docs/api/images","docs/2.api/4.images",{"title":49,"path":50,"stem":51},"Videos API","/docs/api/videos","docs/2.api/5.videos",{"title":53,"path":54,"stem":55},"Audio API","/docs/api/audio","docs/2.api/6.audio",{"title":57,"path":58,"stem":59,"children":60,"page":26},"MCP Service","/docs/mcp","docs/3.mcp",[61],{"title":62,"path":63,"stem":64},"MCP Connection & Configuration","/docs/mcp/connection","docs/3.mcp/1.connection",{"title":66,"path":67,"stem":68,"children":69,"page":26},"Skills","/docs/skills","docs/4.skills",[70],{"title":66,"path":71,"stem":72},"/docs/skills/skills-intro","docs/4.skills/1.skills-intro",{"id":74,"title":15,"body":75,"description":951,"extension":952,"meta":953,"navigation":511,"path":16,"seo":954,"stem":17,"__hash__":955},"docs/docs/1.start/1.quick-start.md",{"type":76,"value":77,"toc":933},"minimark",[78,82,151,159,162,167,174,177,179,183,225,244,250,252,256,261,335,340,344,418,423,427,586,591,595,710,715,717,721,724,742,768,773,777,779,783,787,802,806,831,834,840,843,850,852,856,909,929],[79,80,81],"p",{},"The Guid AI gateway exposes three primary integration options:",[83,84,85,100],"table",{},[86,87,88],"thead",{},[89,90,91,95,98],"tr",{},[92,93,94],"th",{},"Option",[92,96,97],{},"Best for",[92,99,5],{},[101,102,103,122,136],"tbody",{},[89,104,105,112,115],{},[106,107,108],"td",{},[109,110,111],"strong",{},"V1 Open API",[106,113,114],{},"Backend, mobile, and third-party SDK integration",[106,116,117],{},[118,119,121],"a",{"href":120},"../api/conventions","Common Conventions",[89,123,124,128,131],{},[106,125,126],{},[109,127,66],{},[106,129,130],{},"Agents such as Claude, Cursor, Codex, OpenClaw, Hermes, and NemoClaw",[106,132,133],{},[118,134,66],{"href":135},"../skills/skills-intro",[89,137,138,142,145],{},[106,139,140],{},[109,141,57],{},[106,143,144],{},"Clients that connect via the MCP protocol",[106,146,147],{},[118,148,150],{"href":149},"../mcp/connection","Connection & Configuration",[79,152,153,154,158],{},"This guide helps you complete your first API call in about 5 minutes. Replace ",[155,156,157],"code",{},"sk-xxx"," in the examples with your API Key.",[160,161],"hr",{},[163,164,166],"h2",{"id":165},"_1-get-an-api-key","1. Get an API Key",[79,168,169,170,173],{},"Create an API Key (token) in the Guid AI admin console. The format is typically ",[155,171,172],{},"sk-xxxxxxxx",".",[79,175,176],{},"If you need to restrict models or configure an IP allowlist, finish those token settings before using the key in your integration.",[160,178],{},[163,180,182],{"id":181},"_2-list-available-models","2. List available models",[184,185,190],"pre",{"className":186,"code":187,"language":188,"meta":189,"style":189},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl https://www.guid.ai/v1/models \\\n  -H \"Authorization: Bearer sk-xxx\"\n","bash","",[155,191,192,209],{"__ignoreMap":189},[193,194,197,201,205],"span",{"class":195,"line":196},"line",1,[193,198,200],{"class":199},"sBMFI","curl",[193,202,204],{"class":203},"sfazB"," https://www.guid.ai/v1/models",[193,206,208],{"class":207},"sTEyZ"," \\\n",[193,210,212,215,219,222],{"class":195,"line":211},2,[193,213,214],{"class":203},"  -H",[193,216,218],{"class":217},"sMK4o"," \"",[193,220,221],{"class":203},"Authorization: Bearer sk-xxx",[193,223,224],{"class":217},"\"\n",[79,226,227,228,231,232,235,236,239,240,243],{},"A successful response returns ",[155,229,230],{},"success: true"," and a ",[155,233,234],{},"data[]"," model list. Note the ",[155,237,238],{},"data[].id"," you want to use, and check ",[155,241,242],{},"supported_endpoint_types"," to confirm the capabilities that model supports.",[79,245,246,247,173],{},"See ",[118,248,37],{"href":249},"../api/models",[160,251],{},[163,253,255],{"id":254},"_3-choose-your-first-endpoint-by-scenario","3. Choose your first endpoint by scenario",[257,258,260],"h3",{"id":259},"text-chat-most-common","Text chat (most common)",[184,262,264],{"className":186,"code":263,"language":188,"meta":189,"style":189},"curl https://www.guid.ai/v1/chat/completions \\\n  -H \"Authorization: Bearer sk-xxx\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"model\": \"gpt-4o\",\n    \"messages\": [{\"role\": \"user\", \"content\": \"Hello\"}]\n  }'\n",[155,265,266,275,288,302,314,320,326],{"__ignoreMap":189},[193,267,268,270,273],{"class":195,"line":196},[193,269,200],{"class":199},[193,271,272],{"class":203}," https://www.guid.ai/v1/chat/completions",[193,274,208],{"class":207},[193,276,277,279,281,283,286],{"class":195,"line":211},[193,278,214],{"class":203},[193,280,218],{"class":217},[193,282,221],{"class":203},[193,284,285],{"class":217},"\"",[193,287,208],{"class":207},[193,289,291,293,295,298,300],{"class":195,"line":290},3,[193,292,214],{"class":203},[193,294,218],{"class":217},[193,296,297],{"class":203},"Content-Type: application/json",[193,299,285],{"class":217},[193,301,208],{"class":207},[193,303,305,308,311],{"class":195,"line":304},4,[193,306,307],{"class":203},"  -d",[193,309,310],{"class":217}," '",[193,312,313],{"class":203},"{\n",[193,315,317],{"class":195,"line":316},5,[193,318,319],{"class":203},"    \"model\": \"gpt-4o\",\n",[193,321,323],{"class":195,"line":322},6,[193,324,325],{"class":203},"    \"messages\": [{\"role\": \"user\", \"content\": \"Hello\"}]\n",[193,327,329,332],{"class":195,"line":328},7,[193,330,331],{"class":203},"  }",[193,333,334],{"class":217},"'\n",[79,336,246,337,173],{},[118,338,41],{"href":339},"../api/text",[257,341,343],{"id":342},"text-to-image","Text-to-image",[184,345,347],{"className":186,"code":346,"language":188,"meta":189,"style":189},"curl https://www.guid.ai/v1/images/generations \\\n  -H \"Authorization: Bearer sk-xxx\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"model\": \"dall-e-3\",\n    \"prompt\": \"A cat on a windowsill\",\n    \"size\": \"1024x1024\",\n    \"response_format\": \"url\"\n  }'\n",[155,348,349,358,370,382,390,395,400,405,411],{"__ignoreMap":189},[193,350,351,353,356],{"class":195,"line":196},[193,352,200],{"class":199},[193,354,355],{"class":203}," https://www.guid.ai/v1/images/generations",[193,357,208],{"class":207},[193,359,360,362,364,366,368],{"class":195,"line":211},[193,361,214],{"class":203},[193,363,218],{"class":217},[193,365,221],{"class":203},[193,367,285],{"class":217},[193,369,208],{"class":207},[193,371,372,374,376,378,380],{"class":195,"line":290},[193,373,214],{"class":203},[193,375,218],{"class":217},[193,377,297],{"class":203},[193,379,285],{"class":217},[193,381,208],{"class":207},[193,383,384,386,388],{"class":195,"line":304},[193,385,307],{"class":203},[193,387,310],{"class":217},[193,389,313],{"class":203},[193,391,392],{"class":195,"line":316},[193,393,394],{"class":203},"    \"model\": \"dall-e-3\",\n",[193,396,397],{"class":195,"line":322},[193,398,399],{"class":203},"    \"prompt\": \"A cat on a windowsill\",\n",[193,401,402],{"class":195,"line":328},[193,403,404],{"class":203},"    \"size\": \"1024x1024\",\n",[193,406,408],{"class":195,"line":407},8,[193,409,410],{"class":203},"    \"response_format\": \"url\"\n",[193,412,414,416],{"class":195,"line":413},9,[193,415,331],{"class":203},[193,417,334],{"class":217},[79,419,246,420,173],{},[118,421,45],{"href":422},"../api/images",[257,424,426],{"id":425},"video-generation-async","Video generation (async)",[184,428,430],{"className":186,"code":429,"language":188,"meta":189,"style":189},"# 1. Create a task\ncurl https://www.guid.ai/v1/videos \\\n  -H \"Authorization: Bearer sk-xxx\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"model\": \"sora-2\",\n    \"prompt\": \"A cat walking on the beach at sunset\",\n    \"size\": \"1280x720\",\n    \"seconds\": 8\n  }'\n\n# 2. Poll status (replace task_xxx with the id returned above)\ncurl https://www.guid.ai/v1/videos/task_xxx \\\n  -H \"Authorization: Bearer sk-xxx\"\n\n# 3. Download when complete\ncurl -L https://www.guid.ai/v1/videos/task_xxx/content \\\n  -H \"Authorization: Bearer sk-xxx\" \\\n  -o output.mp4\n",[155,431,432,438,447,459,471,479,484,489,494,499,506,513,519,529,540,545,551,564,577],{"__ignoreMap":189},[193,433,434],{"class":195,"line":196},[193,435,437],{"class":436},"sHwdD","# 1. Create a task\n",[193,439,440,442,445],{"class":195,"line":211},[193,441,200],{"class":199},[193,443,444],{"class":203}," https://www.guid.ai/v1/videos",[193,446,208],{"class":207},[193,448,449,451,453,455,457],{"class":195,"line":290},[193,450,214],{"class":203},[193,452,218],{"class":217},[193,454,221],{"class":203},[193,456,285],{"class":217},[193,458,208],{"class":207},[193,460,461,463,465,467,469],{"class":195,"line":304},[193,462,214],{"class":203},[193,464,218],{"class":217},[193,466,297],{"class":203},[193,468,285],{"class":217},[193,470,208],{"class":207},[193,472,473,475,477],{"class":195,"line":316},[193,474,307],{"class":203},[193,476,310],{"class":217},[193,478,313],{"class":203},[193,480,481],{"class":195,"line":322},[193,482,483],{"class":203},"    \"model\": \"sora-2\",\n",[193,485,486],{"class":195,"line":328},[193,487,488],{"class":203},"    \"prompt\": \"A cat walking on the beach at sunset\",\n",[193,490,491],{"class":195,"line":407},[193,492,493],{"class":203},"    \"size\": \"1280x720\",\n",[193,495,496],{"class":195,"line":413},[193,497,498],{"class":203},"    \"seconds\": 8\n",[193,500,502,504],{"class":195,"line":501},10,[193,503,331],{"class":203},[193,505,334],{"class":217},[193,507,509],{"class":195,"line":508},11,[193,510,512],{"emptyLinePlaceholder":511},true,"\n",[193,514,516],{"class":195,"line":515},12,[193,517,518],{"class":436},"# 2. Poll status (replace task_xxx with the id returned above)\n",[193,520,522,524,527],{"class":195,"line":521},13,[193,523,200],{"class":199},[193,525,526],{"class":203}," https://www.guid.ai/v1/videos/task_xxx",[193,528,208],{"class":207},[193,530,532,534,536,538],{"class":195,"line":531},14,[193,533,214],{"class":203},[193,535,218],{"class":217},[193,537,221],{"class":203},[193,539,224],{"class":217},[193,541,543],{"class":195,"line":542},15,[193,544,512],{"emptyLinePlaceholder":511},[193,546,548],{"class":195,"line":547},16,[193,549,550],{"class":436},"# 3. Download when complete\n",[193,552,554,556,559,562],{"class":195,"line":553},17,[193,555,200],{"class":199},[193,557,558],{"class":203}," -L",[193,560,561],{"class":203}," https://www.guid.ai/v1/videos/task_xxx/content",[193,563,208],{"class":207},[193,565,567,569,571,573,575],{"class":195,"line":566},18,[193,568,214],{"class":203},[193,570,218],{"class":217},[193,572,221],{"class":203},[193,574,285],{"class":217},[193,576,208],{"class":207},[193,578,580,583],{"class":195,"line":579},19,[193,581,582],{"class":203},"  -o",[193,584,585],{"class":203}," output.mp4\n",[79,587,246,588,173],{},[118,589,49],{"href":590},"../api/videos",[257,592,594],{"id":593},"text-to-speech","Text-to-speech",[184,596,598],{"className":186,"code":597,"language":188,"meta":189,"style":189},"# 1. List voices\ncurl https://www.guid.ai/v1/audio/voice/tts-1 \\\n  -H \"Authorization: Bearer sk-xxx\"\n\n# 2. Synthesize speech\ncurl https://www.guid.ai/v1/audio/speech \\\n  -H \"Authorization: Bearer sk-xxx\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"model\": \"tts-1\",\n    \"input\": \"Hello world\",\n    \"voice\": \"alloy\",\n    \"response_format\": \"mp3\"\n  }' \\\n  -o speech.mp3\n",[155,599,600,605,614,624,628,633,642,654,666,674,679,684,689,694,703],{"__ignoreMap":189},[193,601,602],{"class":195,"line":196},[193,603,604],{"class":436},"# 1. List voices\n",[193,606,607,609,612],{"class":195,"line":211},[193,608,200],{"class":199},[193,610,611],{"class":203}," https://www.guid.ai/v1/audio/voice/tts-1",[193,613,208],{"class":207},[193,615,616,618,620,622],{"class":195,"line":290},[193,617,214],{"class":203},[193,619,218],{"class":217},[193,621,221],{"class":203},[193,623,224],{"class":217},[193,625,626],{"class":195,"line":304},[193,627,512],{"emptyLinePlaceholder":511},[193,629,630],{"class":195,"line":316},[193,631,632],{"class":436},"# 2. Synthesize speech\n",[193,634,635,637,640],{"class":195,"line":322},[193,636,200],{"class":199},[193,638,639],{"class":203}," https://www.guid.ai/v1/audio/speech",[193,641,208],{"class":207},[193,643,644,646,648,650,652],{"class":195,"line":328},[193,645,214],{"class":203},[193,647,218],{"class":217},[193,649,221],{"class":203},[193,651,285],{"class":217},[193,653,208],{"class":207},[193,655,656,658,660,662,664],{"class":195,"line":407},[193,657,214],{"class":203},[193,659,218],{"class":217},[193,661,297],{"class":203},[193,663,285],{"class":217},[193,665,208],{"class":207},[193,667,668,670,672],{"class":195,"line":413},[193,669,307],{"class":203},[193,671,310],{"class":217},[193,673,313],{"class":203},[193,675,676],{"class":195,"line":501},[193,677,678],{"class":203},"    \"model\": \"tts-1\",\n",[193,680,681],{"class":195,"line":508},[193,682,683],{"class":203},"    \"input\": \"Hello world\",\n",[193,685,686],{"class":195,"line":515},[193,687,688],{"class":203},"    \"voice\": \"alloy\",\n",[193,690,691],{"class":195,"line":521},[193,692,693],{"class":203},"    \"response_format\": \"mp3\"\n",[193,695,696,698,701],{"class":195,"line":531},[193,697,331],{"class":203},[193,699,700],{"class":217},"'",[193,702,208],{"class":207},[193,704,705,707],{"class":195,"line":542},[193,706,582],{"class":203},[193,708,709],{"class":203}," speech.mp3\n",[79,711,246,712,173],{},[118,713,53],{"href":714},"../api/audio",[160,716],{},[163,718,720],{"id":719},"_4-use-skills-in-an-agent-optional","4. Use Skills in an Agent (optional)",[79,722,723],{},"If you use Agent platforms such as Claude, Cursor, Codex, OpenClaw, Hermes, or NemoClaw:",[725,726,727,735],"ol",{},[728,729,730,731,734],"li",{},"Download and extract ",[155,732,733],{},"guid-ai-skills.zip"," into the Agent's Skills directory",[728,736,737,738,741],{},"Configure ",[155,739,740],{},"guid-ai-skills/.env",":",[184,743,745],{"className":186,"code":744,"language":188,"meta":189,"style":189},"GUIDAI_BASE_URL=https://www.guid.ai\nGUIDAI_API_KEY=sk-xxx\n",[155,746,747,758],{"__ignoreMap":189},[193,748,749,752,755],{"class":195,"line":196},[193,750,751],{"class":207},"GUIDAI_BASE_URL",[193,753,754],{"class":217},"=",[193,756,757],{"class":203},"https://www.guid.ai\n",[193,759,760,763,765],{"class":195,"line":211},[193,761,762],{"class":207},"GUIDAI_API_KEY",[193,764,754],{"class":217},[193,766,767],{"class":203},"sk-xxx\n",[725,769,770],{"start":290},[728,771,772],{},"Describe your generation needs directly in the conversation",[79,774,246,775,173],{},[118,776,66],{"href":135},[160,778],{},[163,780,782],{"id":781},"_5-documentation-map","5. Documentation map",[257,784,786],{"id":785},"getting-started","Getting started",[788,789,790,796],"ul",{},[728,791,792,795],{},[118,793,19],{"href":794},"./guide"," — REST vs Skills vs MCP",[728,797,798,801],{},[118,799,23],{"href":800},"./glossary"," — Common concepts",[257,803,805],{"id":804},"v1-open-api-12-endpoints","V1 Open API (12 endpoints)",[788,807,808,813],{},[728,809,810,812],{},[118,811,121],{"href":120}," — Auth, errors, billing, shared objects",[728,814,815,818,819,818,822,818,825,818,828],{},[118,816,817],{"href":249},"Models"," · ",[118,820,821],{"href":339},"Text",[118,823,824],{"href":422},"Images",[118,826,827],{"href":590},"Videos",[118,829,830],{"href":714},"Audio",[257,832,57],{"id":833},"mcp-service",[788,835,836],{},[728,837,838],{},[118,839,150],{"href":149},[257,841,66],{"id":842},"skills",[788,844,845],{},[728,846,847],{},[118,848,849],{"href":135},"Skills Introduction",[160,851],{},[163,853,855],{"id":854},"_6-next-steps","6. Next steps",[83,857,858,868],{},[86,859,860],{},[89,861,862,865],{},[92,863,864],{},"Goal",[92,866,867],{},"Read",[101,869,870,879,889,898],{},[89,871,872,875],{},[106,873,874],{},"Decide between REST / Skills",[106,876,877],{},[118,878,19],{"href":794},[89,880,881,884],{},[106,882,883],{},"Look up full endpoint parameters",[106,885,886],{},[118,887,888],{"href":249},"API capability docs",[89,890,891,894],{},[106,892,893],{},"Call multimodal generation from an Agent",[106,895,896],{},[118,897,66],{"href":135},[89,899,900,903],{},[106,901,902],{},"Understand errors and billing",[106,904,905],{},[118,906,908],{"href":907},"../api/conventions#error-responses","Common Conventions · Error Responses",[79,910,911,914,915,918,919,921,922,925,926],{},[109,912,913],{},"Quick conventions",": Base URL ",[155,916,917],{},"https://www.guid.ai"," · Auth ",[155,920,221],{}," · Public API ",[155,923,924],{},"/v1/*"," · MCP ",[155,927,928],{},"/mcp",[930,931,932],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}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 .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}",{"title":189,"searchDepth":211,"depth":211,"links":934},[935,936,937,943,944,950],{"id":165,"depth":211,"text":166},{"id":181,"depth":211,"text":182},{"id":254,"depth":211,"text":255,"children":938},[939,940,941,942],{"id":259,"depth":290,"text":260},{"id":342,"depth":290,"text":343},{"id":425,"depth":290,"text":426},{"id":593,"depth":290,"text":594},{"id":719,"depth":211,"text":720},{"id":781,"depth":211,"text":782,"children":945},[946,947,948,949],{"id":785,"depth":290,"text":786},{"id":804,"depth":290,"text":805},{"id":833,"depth":290,"text":57},{"id":842,"depth":290,"text":66},{"id":854,"depth":211,"text":855},"Complete your first API call in 5 minutes, and learn about the V1 API, Skills, and MCP integration options","md",{},{"title":15,"description":951},"gFoTWQCtFfaARaaHXm0Nkr_JZUmrJD3g3Yy0ehmK6HA",[957,958],null,{"title":19,"path":20,"stem":21,"description":959,"children":-1},"Choose V1 Open API, Skills, or MCP based on your use case",1785407605958]