[{"data":1,"prerenderedAt":1207},["ShallowReactive",2],{"doc-api":3,"content-query-Y4VdOyyNbN":4},null,{"_path":5,"_dir":6,"_draft":7,"_partial":7,"_locale":8,"title":9,"description":8,"sidebar_position":10,"body":11,"_type":1201,"_id":1202,"_source":1203,"_file":1204,"_stem":1205,"_extension":1206},"\u002Fdocs\u002Fapi","docs",false,"","API Reference",5,{"type":12,"children":13,"toc":1175},"root",[14,22,39,45,52,57,73,78,113,119,220,226,231,237,242,249,254,266,274,303,309,314,319,327,351,357,362,415,436,444,510,536,542,547,553,566,571,579,708,725,731,736,799,804,812,891,915,921,926,931,937,942,948,959,965,970,976,981,987,992,1015,1021,1026,1032,1037,1042,1070,1082,1088,1093,1132,1137,1143,1148,1153,1159,1164,1169],{"type":15,"tag":16,"props":17,"children":19},"element","h1",{"id":18},"api-reference",[20],{"type":21,"value":9},"text",{"type":15,"tag":23,"props":24,"children":29},"div",{"className":25,"ariaHidden":28},[26,27],"docs-page-hero","docs-page-hero--sky","true",[30,32],{"type":21,"value":31},"\n  ",{"type":15,"tag":33,"props":34,"children":38},"img",{"src":35,"alt":8,"width":36,"height":37},"\u002Fimages\u002Fdocs-illustrations\u002Frest-api.svg",128,72,[],{"type":15,"tag":40,"props":41,"children":42},"p",{},[43],{"type":21,"value":44},"The CredVault REST API provides programmatic access to all platform capabilities. This reference documents the available endpoints, authentication methods, request formats, and response structures.",{"type":15,"tag":46,"props":47,"children":49},"h2",{"id":48},"interactive-api-testing",[50],{"type":21,"value":51},"Interactive API Testing",{"type":15,"tag":40,"props":53,"children":54},{},[55],{"type":21,"value":56},"We provide a modern interactive API explorer where you can test endpoints directly in your browser with live \"Try it\" buttons:",{"type":15,"tag":40,"props":58,"children":59},{},[60,71],{"type":15,"tag":61,"props":62,"children":63},"strong",{},[64],{"type":15,"tag":65,"props":66,"children":68},"a",{"href":67},"\u002Fapi-docs",[69],{"type":21,"value":70},"Open Interactive API Explorer",{"type":21,"value":72}," - Test all endpoints live",{"type":15,"tag":40,"props":74,"children":75},{},[76],{"type":21,"value":77},"With our interactive explorer you can:",{"type":15,"tag":79,"props":80,"children":81},"ul",{},[82,88,93,98,103,108],{"type":15,"tag":83,"props":84,"children":85},"li",{},[86],{"type":21,"value":87},"Browse all public API endpoints",{"type":15,"tag":83,"props":89,"children":90},{},[91],{"type":21,"value":92},"Test requests and responses in real-time",{"type":15,"tag":83,"props":94,"children":95},{},[96],{"type":21,"value":97},"View request and response schemas",{"type":15,"tag":83,"props":99,"children":100},{},[101],{"type":21,"value":102},"Generate code snippets for your programming language",{"type":15,"tag":83,"props":104,"children":105},{},[106],{"type":21,"value":107},"Test with your own API keys",{"type":15,"tag":83,"props":109,"children":110},{},[111],{"type":21,"value":112},"See live examples for every endpoint",{"type":15,"tag":46,"props":114,"children":116},{"id":115},"understanding-the-api-flow",[117],{"type":21,"value":118},"Understanding the API Flow",{"type":15,"tag":120,"props":121,"children":124},"pre",{"className":122,"code":123,"language":21,"meta":8,"style":8},"language-text shiki shiki-themes github-dark","Your application\n  -> sends an API request\nCredVault API\n  -> authenticates the request\nAuth layer\n  -> validates token, API key, and permissions\nEndpoint handler\n  -> processes the request\nJSON response\n  -> returns data or an error to your application\n",[125],{"type":15,"tag":126,"props":127,"children":128},"code",{"__ignoreMap":8},[129,140,149,158,167,175,184,193,202,211],{"type":15,"tag":130,"props":131,"children":134},"span",{"class":132,"line":133},"line",1,[135],{"type":15,"tag":130,"props":136,"children":137},{},[138],{"type":21,"value":139},"Your application\n",{"type":15,"tag":130,"props":141,"children":143},{"class":132,"line":142},2,[144],{"type":15,"tag":130,"props":145,"children":146},{},[147],{"type":21,"value":148},"  -> sends an API request\n",{"type":15,"tag":130,"props":150,"children":152},{"class":132,"line":151},3,[153],{"type":15,"tag":130,"props":154,"children":155},{},[156],{"type":21,"value":157},"CredVault API\n",{"type":15,"tag":130,"props":159,"children":161},{"class":132,"line":160},4,[162],{"type":15,"tag":130,"props":163,"children":164},{},[165],{"type":21,"value":166},"  -> authenticates the request\n",{"type":15,"tag":130,"props":168,"children":169},{"class":132,"line":10},[170],{"type":15,"tag":130,"props":171,"children":172},{},[173],{"type":21,"value":174},"Auth layer\n",{"type":15,"tag":130,"props":176,"children":178},{"class":132,"line":177},6,[179],{"type":15,"tag":130,"props":180,"children":181},{},[182],{"type":21,"value":183},"  -> validates token, API key, and permissions\n",{"type":15,"tag":130,"props":185,"children":187},{"class":132,"line":186},7,[188],{"type":15,"tag":130,"props":189,"children":190},{},[191],{"type":21,"value":192},"Endpoint handler\n",{"type":15,"tag":130,"props":194,"children":196},{"class":132,"line":195},8,[197],{"type":15,"tag":130,"props":198,"children":199},{},[200],{"type":21,"value":201},"  -> processes the request\n",{"type":15,"tag":130,"props":203,"children":205},{"class":132,"line":204},9,[206],{"type":15,"tag":130,"props":207,"children":208},{},[209],{"type":21,"value":210},"JSON response\n",{"type":15,"tag":130,"props":212,"children":214},{"class":132,"line":213},10,[215],{"type":15,"tag":130,"props":216,"children":217},{},[218],{"type":21,"value":219},"  -> returns data or an error to your application\n",{"type":15,"tag":46,"props":221,"children":223},{"id":222},"base-url",[224],{"type":21,"value":225},"Base URL",{"type":15,"tag":40,"props":227,"children":228},{},[229],{"type":21,"value":230},"All API requests are made to the CredVault API server. For cloud-hosted accounts, use your regional endpoint. Enterprise customers have custom endpoints provided by their account manager.",{"type":15,"tag":46,"props":232,"children":234},{"id":233},"authentication",[235],{"type":21,"value":236},"Authentication",{"type":15,"tag":40,"props":238,"children":239},{},[240],{"type":21,"value":241},"Every API request requires authentication credentials. CredVault supports two authentication methods depending on your use case.",{"type":15,"tag":243,"props":244,"children":246},"h3",{"id":245},"api-key-authentication",[247],{"type":21,"value":248},"API Key Authentication",{"type":15,"tag":40,"props":250,"children":251},{},[252],{"type":21,"value":253},"Use API key authentication for server-to-server communication and backend applications. This method is recommended for scripts, automation, and service integrations.",{"type":15,"tag":40,"props":255,"children":256},{},[257,259,264],{"type":21,"value":258},"API keys are created in your dashboard under ",{"type":15,"tag":61,"props":260,"children":261},{},[262],{"type":21,"value":263},"Settings → API Keys",{"type":21,"value":265},". Each key has associated permissions that control what operations it can perform. Create multiple keys for different applications or environments to maintain security.",{"type":15,"tag":40,"props":267,"children":268},{},[269],{"type":15,"tag":61,"props":270,"children":271},{},[272],{"type":21,"value":273},"Include your API key in the request header:",{"type":15,"tag":120,"props":275,"children":279},{"className":276,"code":277,"language":278,"meta":8,"style":8},"language-bash shiki shiki-themes github-dark","Authorization: ApiKey YOUR_API_KEY_HERE\n","bash",[280],{"type":15,"tag":126,"props":281,"children":282},{"__ignoreMap":8},[283],{"type":15,"tag":130,"props":284,"children":285},{"class":132,"line":133},[286,292,298],{"type":15,"tag":130,"props":287,"children":289},{"style":288},"--shiki-default:#B392F0",[290],{"type":21,"value":291},"Authorization:",{"type":15,"tag":130,"props":293,"children":295},{"style":294},"--shiki-default:#9ECBFF",[296],{"type":21,"value":297}," ApiKey",{"type":15,"tag":130,"props":299,"children":300},{"style":294},[301],{"type":21,"value":302}," YOUR_API_KEY_HERE\n",{"type":15,"tag":243,"props":304,"children":306},{"id":305},"bearer-token-authentication",[307],{"type":21,"value":308},"Bearer Token Authentication",{"type":15,"tag":40,"props":310,"children":311},{},[312],{"type":21,"value":313},"Use bearer token authentication for applications acting on behalf of users. This method is appropriate for web and mobile applications where end users have logged in.",{"type":15,"tag":40,"props":315,"children":316},{},[317],{"type":21,"value":318},"Tokens are obtained through the authentication endpoints and expire after a period of time. The token represents the user's session and inherits all the user's permissions and restrictions.",{"type":15,"tag":40,"props":320,"children":321},{},[322],{"type":15,"tag":61,"props":323,"children":324},{},[325],{"type":21,"value":326},"Include the token in the Authorization header:",{"type":15,"tag":120,"props":328,"children":330},{"className":276,"code":329,"language":278,"meta":8,"style":8},"Authorization: Bearer YOUR_TOKEN_HERE\n",[331],{"type":15,"tag":126,"props":332,"children":333},{"__ignoreMap":8},[334],{"type":15,"tag":130,"props":335,"children":336},{"class":132,"line":133},[337,341,346],{"type":15,"tag":130,"props":338,"children":339},{"style":288},[340],{"type":21,"value":291},{"type":15,"tag":130,"props":342,"children":343},{"style":294},[344],{"type":21,"value":345}," Bearer",{"type":15,"tag":130,"props":347,"children":348},{"style":294},[349],{"type":21,"value":350}," YOUR_TOKEN_HERE\n",{"type":15,"tag":46,"props":352,"children":354},{"id":353},"request-format",[355],{"type":21,"value":356},"Request Format",{"type":15,"tag":40,"props":358,"children":359},{},[360],{"type":21,"value":361},"API requests use standard HTTP methods with RESTful conventions:",{"type":15,"tag":79,"props":363,"children":364},{},[365,375,385,395,405],{"type":15,"tag":83,"props":366,"children":367},{},[368,373],{"type":15,"tag":61,"props":369,"children":370},{},[371],{"type":21,"value":372},"GET",{"type":21,"value":374}," — Retrieve resources or fetch data",{"type":15,"tag":83,"props":376,"children":377},{},[378,383],{"type":15,"tag":61,"props":379,"children":380},{},[381],{"type":21,"value":382},"POST",{"type":21,"value":384}," — Create new resources or perform actions",{"type":15,"tag":83,"props":386,"children":387},{},[388,393],{"type":15,"tag":61,"props":389,"children":390},{},[391],{"type":21,"value":392},"PUT",{"type":21,"value":394}," — Replace or update entire resources",{"type":15,"tag":83,"props":396,"children":397},{},[398,403],{"type":15,"tag":61,"props":399,"children":400},{},[401],{"type":21,"value":402},"PATCH",{"type":21,"value":404}," — Apply partial updates",{"type":15,"tag":83,"props":406,"children":407},{},[408,413],{"type":15,"tag":61,"props":409,"children":410},{},[411],{"type":21,"value":412},"DELETE",{"type":21,"value":414}," — Remove resources",{"type":15,"tag":40,"props":416,"children":417},{},[418,420,426,428,434],{"type":21,"value":419},"All request bodies should be JSON-encoded. Always set the ",{"type":15,"tag":126,"props":421,"children":423},{"className":422},[],[424],{"type":21,"value":425},"Content-Type",{"type":21,"value":427}," header to ",{"type":15,"tag":126,"props":429,"children":431},{"className":430},[],[432],{"type":21,"value":433},"application\u002Fjson",{"type":21,"value":435}," for requests that include a body.",{"type":15,"tag":40,"props":437,"children":438},{},[439],{"type":15,"tag":61,"props":440,"children":441},{},[442],{"type":21,"value":443},"Example request with cURL:",{"type":15,"tag":120,"props":445,"children":448},{"className":276,"code":446,"language":278,"meta":447,"style":8},"curl -X GET https:\u002F\u002Fapi.credvault.io\u002Fv1\u002Fresources \\\n  -H \"Authorization: ApiKey YOUR_API_KEY_HERE\" \\\n  -H \"Content-Type: application\u002Fjson\"\n","testable",[449],{"type":15,"tag":126,"props":450,"children":451},{"__ignoreMap":8},[452,481,498],{"type":15,"tag":130,"props":453,"children":454},{"class":132,"line":133},[455,460,466,471,476],{"type":15,"tag":130,"props":456,"children":457},{"style":288},[458],{"type":21,"value":459},"curl",{"type":15,"tag":130,"props":461,"children":463},{"style":462},"--shiki-default:#79B8FF",[464],{"type":21,"value":465}," -X",{"type":15,"tag":130,"props":467,"children":468},{"style":294},[469],{"type":21,"value":470}," GET",{"type":15,"tag":130,"props":472,"children":473},{"style":294},[474],{"type":21,"value":475}," https:\u002F\u002Fapi.credvault.io\u002Fv1\u002Fresources",{"type":15,"tag":130,"props":477,"children":478},{"style":462},[479],{"type":21,"value":480}," \\\n",{"type":15,"tag":130,"props":482,"children":483},{"class":132,"line":142},[484,489,494],{"type":15,"tag":130,"props":485,"children":486},{"style":462},[487],{"type":21,"value":488},"  -H",{"type":15,"tag":130,"props":490,"children":491},{"style":294},[492],{"type":21,"value":493}," \"Authorization: ApiKey YOUR_API_KEY_HERE\"",{"type":15,"tag":130,"props":495,"children":496},{"style":462},[497],{"type":21,"value":480},{"type":15,"tag":130,"props":499,"children":500},{"class":132,"line":151},[501,505],{"type":15,"tag":130,"props":502,"children":503},{"style":462},[504],{"type":21,"value":488},{"type":15,"tag":130,"props":506,"children":507},{"style":294},[508],{"type":21,"value":509}," \"Content-Type: application\u002Fjson\"\n",{"type":15,"tag":40,"props":511,"children":512},{},[513,518,520,526,528,534],{"type":15,"tag":61,"props":514,"children":515},{},[516],{"type":21,"value":517},"What you should see:",{"type":21,"value":519}," a JSON response from the API. If the key is missing, expired, or scoped incorrectly, the response should be a clear ",{"type":15,"tag":126,"props":521,"children":523},{"className":522},[],[524],{"type":21,"value":525},"401",{"type":21,"value":527}," or ",{"type":15,"tag":126,"props":529,"children":531},{"className":530},[],[532],{"type":21,"value":533},"403",{"type":21,"value":535}," error instead of a blank page or browser crash.",{"type":15,"tag":46,"props":537,"children":539},{"id":538},"response-format",[540],{"type":21,"value":541},"Response Format",{"type":15,"tag":40,"props":543,"children":544},{},[545],{"type":21,"value":546},"All API responses return JSON format. Successful responses contain the requested data, while error responses include an error code and descriptive message.",{"type":15,"tag":243,"props":548,"children":550},{"id":549},"successful-responses",[551],{"type":21,"value":552},"Successful Responses",{"type":15,"tag":40,"props":554,"children":555},{},[556,558,564],{"type":21,"value":557},"Operations that succeed return HTTP status codes in the 2xx range. The response body contains your requested data, often wrapped in a ",{"type":15,"tag":126,"props":559,"children":561},{"className":560},[],[562],{"type":21,"value":563},"data",{"type":21,"value":565}," field.",{"type":15,"tag":40,"props":567,"children":568},{},[569],{"type":21,"value":570},"Create operations return the newly created resource with its assigned ID. List operations return an array of resources with pagination information when applicable.",{"type":15,"tag":40,"props":572,"children":573},{},[574],{"type":15,"tag":61,"props":575,"children":576},{},[577],{"type":21,"value":578},"Example successful response:",{"type":15,"tag":120,"props":580,"children":584},{"className":581,"code":582,"language":583,"meta":8,"style":8},"language-json shiki shiki-themes github-dark","{\n  \"status\": \"success\",\n  \"data\": {\n    \"id\": \"resource_123\",\n    \"name\": \"My Resource\",\n    \"created_at\": \"2026-06-13T10:30:00Z\"\n  }\n}\n","json",[585],{"type":15,"tag":126,"props":586,"children":587},{"__ignoreMap":8},[588,597,620,633,654,675,692,700],{"type":15,"tag":130,"props":589,"children":590},{"class":132,"line":133},[591],{"type":15,"tag":130,"props":592,"children":594},{"style":593},"--shiki-default:#E1E4E8",[595],{"type":21,"value":596},"{\n",{"type":15,"tag":130,"props":598,"children":599},{"class":132,"line":142},[600,605,610,615],{"type":15,"tag":130,"props":601,"children":602},{"style":462},[603],{"type":21,"value":604},"  \"status\"",{"type":15,"tag":130,"props":606,"children":607},{"style":593},[608],{"type":21,"value":609},": ",{"type":15,"tag":130,"props":611,"children":612},{"style":294},[613],{"type":21,"value":614},"\"success\"",{"type":15,"tag":130,"props":616,"children":617},{"style":593},[618],{"type":21,"value":619},",\n",{"type":15,"tag":130,"props":621,"children":622},{"class":132,"line":151},[623,628],{"type":15,"tag":130,"props":624,"children":625},{"style":462},[626],{"type":21,"value":627},"  \"data\"",{"type":15,"tag":130,"props":629,"children":630},{"style":593},[631],{"type":21,"value":632},": {\n",{"type":15,"tag":130,"props":634,"children":635},{"class":132,"line":160},[636,641,645,650],{"type":15,"tag":130,"props":637,"children":638},{"style":462},[639],{"type":21,"value":640},"    \"id\"",{"type":15,"tag":130,"props":642,"children":643},{"style":593},[644],{"type":21,"value":609},{"type":15,"tag":130,"props":646,"children":647},{"style":294},[648],{"type":21,"value":649},"\"resource_123\"",{"type":15,"tag":130,"props":651,"children":652},{"style":593},[653],{"type":21,"value":619},{"type":15,"tag":130,"props":655,"children":656},{"class":132,"line":10},[657,662,666,671],{"type":15,"tag":130,"props":658,"children":659},{"style":462},[660],{"type":21,"value":661},"    \"name\"",{"type":15,"tag":130,"props":663,"children":664},{"style":593},[665],{"type":21,"value":609},{"type":15,"tag":130,"props":667,"children":668},{"style":294},[669],{"type":21,"value":670},"\"My Resource\"",{"type":15,"tag":130,"props":672,"children":673},{"style":593},[674],{"type":21,"value":619},{"type":15,"tag":130,"props":676,"children":677},{"class":132,"line":177},[678,683,687],{"type":15,"tag":130,"props":679,"children":680},{"style":462},[681],{"type":21,"value":682},"    \"created_at\"",{"type":15,"tag":130,"props":684,"children":685},{"style":593},[686],{"type":21,"value":609},{"type":15,"tag":130,"props":688,"children":689},{"style":294},[690],{"type":21,"value":691},"\"2026-06-13T10:30:00Z\"\n",{"type":15,"tag":130,"props":693,"children":694},{"class":132,"line":186},[695],{"type":15,"tag":130,"props":696,"children":697},{"style":593},[698],{"type":21,"value":699},"  }\n",{"type":15,"tag":130,"props":701,"children":702},{"class":132,"line":195},[703],{"type":15,"tag":130,"props":704,"children":705},{"style":593},[706],{"type":21,"value":707},"}\n",{"type":15,"tag":40,"props":709,"children":710},{},[711,716,718,723],{"type":15,"tag":61,"props":712,"children":713},{},[714],{"type":21,"value":715},"What it means:",{"type":21,"value":717}," the request reached CredVault, authentication passed, and the API returned the requested object inside ",{"type":15,"tag":126,"props":719,"children":721},{"className":720},[],[722],{"type":21,"value":563},{"type":21,"value":724},".",{"type":15,"tag":243,"props":726,"children":728},{"id":727},"error-responses",[729],{"type":21,"value":730},"Error Responses",{"type":15,"tag":40,"props":732,"children":733},{},[734],{"type":21,"value":735},"When errors occur, the API returns appropriate HTTP status codes:",{"type":15,"tag":79,"props":737,"children":738},{},[739,749,759,769,779,789],{"type":15,"tag":83,"props":740,"children":741},{},[742,747],{"type":15,"tag":61,"props":743,"children":744},{},[745],{"type":21,"value":746},"400 Bad Request",{"type":21,"value":748}," — The request was malformed or missing required parameters",{"type":15,"tag":83,"props":750,"children":751},{},[752,757],{"type":15,"tag":61,"props":753,"children":754},{},[755],{"type":21,"value":756},"401 Unauthorized",{"type":21,"value":758}," — Authentication credentials were missing or invalid",{"type":15,"tag":83,"props":760,"children":761},{},[762,767],{"type":15,"tag":61,"props":763,"children":764},{},[765],{"type":21,"value":766},"403 Forbidden",{"type":21,"value":768}," — The authenticated user lacks permission for this operation",{"type":15,"tag":83,"props":770,"children":771},{},[772,777],{"type":15,"tag":61,"props":773,"children":774},{},[775],{"type":21,"value":776},"404 Not Found",{"type":21,"value":778}," — The requested resource does not exist",{"type":15,"tag":83,"props":780,"children":781},{},[782,787],{"type":15,"tag":61,"props":783,"children":784},{},[785],{"type":21,"value":786},"429 Too Many Requests",{"type":21,"value":788}," — You have exceeded your rate limit",{"type":15,"tag":83,"props":790,"children":791},{},[792,797],{"type":15,"tag":61,"props":793,"children":794},{},[795],{"type":21,"value":796},"500 Internal Server Error",{"type":21,"value":798}," — An unexpected server error occurred",{"type":15,"tag":40,"props":800,"children":801},{},[802],{"type":21,"value":803},"Error responses always include a message explaining what went wrong. Use this information for debugging and to provide helpful feedback to users.",{"type":15,"tag":40,"props":805,"children":806},{},[807],{"type":15,"tag":61,"props":808,"children":809},{},[810],{"type":21,"value":811},"Example error response:",{"type":15,"tag":120,"props":813,"children":815},{"className":581,"code":814,"language":583,"meta":8,"style":8},"{\n  \"status\": \"error\",\n  \"code\": \"MISSING_PARAMETER\",\n  \"message\": \"Required parameter 'name' is missing from request\"\n}\n",[816],{"type":15,"tag":126,"props":817,"children":818},{"__ignoreMap":8},[819,826,846,867,884],{"type":15,"tag":130,"props":820,"children":821},{"class":132,"line":133},[822],{"type":15,"tag":130,"props":823,"children":824},{"style":593},[825],{"type":21,"value":596},{"type":15,"tag":130,"props":827,"children":828},{"class":132,"line":142},[829,833,837,842],{"type":15,"tag":130,"props":830,"children":831},{"style":462},[832],{"type":21,"value":604},{"type":15,"tag":130,"props":834,"children":835},{"style":593},[836],{"type":21,"value":609},{"type":15,"tag":130,"props":838,"children":839},{"style":294},[840],{"type":21,"value":841},"\"error\"",{"type":15,"tag":130,"props":843,"children":844},{"style":593},[845],{"type":21,"value":619},{"type":15,"tag":130,"props":847,"children":848},{"class":132,"line":151},[849,854,858,863],{"type":15,"tag":130,"props":850,"children":851},{"style":462},[852],{"type":21,"value":853},"  \"code\"",{"type":15,"tag":130,"props":855,"children":856},{"style":593},[857],{"type":21,"value":609},{"type":15,"tag":130,"props":859,"children":860},{"style":294},[861],{"type":21,"value":862},"\"MISSING_PARAMETER\"",{"type":15,"tag":130,"props":864,"children":865},{"style":593},[866],{"type":21,"value":619},{"type":15,"tag":130,"props":868,"children":869},{"class":132,"line":160},[870,875,879],{"type":15,"tag":130,"props":871,"children":872},{"style":462},[873],{"type":21,"value":874},"  \"message\"",{"type":15,"tag":130,"props":876,"children":877},{"style":593},[878],{"type":21,"value":609},{"type":15,"tag":130,"props":880,"children":881},{"style":294},[882],{"type":21,"value":883},"\"Required parameter 'name' is missing from request\"\n",{"type":15,"tag":130,"props":885,"children":886},{"class":132,"line":10},[887],{"type":15,"tag":130,"props":888,"children":889},{"style":593},[890],{"type":21,"value":707},{"type":15,"tag":40,"props":892,"children":893},{},[894,898,900,905,907,913],{"type":15,"tag":61,"props":895,"children":896},{},[897],{"type":21,"value":715},{"type":21,"value":899}," the API rejected the request in a controlled way. The ",{"type":15,"tag":126,"props":901,"children":903},{"className":902},[],[904],{"type":21,"value":126},{"type":21,"value":906}," tells your application what failed, and the ",{"type":15,"tag":126,"props":908,"children":910},{"className":909},[],[911],{"type":21,"value":912},"message",{"type":21,"value":914}," is safe to show in logs or developer tooling.",{"type":15,"tag":46,"props":916,"children":918},{"id":917},"rate-limiting",[919],{"type":21,"value":920},"Rate Limiting",{"type":15,"tag":40,"props":922,"children":923},{},[924],{"type":21,"value":925},"To ensure fair usage and maintain platform stability, all API requests are rate limited. Your rate limits depend on your subscription tier.",{"type":15,"tag":40,"props":927,"children":928},{},[929],{"type":21,"value":930},"When you exceed rate limits, the API returns a 429 status code. The response includes headers indicating when you can retry your request. Implement exponential backoff in your applications to handle rate limits gracefully.",{"type":15,"tag":46,"props":932,"children":934},{"id":933},"getting-started-with-the-api",[935],{"type":21,"value":936},"Getting Started with the API",{"type":15,"tag":40,"props":938,"children":939},{},[940],{"type":21,"value":941},"The easiest way to explore and test the API is using our interactive API explorer. Here's how:",{"type":15,"tag":243,"props":943,"children":945},{"id":944},"_1-visit-the-api-explorer",[946],{"type":21,"value":947},"1. Visit the API Explorer",{"type":15,"tag":40,"props":949,"children":950},{},[951,953,957],{"type":21,"value":952},"Navigate to ",{"type":15,"tag":65,"props":954,"children":955},{"href":67},[956],{"type":21,"value":67},{"type":21,"value":958}," to open the interactive Swagger UI interface.",{"type":15,"tag":243,"props":960,"children":962},{"id":961},"_2-choose-an-endpoint",[963],{"type":21,"value":964},"2. Choose an Endpoint",{"type":15,"tag":40,"props":966,"children":967},{},[968],{"type":21,"value":969},"Browse through the available endpoints organized by resource type. Each endpoint shows the HTTP method, path, parameters, and required headers.",{"type":15,"tag":243,"props":971,"children":973},{"id":972},"_3-try-it-out",[974],{"type":21,"value":975},"3. Try It Out",{"type":15,"tag":40,"props":977,"children":978},{},[979],{"type":21,"value":980},"Click the \"Try it out\" button on any endpoint to test it directly in your browser. You can provide your own API key and test parameters.",{"type":15,"tag":243,"props":982,"children":984},{"id":983},"_4-view-response",[985],{"type":21,"value":986},"4. View Response",{"type":15,"tag":40,"props":988,"children":989},{},[990],{"type":21,"value":991},"After executing, you'll see:",{"type":15,"tag":79,"props":993,"children":994},{},[995,1000,1005,1010],{"type":15,"tag":83,"props":996,"children":997},{},[998],{"type":21,"value":999},"The actual HTTP request that was sent",{"type":15,"tag":83,"props":1001,"children":1002},{},[1003],{"type":21,"value":1004},"The response status code and headers",{"type":15,"tag":83,"props":1006,"children":1007},{},[1008],{"type":21,"value":1009},"The JSON response body",{"type":15,"tag":83,"props":1011,"children":1012},{},[1013],{"type":21,"value":1014},"Links to generate code snippets in your language",{"type":15,"tag":243,"props":1016,"children":1018},{"id":1017},"_5-generate-code-snippets",[1019],{"type":21,"value":1020},"5. Generate Code Snippets",{"type":15,"tag":40,"props":1022,"children":1023},{},[1024],{"type":21,"value":1025},"Use the generated code samples as a starting point for your implementation. The explorer can generate snippets for JavaScript, Python, cURL, and many other languages.",{"type":15,"tag":46,"props":1027,"children":1029},{"id":1028},"api-resources",[1030],{"type":21,"value":1031},"API Resources",{"type":15,"tag":40,"props":1033,"children":1034},{},[1035],{"type":21,"value":1036},"The API is organized around resources with standard CRUD endpoints plus specialized actions for each resource type.",{"type":15,"tag":40,"props":1038,"children":1039},{},[1040],{"type":21,"value":1041},"Available resource categories include:",{"type":15,"tag":79,"props":1043,"children":1044},{},[1045,1050,1055,1060,1065],{"type":15,"tag":83,"props":1046,"children":1047},{},[1048],{"type":21,"value":1049},"Data operations for querying, inserting, updating, and deleting records",{"type":15,"tag":83,"props":1051,"children":1052},{},[1053],{"type":21,"value":1054},"Cluster management for viewing and configuring database clusters",{"type":15,"tag":83,"props":1056,"children":1057},{},[1058],{"type":21,"value":1059},"Integration endpoints for connecting external services",{"type":15,"tag":83,"props":1061,"children":1062},{},[1063],{"type":21,"value":1064},"Intelligence engine capabilities for ML-powered operations",{"type":15,"tag":83,"props":1066,"children":1067},{},[1068],{"type":21,"value":1069},"Webhook configuration for event notifications",{"type":15,"tag":40,"props":1071,"children":1072},{},[1073,1075,1080],{"type":21,"value":1074},"Refer to the complete API documentation in the ",{"type":15,"tag":65,"props":1076,"children":1077},{"href":67},[1078],{"type":21,"value":1079},"interactive explorer",{"type":21,"value":1081}," for detailed information about each endpoint.",{"type":15,"tag":46,"props":1083,"children":1085},{"id":1084},"pagination",[1086],{"type":21,"value":1087},"Pagination",{"type":15,"tag":40,"props":1089,"children":1090},{},[1091],{"type":21,"value":1092},"Endpoints that return lists support pagination for handling large result sets. Common parameters include:",{"type":15,"tag":79,"props":1094,"children":1095},{},[1096,1106,1122],{"type":15,"tag":83,"props":1097,"children":1098},{},[1099,1104],{"type":15,"tag":61,"props":1100,"children":1101},{},[1102],{"type":21,"value":1103},"limit",{"type":21,"value":1105}," — Maximum number of results to return",{"type":15,"tag":83,"props":1107,"children":1108},{},[1109,1114,1115,1120],{"type":15,"tag":61,"props":1110,"children":1111},{},[1112],{"type":21,"value":1113},"offset",{"type":21,"value":527},{"type":15,"tag":61,"props":1116,"children":1117},{},[1118],{"type":21,"value":1119},"skip",{"type":21,"value":1121}," — Number of results to skip",{"type":15,"tag":83,"props":1123,"children":1124},{},[1125,1130],{"type":15,"tag":61,"props":1126,"children":1127},{},[1128],{"type":21,"value":1129},"cursor",{"type":21,"value":1131}," — For cursor-based pagination",{"type":15,"tag":40,"props":1133,"children":1134},{},[1135],{"type":21,"value":1136},"Paginated responses include metadata about total count and cursors for fetching additional pages.",{"type":15,"tag":46,"props":1138,"children":1140},{"id":1139},"filtering-and-sorting",[1141],{"type":21,"value":1142},"Filtering and Sorting",{"type":15,"tag":40,"props":1144,"children":1145},{},[1146],{"type":21,"value":1147},"Many list endpoints accept query parameters for filtering and sorting results. Filter by field values, date ranges, or status. Sort ascending or descending by specific fields.",{"type":15,"tag":40,"props":1149,"children":1150},{},[1151],{"type":21,"value":1152},"The exact parameters vary by endpoint. Refer to individual endpoint documentation for available options.",{"type":15,"tag":46,"props":1154,"children":1156},{"id":1155},"versioning",[1157],{"type":21,"value":1158},"Versioning",{"type":15,"tag":40,"props":1160,"children":1161},{},[1162],{"type":21,"value":1163},"The API uses URL path versioning. The current version is v1. Breaking changes will be introduced in new versions, giving you time to update your integrations.",{"type":15,"tag":40,"props":1165,"children":1166},{},[1167],{"type":21,"value":1168},"We maintain backward compatibility within versions. New fields may be added to responses, but existing fields won't be removed or changed.",{"type":15,"tag":1170,"props":1171,"children":1172},"style",{},[1173],{"type":21,"value":1174},"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);}",{"title":8,"searchDepth":142,"depth":142,"links":1176},[1177,1178,1179,1180,1184,1185,1189,1190,1197,1198,1199,1200],{"id":48,"depth":142,"text":51},{"id":115,"depth":142,"text":118},{"id":222,"depth":142,"text":225},{"id":233,"depth":142,"text":236,"children":1181},[1182,1183],{"id":245,"depth":151,"text":248},{"id":305,"depth":151,"text":308},{"id":353,"depth":142,"text":356},{"id":538,"depth":142,"text":541,"children":1186},[1187,1188],{"id":549,"depth":151,"text":552},{"id":727,"depth":151,"text":730},{"id":917,"depth":142,"text":920},{"id":933,"depth":142,"text":936,"children":1191},[1192,1193,1194,1195,1196],{"id":944,"depth":151,"text":947},{"id":961,"depth":151,"text":964},{"id":972,"depth":151,"text":975},{"id":983,"depth":151,"text":986},{"id":1017,"depth":151,"text":1020},{"id":1028,"depth":142,"text":1031},{"id":1084,"depth":142,"text":1087},{"id":1139,"depth":142,"text":1142},{"id":1155,"depth":142,"text":1158},"markdown","content:docs:api:index.md","content","docs\u002Fapi\u002Findex.md","docs\u002Fapi\u002Findex","md",1794695980457]