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