[{"data":1,"prerenderedAt":2370},["ShallowReactive",2],{"docs-navigation-en-US":3,"/docs/api/conventions":73,"/docs/api/conventions-surround":2365},[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":33,"body":75,"description":2359,"extension":2360,"meta":2361,"navigation":2362,"path":34,"seo":2363,"stem":35,"__hash__":2364},"docs/docs/2.api/1.conventions.md",{"type":76,"value":77,"toc":2333},"minimark",[78,87,102,105,110,115,125,132,136,142,156,223,240,244,307,311,328,330,334,341,344,529,535,618,620,624,628,648,778,863,867,873,921,959,971,975,983,1027,1067,1069,1073,1083,1124,1136,1138,1144,1147,1154,1159,1162,1166,1197,1201,1206,1350,1354,1455,1457,1462,1477,1483,1486,1652,1655,1683,1686,1690,2036,2039,2284,2288,2329],[79,80,81,82,86],"p",{},"This document describes authentication, billing, shared objects, and error response formats for the V1 Open API (",[83,84,85],"code",{},"/v1/*",").",[79,88,89,93,94,97,98,101],{},[90,91,92],"strong",{},"Scope",": Public ",[83,95,96],{},"/v1"," Relay endpoints — ",[90,99,100],{},"12"," in total.",[103,104],"hr",{},[106,107,109],"h2",{"id":108},"common-conventions","Common conventions",[111,112,114],"h3",{"id":113},"base-url","Base URL",[116,117,122],"pre",{"className":118,"code":120,"language":121},[119],"language-text","https://www.guid.ai\n","text",[83,123,120],{"__ignoreMap":124},"",[79,126,127,128,131],{},"Endpoints are mounted at the domain root, e.g. ",[83,129,130],{},"POST https://www.guid.ai/v1/chat/completions",".",[111,133,135],{"id":134},"authentication","Authentication",[79,137,138,139,141],{},"All public ",[83,140,96],{}," endpoints use Bearer Token:",[116,143,147],{"className":144,"code":145,"language":146,"meta":124,"style":124},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","Authorization: Bearer sk-xxxxxxxxxxxxxxxx\n","http",[83,148,149],{"__ignoreMap":124},[150,151,154],"span",{"class":152,"line":153},"line",1,[150,155,145],{},[157,158,159,172],"table",{},[160,161,162],"thead",{},[163,164,165,169],"tr",{},[166,167,168],"th",{},"Rule",[166,170,171],{},"Description",[173,174,175,184,192,208],"tbody",{},[163,176,177,181],{},[178,179,180],"td",{},"Token validation",[178,182,183],{},"Validates API Key, user status, and balance/quota",[163,185,186,189],{},[178,187,188],{},"IP allowlist",[178,190,191],{},"If the token has an IP allowlist, the request source is checked",[163,193,194,197],{},[178,195,196],{},"Channel override",[178,198,199,200,203,204,207],{},"Admins may append ",[83,201,202],{},"-{channelId}"," after the Key (e.g. ",[83,205,206],{},"sk-xxx-6","); regular users cannot",[163,209,210,213],{},[178,211,212],{},"Auth failure",[178,214,215,216,219,220],{},"Returns HTTP ",[83,217,218],{},"401"," / ",[83,221,222],{},"403",[79,224,225,228,229,232,233,236,237,131],{},[90,226,227],{},"Exception",": ",[83,230,231],{},"GET /v1/videos/{task_id}/content"," supports both an ",[90,234,235],{},"admin console Session"," and a ",[90,238,239],{},"Bearer Token",[111,241,243],{"id":242},"content-type","Content-Type",[157,245,246,255],{},[160,247,248],{},[163,249,250,253],{},[166,251,252],{},"Scenario",[166,254,243],{},[173,256,257,267,277,296],{},[163,258,259,262],{},[178,260,261],{},"JSON request",[178,263,264],{},[83,265,266],{},"application/json",[163,268,269,272],{},[178,270,271],{},"Image edit / video create with files",[178,273,274],{},[83,275,276],{},"multipart/form-data",[163,278,279,282],{},[178,280,281],{},"TTS response",[178,283,284,287,288,291,292,295],{},[83,285,286],{},"audio/mpeg",", ",[83,289,290],{},"audio/wav",", etc. (depends on ",[83,293,294],{},"response_format",")",[163,297,298,301],{},[178,299,300],{},"Chat / Responses streaming",[178,302,303,306],{},[83,304,305],{},"text/event-stream"," (SSE)",[111,308,310],{"id":309},"billing","Billing",[312,313,314,322,325],"ul",{},[315,316,317,318,321],"li",{},"The gateway selects an upstream channel automatically based on ",[83,319,320],{},"model"," in the request body (or path parameter)",[315,323,324],{},"Supports token-based, per-request, per-second, and other billing strategies",[315,326,327],{},"Different API Keys may see different model lists",[103,329],{},[106,331,333],{"id":332},"shared-response-objects","Shared response objects",[111,335,337,340],{"id":336},"usage-token-billing",[83,338,339],{},"usage"," (token billing)",[79,342,343],{},"Common in text endpoint responses (Chat / Completions / Responses):",[157,345,346,358],{},[160,347,348],{},[163,349,350,353,356],{},[166,351,352],{},"Field",[166,354,355],{},"Type",[166,357,171],{},[173,359,360,373,385,397,409,421,433,446,458,470,482,494,506,518],{},[163,361,362,367,370],{},[178,363,364],{},[83,365,366],{},"prompt_tokens",[178,368,369],{},"integer",[178,371,372],{},"Input token count (Completions / Chat)",[163,374,375,380,382],{},[178,376,377],{},[83,378,379],{},"completion_tokens",[178,381,369],{},[178,383,384],{},"Output token count (Completions / Chat)",[163,386,387,392,394],{},[178,388,389],{},[83,390,391],{},"total_tokens",[178,393,369],{},[178,395,396],{},"Total token count",[163,398,399,404,406],{},[178,400,401],{},[83,402,403],{},"input_tokens",[178,405,369],{},[178,407,408],{},"Input token count (Responses)",[163,410,411,416,418],{},[178,412,413],{},[83,414,415],{},"output_tokens",[178,417,369],{},[178,419,420],{},"Output token count (Responses)",[163,422,423,428,430],{},[178,424,425],{},[83,426,427],{},"prompt_cache_hit_tokens",[178,429,369],{},[178,431,432],{},"Cached input tokens (some models)",[163,434,435,440,443],{},[178,436,437],{},[83,438,439],{},"prompt_tokens_details",[178,441,442],{},"object",[178,444,445],{},"Input token breakdown",[163,447,448,453,455],{},[178,449,450],{},[83,451,452],{},"prompt_tokens_details.cached_tokens",[178,454,369],{},[178,456,457],{},"Cached token count",[163,459,460,465,467],{},[178,461,462],{},[83,463,464],{},"prompt_tokens_details.text_tokens",[178,466,369],{},[178,468,469],{},"Text token count",[163,471,472,477,479],{},[178,473,474],{},[83,475,476],{},"prompt_tokens_details.audio_tokens",[178,478,369],{},[178,480,481],{},"Audio token count",[163,483,484,489,491],{},[178,485,486],{},[83,487,488],{},"prompt_tokens_details.image_tokens",[178,490,369],{},[178,492,493],{},"Image token count",[163,495,496,501,503],{},[178,497,498],{},[83,499,500],{},"completion_tokens_details",[178,502,442],{},[178,504,505],{},"Output token breakdown",[163,507,508,513,515],{},[178,509,510],{},[83,511,512],{},"completion_tokens_details.reasoning_tokens",[178,514,369],{},[178,516,517],{},"Reasoning token count",[163,519,520,525,527],{},[178,521,522],{},[83,523,524],{},"completion_tokens_details.text_tokens",[178,526,369],{},[178,528,469],{},[111,530,532,534],{"id":531},"usage-per-request-billing-images",[83,533,339],{}," (per-request billing, images)",[157,536,537,547],{},[160,538,539],{},[163,540,541,543,545],{},[166,542,352],{},[166,544,355],{},[166,546,171],{},[173,548,549,561,573,585,596,607],{},[163,550,551,556,558],{},[178,552,553],{},[83,554,555],{},"quota_type",[178,557,369],{},[178,559,560],{},"Billing type identifier",[163,562,563,568,570],{},[178,564,565],{},[83,566,567],{},"quota",[178,569,369],{},[178,571,572],{},"Quota consumed by this request",[163,574,575,580,582],{},[178,576,577],{},[83,578,579],{},"request_count",[178,581,369],{},[178,583,584],{},"Request count, usually 1",[163,586,587,591,593],{},[178,588,589],{},[83,590,366],{},[178,592,369],{},[178,594,595],{},"Input tokens (usually 0 for image endpoints)",[163,597,598,602,604],{},[178,599,600],{},[83,601,379],{},[178,603,369],{},[178,605,606],{},"Output tokens (usually 0 for image endpoints)",[163,608,609,613,615],{},[178,610,611],{},[83,612,391],{},[178,614,369],{},[178,616,617],{},"Total tokens (usually 0 for image endpoints)",[103,619],{},[106,621,623],{"id":622},"error-responses","Error responses",[111,625,627],{"id":626},"standard-errors-text-images-audio-video-content","Standard errors (text / images / audio / video content)",[79,629,630,631,287,634,287,636,287,638,287,641,287,644,647],{},"HTTP status codes: ",[83,632,633],{},"400",[83,635,218],{},[83,637,222],{},[83,639,640],{},"404",[83,642,643],{},"429",[83,645,646],{},"500",", etc.",[116,649,653],{"className":650,"code":651,"language":652,"meta":124,"style":124},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"error\": {\n    \"message\": \"Invalid request\",\n    \"type\": \"invalid_request_error\",\n    \"code\": \"invalid_request\",\n    \"param\": \"model\"\n  }\n}\n","json",[83,654,655,661,680,706,727,747,766,772],{"__ignoreMap":124},[150,656,657],{"class":152,"line":153},[150,658,660],{"class":659},"sMK4o","{\n",[150,662,664,667,671,674,677],{"class":152,"line":663},2,[150,665,666],{"class":659},"  \"",[150,668,670],{"class":669},"spNyl","error",[150,672,673],{"class":659},"\"",[150,675,676],{"class":659},":",[150,678,679],{"class":659}," {\n",[150,681,683,686,690,692,694,697,701,703],{"class":152,"line":682},3,[150,684,685],{"class":659},"    \"",[150,687,689],{"class":688},"sBMFI","message",[150,691,673],{"class":659},[150,693,676],{"class":659},[150,695,696],{"class":659}," \"",[150,698,700],{"class":699},"sfazB","Invalid request",[150,702,673],{"class":659},[150,704,705],{"class":659},",\n",[150,707,709,711,714,716,718,720,723,725],{"class":152,"line":708},4,[150,710,685],{"class":659},[150,712,713],{"class":688},"type",[150,715,673],{"class":659},[150,717,676],{"class":659},[150,719,696],{"class":659},[150,721,722],{"class":699},"invalid_request_error",[150,724,673],{"class":659},[150,726,705],{"class":659},[150,728,730,732,734,736,738,740,743,745],{"class":152,"line":729},5,[150,731,685],{"class":659},[150,733,83],{"class":688},[150,735,673],{"class":659},[150,737,676],{"class":659},[150,739,696],{"class":659},[150,741,742],{"class":699},"invalid_request",[150,744,673],{"class":659},[150,746,705],{"class":659},[150,748,750,752,755,757,759,761,763],{"class":152,"line":749},6,[150,751,685],{"class":659},[150,753,754],{"class":688},"param",[150,756,673],{"class":659},[150,758,676],{"class":659},[150,760,696],{"class":659},[150,762,320],{"class":699},[150,764,765],{"class":659},"\"\n",[150,767,769],{"class":152,"line":768},7,[150,770,771],{"class":659},"  }\n",[150,773,775],{"class":152,"line":774},8,[150,776,777],{"class":659},"}\n",[157,779,780,790],{},[160,781,782],{},[163,783,784,786,788],{},[166,785,352],{},[166,787,355],{},[166,789,171],{},[173,791,792,805,822,839,851],{},[163,793,794,799,802],{},[178,795,796],{},[83,797,798],{},"error.message",[178,800,801],{},"string",[178,803,804],{},"Human-readable error description",[163,806,807,812,814],{},[178,808,809],{},[83,810,811],{},"error.type",[178,813,801],{},[178,815,816,817,287,819],{},"Error type, e.g. ",[83,818,722],{},[83,820,821],{},"insufficient_quota",[163,823,824,829,831],{},[178,825,826],{},[83,827,828],{},"error.code",[178,830,801],{},[178,832,833,834,287,836],{},"Error code, e.g. ",[83,835,742],{},[83,837,838],{},"model_not_found",[163,840,841,846,848],{},[178,842,843],{},[83,844,845],{},"error.param",[178,847,801],{},[178,849,850],{},"Request field that caused the error (if any)",[163,852,853,858,860],{},[178,854,855],{},[83,856,857],{},"error.metadata",[178,859,442],{},[178,861,862],{},"Extended metadata (returned by some upstreams)",[111,864,866],{"id":865},"task-errors-video-task-create-query-failure","Task errors (video task create / query failure)",[79,868,630,869,287,871,647],{},[83,870,633],{},[83,872,643],{},[116,874,876],{"className":650,"code":875,"language":652,"meta":124,"style":124},"{\n  \"code\": \"invalid_request\",\n  \"message\": \"model is required\"\n}\n",[83,877,878,882,900,917],{"__ignoreMap":124},[150,879,880],{"class":152,"line":153},[150,881,660],{"class":659},[150,883,884,886,888,890,892,894,896,898],{"class":152,"line":663},[150,885,666],{"class":659},[150,887,83],{"class":669},[150,889,673],{"class":659},[150,891,676],{"class":659},[150,893,696],{"class":659},[150,895,742],{"class":699},[150,897,673],{"class":659},[150,899,705],{"class":659},[150,901,902,904,906,908,910,912,915],{"class":152,"line":682},[150,903,666],{"class":659},[150,905,689],{"class":669},[150,907,673],{"class":659},[150,909,676],{"class":659},[150,911,696],{"class":659},[150,913,914],{"class":699},"model is required",[150,916,765],{"class":659},[150,918,919],{"class":152,"line":708},[150,920,777],{"class":659},[157,922,923,933],{},[160,924,925],{},[163,926,927,929,931],{},[166,928,352],{},[166,930,355],{},[166,932,171],{},[173,934,935,948],{},[163,936,937,941,943],{},[178,938,939],{},[83,940,83],{},[178,942,801],{},[178,944,945,946],{},"Error code; commonly ",[83,947,742],{},[163,949,950,954,956],{},[178,951,952],{},[83,953,689],{},[178,955,801],{},[178,957,958],{},"Error description",[79,960,961,962,287,964,966,967,970],{},"On HTTP ",[83,963,643],{},[83,965,689],{}," is: ",[83,968,969],{},"当前分组上游负载已饱和，请稍后再试"," (upstream load for the current group is saturated; try again later).",[111,972,974],{"id":973},"gateway-extended-errors-model-list-voice-list-etc","Gateway extended errors (model list, voice list, etc.)",[79,976,630,977,980,981,131],{},[83,978,979],{},"200"," (business failure) or ",[83,982,633],{},[116,984,986],{"className":650,"code":985,"language":652,"meta":124,"style":124},"{\n  \"success\": false,\n  \"message\": \"get user group failed\"\n}\n",[83,987,988,992,1006,1023],{"__ignoreMap":124},[150,989,990],{"class":152,"line":153},[150,991,660],{"class":659},[150,993,994,996,999,1001,1003],{"class":152,"line":663},[150,995,666],{"class":659},[150,997,998],{"class":669},"success",[150,1000,673],{"class":659},[150,1002,676],{"class":659},[150,1004,1005],{"class":659}," false,\n",[150,1007,1008,1010,1012,1014,1016,1018,1021],{"class":152,"line":682},[150,1009,666],{"class":659},[150,1011,689],{"class":669},[150,1013,673],{"class":659},[150,1015,676],{"class":659},[150,1017,696],{"class":659},[150,1019,1020],{"class":699},"get user group failed",[150,1022,765],{"class":659},[150,1024,1025],{"class":152,"line":708},[150,1026,777],{"class":659},[157,1028,1029,1039],{},[160,1030,1031],{},[163,1032,1033,1035,1037],{},[166,1034,352],{},[166,1036,355],{},[166,1038,171],{},[173,1040,1041,1057],{},[163,1042,1043,1047,1050],{},[178,1044,1045],{},[83,1046,998],{},[178,1048,1049],{},"boolean",[178,1051,1052,1053,1056],{},"Whether the call succeeded; ",[83,1054,1055],{},"false"," means failure",[163,1058,1059,1063,1065],{},[178,1060,1061],{},[83,1062,689],{},[178,1064,801],{},[178,1066,958],{},[103,1068],{},[106,1070,1072],{"id":1071},"token-balance-usage-details","Token balance & usage details",[79,1074,1075,1076,1078,1079,1082],{},"In addition to Relay endpoints, V1 provides two query endpoints. Authentication matches other ",[83,1077,96],{}," APIs: ",[83,1080,1081],{},"Authorization: Bearer sk-xxxxxxxx",". Each request can only query data for the current Bearer token.",[157,1084,1085,1097],{},[160,1086,1087],{},[163,1088,1089,1092,1095],{},[166,1090,1091],{},"Method",[166,1093,1094],{},"Path",[166,1096,171],{},[173,1098,1099,1112],{},[163,1100,1101,1104,1109],{},[178,1102,1103],{},"GET",[178,1105,1106],{},[83,1107,1108],{},"/v1/token/balance",[178,1110,1111],{},"Query token balance (⚡)",[163,1113,1114,1116,1121],{},[178,1115,1103],{},[178,1117,1118],{},[83,1119,1120],{},"/v1/token/consume",[178,1122,1123],{},"Query current API Key consume records (paginated)",[1125,1126,1127],"blockquote",{},[79,1128,1129,1131,1132,1135],{},[90,1130,135],{},": Use Bearer Token. The token is resolved by the auth middleware — do not pass a ",[83,1133,1134],{},"key"," query parameter.",[103,1137],{},[111,1139,1141,1142],{"id":1140},"get-v1tokenbalance","GET ",[83,1143,1108],{},[79,1145,1146],{},"Query the balance of the current Bearer token, returning the remaining and used quota in ⚡.",[79,1148,1149,228,1152],{},[90,1150,1151],{},"Auth",[83,1153,1081],{},[1155,1156,1158],"h4",{"id":1157},"request-parameters","Request parameters",[79,1160,1161],{},"No query parameters.",[1155,1163,1165],{"id":1164},"request-example-curl","Request example (curl)",[116,1167,1171],{"className":1168,"code":1169,"language":1170,"meta":124,"style":124},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl https://www.guid.ai/v1/token/balance \\\n  -H \"Authorization: Bearer sk-xxxxx\"\n","bash",[83,1172,1173,1185],{"__ignoreMap":124},[150,1174,1175,1178,1181],{"class":152,"line":153},[150,1176,1177],{"class":688},"curl",[150,1179,1180],{"class":699}," https://www.guid.ai/v1/token/balance",[150,1182,1184],{"class":1183},"sTEyZ"," \\\n",[150,1186,1187,1190,1192,1195],{"class":152,"line":663},[150,1188,1189],{"class":699},"  -H",[150,1191,696],{"class":659},[150,1193,1194],{"class":699},"Authorization: Bearer sk-xxxxx",[150,1196,765],{"class":659},[1155,1198,1200],{"id":1199},"response-body","Response body",[79,1202,1203,1204],{},"HTTP ",[83,1205,979],{},[116,1207,1209],{"className":650,"code":1208,"language":652,"meta":124,"style":124},"{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": {\n    \"id\": 1,\n    \"name\": \"API Token\",\n    \"remain_quota_usd\": 0.2,\n    \"used_quota_usd\": 0.1,\n    \"unlimited_quota\": false\n  }\n}\n",[83,1210,1211,1215,1228,1243,1256,1273,1293,1309,1325,1340,1345],{"__ignoreMap":124},[150,1212,1213],{"class":152,"line":153},[150,1214,660],{"class":659},[150,1216,1217,1219,1221,1223,1225],{"class":152,"line":663},[150,1218,666],{"class":659},[150,1220,998],{"class":669},[150,1222,673],{"class":659},[150,1224,676],{"class":659},[150,1226,1227],{"class":659}," true,\n",[150,1229,1230,1232,1234,1236,1238,1241],{"class":152,"line":682},[150,1231,666],{"class":659},[150,1233,689],{"class":669},[150,1235,673],{"class":659},[150,1237,676],{"class":659},[150,1239,1240],{"class":659}," \"\"",[150,1242,705],{"class":659},[150,1244,1245,1247,1250,1252,1254],{"class":152,"line":708},[150,1246,666],{"class":659},[150,1248,1249],{"class":669},"data",[150,1251,673],{"class":659},[150,1253,676],{"class":659},[150,1255,679],{"class":659},[150,1257,1258,1260,1263,1265,1267,1271],{"class":152,"line":729},[150,1259,685],{"class":659},[150,1261,1262],{"class":688},"id",[150,1264,673],{"class":659},[150,1266,676],{"class":659},[150,1268,1270],{"class":1269},"sbssI"," 1",[150,1272,705],{"class":659},[150,1274,1275,1277,1280,1282,1284,1286,1289,1291],{"class":152,"line":749},[150,1276,685],{"class":659},[150,1278,1279],{"class":688},"name",[150,1281,673],{"class":659},[150,1283,676],{"class":659},[150,1285,696],{"class":659},[150,1287,1288],{"class":699},"API Token",[150,1290,673],{"class":659},[150,1292,705],{"class":659},[150,1294,1295,1297,1300,1302,1304,1307],{"class":152,"line":768},[150,1296,685],{"class":659},[150,1298,1299],{"class":688},"remain_quota_usd",[150,1301,673],{"class":659},[150,1303,676],{"class":659},[150,1305,1306],{"class":1269}," 0.2",[150,1308,705],{"class":659},[150,1310,1311,1313,1316,1318,1320,1323],{"class":152,"line":774},[150,1312,685],{"class":659},[150,1314,1315],{"class":688},"used_quota_usd",[150,1317,673],{"class":659},[150,1319,676],{"class":659},[150,1321,1322],{"class":1269}," 0.1",[150,1324,705],{"class":659},[150,1326,1328,1330,1333,1335,1337],{"class":152,"line":1327},9,[150,1329,685],{"class":659},[150,1331,1332],{"class":688},"unlimited_quota",[150,1334,673],{"class":659},[150,1336,676],{"class":659},[150,1338,1339],{"class":659}," false\n",[150,1341,1343],{"class":152,"line":1342},10,[150,1344,771],{"class":659},[150,1346,1348],{"class":152,"line":1347},11,[150,1349,777],{"class":659},[1155,1351,1353],{"id":1352},"response-fields","Response fields",[157,1355,1356,1366],{},[160,1357,1358],{},[163,1359,1360,1362,1364],{},[166,1361,352],{},[166,1363,355],{},[166,1365,171],{},[173,1367,1368,1379,1390,1402,1414,1431,1443],{},[163,1369,1370,1374,1376],{},[178,1371,1372],{},[83,1373,998],{},[178,1375,1049],{},[178,1377,1378],{},"Whether the call succeeded",[163,1380,1381,1385,1387],{},[178,1382,1383],{},[83,1384,689],{},[178,1386,801],{},[178,1388,1389],{},"Status message",[163,1391,1392,1397,1399],{},[178,1393,1394],{},[83,1395,1396],{},"data.id",[178,1398,369],{},[178,1400,1401],{},"Token ID",[163,1403,1404,1409,1411],{},[178,1405,1406],{},[83,1407,1408],{},"data.name",[178,1410,801],{},[178,1412,1413],{},"Token name",[163,1415,1416,1421,1424],{},[178,1417,1418],{},[83,1419,1420],{},"data.remain_quota_usd",[178,1422,1423],{},"number",[178,1425,1426,1427,1430],{},"Remaining quota (⚡). Always ",[83,1428,1429],{},"0"," for unlimited tokens",[163,1432,1433,1438,1440],{},[178,1434,1435],{},[83,1436,1437],{},"data.used_quota_usd",[178,1439,1423],{},[178,1441,1442],{},"Used quota (⚡)",[163,1444,1445,1450,1452],{},[178,1446,1447],{},[83,1448,1449],{},"data.unlimited_quota",[178,1451,1049],{},[178,1453,1454],{},"Whether the token has unlimited quota",[103,1456],{},[111,1458,1141,1460],{"id":1459},"get-v1tokenconsume",[83,1461,1120],{},[79,1463,1464,1465,1468,1469,1472,1473,1476],{},"Paginated query of ",[90,1466,1467],{},"consume records for the current Bearer API Key"," (",[83,1470,1471],{},"type = 2"," only). Filtered by ",[83,1474,1475],{},"token_id"," — does not return the owning user's top-up/income wallet logs, and does not aggregate consume logs from the user's other keys.",[79,1478,1479,228,1481],{},[90,1480,1151],{},[83,1482,1081],{},[1155,1484,1158],{"id":1485},"request-parameters-1",[157,1487,1488,1502],{},[160,1489,1490],{},[163,1491,1492,1495,1497,1500],{},[166,1493,1494],{},"Parameter",[166,1496,355],{},[166,1498,1499],{},"Required",[166,1501,171],{},[173,1503,1504,1522,1543,1579,1595,1610,1624,1638],{},[163,1505,1506,1511,1513,1516],{},[178,1507,1508],{},[83,1509,1510],{},"page",[178,1512,369],{},[178,1514,1515],{},"No",[178,1517,1518,1519],{},"Page number, default ",[83,1520,1521],{},"1",[163,1523,1524,1529,1531,1533],{},[178,1525,1526],{},[83,1527,1528],{},"page_size",[178,1530,369],{},[178,1532,1515],{},[178,1534,1535,1536,1539,1540],{},"Items per page, default ",[83,1537,1538],{},"10",", max ",[83,1541,1542],{},"100",[163,1544,1545,1550,1552,1554],{},[178,1546,1547],{},[83,1548,1549],{},"time_range",[178,1551,801],{},[178,1553,1515],{},[178,1555,1556,1557,287,1560,287,1563,287,1566,287,1569,1572,1573,219,1576],{},"Quick time-range filter; only ",[83,1558,1559],{},"all",[83,1561,1562],{},"today",[83,1564,1565],{},"yesterday",[83,1567,1568],{},"week",[83,1570,1571],{},"month"," allowed. Takes precedence over ",[83,1574,1575],{},"start_timestamp",[83,1577,1578],{},"end_timestamp",[163,1580,1581,1585,1587,1589],{},[178,1582,1583],{},[83,1584,1575],{},[178,1586,369],{},[178,1588,1515],{},[178,1590,1591,1592,1594],{},"Start timestamp (used when ",[83,1593,1549],{}," is empty)",[163,1596,1597,1601,1603,1605],{},[178,1598,1599],{},[83,1600,1578],{},[178,1602,369],{},[178,1604,1515],{},[178,1606,1607,1608,1594],{},"End timestamp (used when ",[83,1609,1549],{},[163,1611,1612,1617,1619,1621],{},[178,1613,1614],{},[83,1615,1616],{},"model_name",[178,1618,801],{},[178,1620,1515],{},[178,1622,1623],{},"Model name filter",[163,1625,1626,1631,1633,1635],{},[178,1627,1628],{},[83,1629,1630],{},"request_id",[178,1632,801],{},[178,1634,1515],{},[178,1636,1637],{},"Request ID filter",[163,1639,1640,1645,1647,1649],{},[178,1641,1642],{},[83,1643,1644],{},"upstream_request_id",[178,1646,801],{},[178,1648,1515],{},[178,1650,1651],{},"Upstream request ID filter",[1155,1653,1165],{"id":1654},"request-example-curl-1",[116,1656,1658],{"className":1168,"code":1657,"language":1170,"meta":124,"style":124},"curl \"https://www.guid.ai/v1/token/consume?page=1&page_size=10&time_range=today\" \\\n  -H \"Authorization: Bearer sk-xxxxx\"\n",[83,1659,1660,1673],{"__ignoreMap":124},[150,1661,1662,1664,1666,1669,1671],{"class":152,"line":153},[150,1663,1177],{"class":688},[150,1665,696],{"class":659},[150,1667,1668],{"class":699},"https://www.guid.ai/v1/token/consume?page=1&page_size=10&time_range=today",[150,1670,673],{"class":659},[150,1672,1184],{"class":1183},[150,1674,1675,1677,1679,1681],{"class":152,"line":663},[150,1676,1189],{"class":699},[150,1678,696],{"class":659},[150,1680,1194],{"class":699},[150,1682,765],{"class":659},[1155,1684,1200],{"id":1685},"response-body-1",[79,1687,1203,1688],{},[83,1689,979],{},[116,1691,1693],{"className":650,"code":1692,"language":652,"meta":124,"style":124},"{\n  \"success\": true,\n  \"message\": \"\",\n  \"code\": 0,\n  \"data\": {\n    \"page\": 1,\n    \"page_size\": 10,\n    \"total\": 100,\n    \"items\": [\n      {\n        \"id\": 1,\n        \"created_at\": 1700000000,\n        \"type\": 2,\n        \"type_name\": \"消费\",\n        \"content\": \"模型推理\",\n        \"token_name\": \"default\",\n        \"model_name\": \"gpt-3.5-turbo\",\n        \"app_name\": \"\",\n        \"usage_name\": \"gpt-3.5-turbo\",\n        \"quota_usd\": 0.002,\n        \"quota_type\": 2\n      }\n    ]\n  }\n}\n",[83,1694,1695,1699,1711,1725,1740,1752,1766,1781,1797,1811,1816,1831,1848,1864,1885,1906,1927,1947,1963,1983,2000,2014,2020,2026,2031],{"__ignoreMap":124},[150,1696,1697],{"class":152,"line":153},[150,1698,660],{"class":659},[150,1700,1701,1703,1705,1707,1709],{"class":152,"line":663},[150,1702,666],{"class":659},[150,1704,998],{"class":669},[150,1706,673],{"class":659},[150,1708,676],{"class":659},[150,1710,1227],{"class":659},[150,1712,1713,1715,1717,1719,1721,1723],{"class":152,"line":682},[150,1714,666],{"class":659},[150,1716,689],{"class":669},[150,1718,673],{"class":659},[150,1720,676],{"class":659},[150,1722,1240],{"class":659},[150,1724,705],{"class":659},[150,1726,1727,1729,1731,1733,1735,1738],{"class":152,"line":708},[150,1728,666],{"class":659},[150,1730,83],{"class":669},[150,1732,673],{"class":659},[150,1734,676],{"class":659},[150,1736,1737],{"class":1269}," 0",[150,1739,705],{"class":659},[150,1741,1742,1744,1746,1748,1750],{"class":152,"line":729},[150,1743,666],{"class":659},[150,1745,1249],{"class":669},[150,1747,673],{"class":659},[150,1749,676],{"class":659},[150,1751,679],{"class":659},[150,1753,1754,1756,1758,1760,1762,1764],{"class":152,"line":749},[150,1755,685],{"class":659},[150,1757,1510],{"class":688},[150,1759,673],{"class":659},[150,1761,676],{"class":659},[150,1763,1270],{"class":1269},[150,1765,705],{"class":659},[150,1767,1768,1770,1772,1774,1776,1779],{"class":152,"line":768},[150,1769,685],{"class":659},[150,1771,1528],{"class":688},[150,1773,673],{"class":659},[150,1775,676],{"class":659},[150,1777,1778],{"class":1269}," 10",[150,1780,705],{"class":659},[150,1782,1783,1785,1788,1790,1792,1795],{"class":152,"line":774},[150,1784,685],{"class":659},[150,1786,1787],{"class":688},"total",[150,1789,673],{"class":659},[150,1791,676],{"class":659},[150,1793,1794],{"class":1269}," 100",[150,1796,705],{"class":659},[150,1798,1799,1801,1804,1806,1808],{"class":152,"line":1327},[150,1800,685],{"class":659},[150,1802,1803],{"class":688},"items",[150,1805,673],{"class":659},[150,1807,676],{"class":659},[150,1809,1810],{"class":659}," [\n",[150,1812,1813],{"class":152,"line":1342},[150,1814,1815],{"class":659},"      {\n",[150,1817,1818,1821,1823,1825,1827,1829],{"class":152,"line":1347},[150,1819,1820],{"class":659},"        \"",[150,1822,1262],{"class":1269},[150,1824,673],{"class":659},[150,1826,676],{"class":659},[150,1828,1270],{"class":1269},[150,1830,705],{"class":659},[150,1832,1834,1836,1839,1841,1843,1846],{"class":152,"line":1833},12,[150,1835,1820],{"class":659},[150,1837,1838],{"class":1269},"created_at",[150,1840,673],{"class":659},[150,1842,676],{"class":659},[150,1844,1845],{"class":1269}," 1700000000",[150,1847,705],{"class":659},[150,1849,1851,1853,1855,1857,1859,1862],{"class":152,"line":1850},13,[150,1852,1820],{"class":659},[150,1854,713],{"class":1269},[150,1856,673],{"class":659},[150,1858,676],{"class":659},[150,1860,1861],{"class":1269}," 2",[150,1863,705],{"class":659},[150,1865,1867,1869,1872,1874,1876,1878,1881,1883],{"class":152,"line":1866},14,[150,1868,1820],{"class":659},[150,1870,1871],{"class":1269},"type_name",[150,1873,673],{"class":659},[150,1875,676],{"class":659},[150,1877,696],{"class":659},[150,1879,1880],{"class":699},"消费",[150,1882,673],{"class":659},[150,1884,705],{"class":659},[150,1886,1888,1890,1893,1895,1897,1899,1902,1904],{"class":152,"line":1887},15,[150,1889,1820],{"class":659},[150,1891,1892],{"class":1269},"content",[150,1894,673],{"class":659},[150,1896,676],{"class":659},[150,1898,696],{"class":659},[150,1900,1901],{"class":699},"模型推理",[150,1903,673],{"class":659},[150,1905,705],{"class":659},[150,1907,1909,1911,1914,1916,1918,1920,1923,1925],{"class":152,"line":1908},16,[150,1910,1820],{"class":659},[150,1912,1913],{"class":1269},"token_name",[150,1915,673],{"class":659},[150,1917,676],{"class":659},[150,1919,696],{"class":659},[150,1921,1922],{"class":699},"default",[150,1924,673],{"class":659},[150,1926,705],{"class":659},[150,1928,1930,1932,1934,1936,1938,1940,1943,1945],{"class":152,"line":1929},17,[150,1931,1820],{"class":659},[150,1933,1616],{"class":1269},[150,1935,673],{"class":659},[150,1937,676],{"class":659},[150,1939,696],{"class":659},[150,1941,1942],{"class":699},"gpt-3.5-turbo",[150,1944,673],{"class":659},[150,1946,705],{"class":659},[150,1948,1950,1952,1955,1957,1959,1961],{"class":152,"line":1949},18,[150,1951,1820],{"class":659},[150,1953,1954],{"class":1269},"app_name",[150,1956,673],{"class":659},[150,1958,676],{"class":659},[150,1960,1240],{"class":659},[150,1962,705],{"class":659},[150,1964,1966,1968,1971,1973,1975,1977,1979,1981],{"class":152,"line":1965},19,[150,1967,1820],{"class":659},[150,1969,1970],{"class":1269},"usage_name",[150,1972,673],{"class":659},[150,1974,676],{"class":659},[150,1976,696],{"class":659},[150,1978,1942],{"class":699},[150,1980,673],{"class":659},[150,1982,705],{"class":659},[150,1984,1986,1988,1991,1993,1995,1998],{"class":152,"line":1985},20,[150,1987,1820],{"class":659},[150,1989,1990],{"class":1269},"quota_usd",[150,1992,673],{"class":659},[150,1994,676],{"class":659},[150,1996,1997],{"class":1269}," 0.002",[150,1999,705],{"class":659},[150,2001,2003,2005,2007,2009,2011],{"class":152,"line":2002},21,[150,2004,1820],{"class":659},[150,2006,555],{"class":1269},[150,2008,673],{"class":659},[150,2010,676],{"class":659},[150,2012,2013],{"class":1269}," 2\n",[150,2015,2017],{"class":152,"line":2016},22,[150,2018,2019],{"class":659},"      }\n",[150,2021,2023],{"class":152,"line":2022},23,[150,2024,2025],{"class":659},"    ]\n",[150,2027,2029],{"class":152,"line":2028},24,[150,2030,771],{"class":659},[150,2032,2034],{"class":152,"line":2033},25,[150,2035,777],{"class":659},[1155,2037,1353],{"id":2038},"response-fields-1",[157,2040,2041,2051],{},[160,2042,2043],{},[163,2044,2045,2047,2049],{},[166,2046,352],{},[166,2048,355],{},[166,2050,171],{},[173,2052,2053,2063,2073,2091,2103,2115,2127,2140,2152,2164,2180,2192,2204,2215,2227,2239,2251,2263],{},[163,2054,2055,2059,2061],{},[178,2056,2057],{},[83,2058,998],{},[178,2060,1049],{},[178,2062,1378],{},[163,2064,2065,2069,2071],{},[178,2066,2067],{},[83,2068,689],{},[178,2070,801],{},[178,2072,1389],{},[163,2074,2075,2079,2081],{},[178,2076,2077],{},[83,2078,83],{},[178,2080,369],{},[178,2082,2083,2084,2086,2087,2090],{},"Status code; ",[83,2085,1429],{}," success, ",[83,2088,2089],{},"-1"," business failure",[163,2092,2093,2098,2100],{},[178,2094,2095],{},[83,2096,2097],{},"data.page",[178,2099,369],{},[178,2101,2102],{},"Current page",[163,2104,2105,2110,2112],{},[178,2106,2107],{},[83,2108,2109],{},"data.page_size",[178,2111,369],{},[178,2113,2114],{},"Page size",[163,2116,2117,2122,2124],{},[178,2118,2119],{},[83,2120,2121],{},"data.total",[178,2123,369],{},[178,2125,2126],{},"Total records",[163,2128,2129,2134,2137],{},[178,2130,2131],{},[83,2132,2133],{},"data.items",[178,2135,2136],{},"array",[178,2138,2139],{},"Consume record list",[163,2141,2142,2147,2149],{},[178,2143,2144],{},[83,2145,2146],{},"data.items[].id",[178,2148,369],{},[178,2150,2151],{},"Log ID",[163,2153,2154,2159,2161],{},[178,2155,2156],{},[83,2157,2158],{},"data.items[].created_at",[178,2160,369],{},[178,2162,2163],{},"Created-at timestamp",[163,2165,2166,2171,2173],{},[178,2167,2168],{},[83,2169,2170],{},"data.items[].type",[178,2172,369],{},[178,2174,2175,2176,2179],{},"Log type; always ",[83,2177,2178],{},"2"," (consume)",[163,2181,2182,2187,2189],{},[178,2183,2184],{},[83,2185,2186],{},"data.items[].type_name",[178,2188,801],{},[178,2190,2191],{},"Log type name; always consume",[163,2193,2194,2199,2201],{},[178,2195,2196],{},[83,2197,2198],{},"data.items[].content",[178,2200,801],{},[178,2202,2203],{},"Log content",[163,2205,2206,2211,2213],{},[178,2207,2208],{},[83,2209,2210],{},"data.items[].token_name",[178,2212,801],{},[178,2214,1413],{},[163,2216,2217,2222,2224],{},[178,2218,2219],{},[83,2220,2221],{},"data.items[].model_name",[178,2223,801],{},[178,2225,2226],{},"Model name",[163,2228,2229,2234,2236],{},[178,2230,2231],{},[83,2232,2233],{},"data.items[].app_name",[178,2235,801],{},[178,2237,2238],{},"App name (if from Apps)",[163,2240,2241,2246,2248],{},[178,2242,2243],{},[83,2244,2245],{},"data.items[].usage_name",[178,2247,801],{},[178,2249,2250],{},"Model name or Apps application name",[163,2252,2253,2258,2260],{},[178,2254,2255],{},[83,2256,2257],{},"data.items[].quota_usd",[178,2259,1423],{},[178,2261,2262],{},"Consumed quota (⚡)",[163,2264,2265,2270,2272],{},[178,2266,2267],{},[83,2268,2269],{},"data.items[].quota_type",[178,2271,369],{},[178,2273,2274,2275,2277,2278,2280,2281,2283],{},"Quota change type (",[83,2276,1429],{}," none, ",[83,2279,1521],{}," increase, ",[83,2282,2178],{}," decrease)",[106,2285,2287],{"id":2286},"related-docs","Related docs",[312,2289,2290,2296,2301,2306],{},[315,2291,2292],{},[2293,2294,15],"a",{"href":2295},"../start/quick-start",[315,2297,2298],{},[2293,2299,19],{"href":2300},"../start/guide",[315,2302,2303],{},[2293,2304,23],{"href":2305},"../start/glossary",[315,2307,2308,2312,2313,2312,2317,2312,2321,2312,2325],{},[2293,2309,2311],{"href":2310},"./models","Models"," · ",[2293,2314,2316],{"href":2315},"./text","Text",[2293,2318,2320],{"href":2319},"./images","Images",[2293,2322,2324],{"href":2323},"./videos","Videos",[2293,2326,2328],{"href":2327},"./audio","Audio",[2330,2331,2332],"style",{},"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 .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 pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}",{"title":124,"searchDepth":663,"depth":663,"links":2334},[2335,2341,2347,2352,2358],{"id":108,"depth":663,"text":109,"children":2336},[2337,2338,2339,2340],{"id":113,"depth":682,"text":114},{"id":134,"depth":682,"text":135},{"id":242,"depth":682,"text":243},{"id":309,"depth":682,"text":310},{"id":332,"depth":663,"text":333,"children":2342},[2343,2345],{"id":336,"depth":682,"text":2344},"usage (token billing)",{"id":531,"depth":682,"text":2346},"usage (per-request billing, images)",{"id":622,"depth":663,"text":623,"children":2348},[2349,2350,2351],{"id":626,"depth":682,"text":627},{"id":865,"depth":682,"text":866},{"id":973,"depth":682,"text":974},{"id":1071,"depth":663,"text":1072,"children":2353},[2354,2356],{"id":1140,"depth":682,"text":2355},"GET /v1/token/balance",{"id":1459,"depth":682,"text":2357},"GET /v1/token/consume",{"id":2286,"depth":663,"text":2287},"Authentication, billing, shared objects, and error response formats for the V1 Open API","md",{},true,{"title":33,"description":2359},"-5NY0LfyWwaNk1uqIWvjlJt7WgCN6fZeiINvWUWUAec",[2366,2368],{"title":23,"path":24,"stem":25,"description":2367,"children":-1},"Common concepts, fields, and error terms used in the help docs",{"title":37,"path":38,"stem":39,"description":2369,"children":-1},"List models visible to an API Key and the endpoint types each model supports",1785407605903]