A API do Windsurf permite que clientes Enterprise acessem programaticamente análises detalhadas de uso e gerenciem as configurações de uso de suas equipes.
A API está disponível apenas para planos Enterprise
A API do Windsurf usa chaves de serviço para autenticação. As chaves de serviço devem ser incluídas no corpo da requisição de todas as chamadas de API.
As solicitações à API estão sujeitas a limitação de taxa para garantir a estabilidade do serviço. Se você exceder esse limite, receberá uma resposta 429 Too Many Requests.
Para suporte à API e outras dúvidas, entre em contato com o Windsurf Support.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Windsurf Docs","colors":{"primary":"#34E8BB","light":"#34E8BB","dark":"#34E8BB"},"logo":{"light":"https://mintcdn.com/codeium/Hr_wKmLaXZaiQOb6/assets/windsurf-black-logo.svg?fit=max\u0026auto=format\u0026n=Hr_wKmLaXZaiQOb6\u0026q=85\u0026s=9d8592a768328271378364064a81840f","dark":"https://mintcdn.com/codeium/Wq_VJcrav3XIkIsv/assets/windsurf-white-logo.svg?fit=max\u0026auto=format\u0026n=Wq_VJcrav3XIkIsv\u0026q=85\u0026s=cf2529c7ca0b084c690089bc03b55830","href":"https://windsurf.com"},"favicon":{"light":"https://mintcdn.com/codeium/d8O4q6w3H2CjrirL/assets/favicon.png?fit=max\u0026auto=format\u0026n=d8O4q6w3H2CjrirL\u0026q=85\u0026s=4d5b8948a5f906d0cbc35a86c11be09c","dark":"https://mintcdn.com/codeium/d8O4q6w3H2CjrirL/assets/favicon.png?fit=max\u0026auto=format\u0026n=d8O4q6w3H2CjrirL\u0026q=85\u0026s=4d5b8948a5f906d0cbc35a86c11be09c"},"navbar":{"links":[],"primary":{"type":"button","label":"Download","href":"https://windsurf.com/download"}},"footer":{"socials":{"twitter":"https://x.com/windsurf","discord":"https://discord.com/invite/3XFf78nAx5"}},"seo":{"metatags":{"og:image":"https://exafunction.github.io/public/hero/thumbnail_docs.png","twitter:image":"https://exafunction.github.io/public/hero/thumbnail_docs.png","twitter:site":"@windsurf","og:description":"Docs for Windsurf (formerly Codeium): your modern coding superpowers.","og:site_name":"Windsurf Docs","twitter:description":"Docs for Windsurf (formerly Codeium): your modern coding superpowers."},"indexing":"navigable"},"integrations":{"ga4":{"measurementId":"G-8183L9GV0M"}},"contextual":{"options":["copy","view"],"display":"header"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","href":"windsurf/getting-started"},{"language":"fr","href":"fr/windsurf/getting-started"},{"language":"es","href":"es/windsurf/getting-started"},{"language":"de","href":"de/windsurf/getting-started"},{"language":"pt-BR","href":"pt-BR/windsurf/getting-started"},{"language":"zh","href":"zh/windsurf/getting-started"},{"language":"ja","href":"ja/windsurf/getting-started"},{"language":"ro","href":"ro/windsurf/getting-started"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"codeium","hasAudioNarration":false,"actualSubdomain":"codeium","customDomains":["docs.windsurf.com"],"gitSource":{"type":"github","owner":"exafunction","repo":"codeium-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae921b9a7789b0d4de9976b:success","clientVersion":"0.0.4124","searchFilterCounts":[{"language":"en","tag":"Windsurf","count":57},{"language":"de","tag":"Windsurf","count":49},{"language":"es","tag":"Windsurf","count":49},{"language":"fr","tag":"Windsurf","count":49},{"language":"ja","tag":"Windsurf","count":49},{"language":"pt-BR","tag":"Windsurf","count":49},{"language":"ro","tag":"Windsurf","count":49},{"language":"zh","tag":"Windsurf","count":49},{"language":"en","tag":"Windsurf Plugins","count":44},{"language":"de","tag":"Windsurf Plugins","count":44},{"language":"es","tag":"Windsurf Plugins","count":44},{"language":"fr","tag":"Windsurf Plugins","count":44},{"language":"ja","tag":"Windsurf Plugins","count":44},{"language":"pt-BR","tag":"Windsurf Plugins","count":44},{"language":"ro","tag":"Windsurf Plugins","count":44},{"language":"zh","tag":"Windsurf Plugins","count":44},{"language":"en","tag":"Accounts","count":32},{"language":"de","tag":"Konten","count":30},{"language":"es","tag":"Cuentas","count":30},{"language":"fr","tag":"Comptes","count":30},{"language":"ja","tag":"アカウント","count":30},{"language":"pt-BR","tag":"Contas","count":30},{"language":"ro","tag":"Conturi","count":30},{"language":"zh","tag":"账户","count":30},{"language":"en","tag":"Teams \u0026 Enterprise","count":27},{"language":"de","tag":"Teams \u0026 Enterprise","count":26},{"language":"es","tag":"Teams y Enterprise","count":26},{"language":"fr","tag":"Teams et Enterprise","count":26},{"language":"pt-BR","tag":"Teams e Enterprise","count":26},{"language":"en","tag":"API Reference","count":18},{"language":"de","tag":"API-Referenz","count":18},{"language":"es","tag":"Referencia de la API","count":18},{"language":"fr","tag":"Référence de l’API","count":18},{"language":"ja","tag":"API リファレンス","count":18},{"language":"pt-BR","tag":"Referência da API","count":18},{"language":"zh","tag":"API 参考","count":18},{"language":"en","tag":"Editor","count":16},{"language":"de","tag":"Editor","count":14},{"language":"es","tag":"Editor","count":14},{"language":"fr","tag":"Éditeur","count":14},{"language":"ja","tag":"エディタ","count":14},{"language":"ja","tag":"Teams と Enterprise","count":14},{"language":"pt-BR","tag":"Editor","count":14},{"language":"ro","tag":"Editor","count":14},{"language":"ro","tag":"Teams și Enterprise","count":14},{"language":"zh","tag":"编辑器","count":14},{"language":"zh","tag":"Teams 与 Enterprise","count":14},{"language":"en","tag":"Troubleshooting","count":13},{"language":"de","tag":"Fehlerbehebung","count":13},{"language":"fr","tag":"Dépannage","count":13},{"language":"ja","tag":"トラブルシューティング","count":13},{"language":"ro","tag":"Depanare","count":13},{"language":"zh","tag":"故障排查","count":13},{"language":"en","tag":"Cascade","count":12},{"language":"de","tag":"Cascade","count":12},{"language":"es","tag":"Cascade","count":12},{"language":"fr","tag":"Cascade","count":12},{"language":"ja","tag":"Teams \u0026 Enterprise","count":12},{"language":"ja","tag":"Cascade","count":12},{"language":"pt-BR","tag":"Cascade","count":12},{"language":"ro","tag":"Teams \u0026 Enterprise","count":12},{"language":"ro","tag":"Cascade","count":12},{"language":"zh","tag":"Teams 和 Enterprise","count":12},{"language":"zh","tag":"Cascade","count":12},{"language":"en","tag":"Analytics API","count":10},{"language":"de","tag":"Analytics-API","count":10},{"language":"es","tag":"Analytics API","count":10},{"language":"fr","tag":"Analytics API","count":10},{"language":"ja","tag":"Analytics API（アナリティクス API）","count":10},{"language":"pt-BR","tag":"Analytics API","count":10},{"language":"ro","tag":"Analytics API","count":10},{"language":"zh","tag":"Analytics API","count":10},{"language":"ro","tag":"Referință API","count":9},{"language":"de","tag":"Erste Schritte","count":8},{"language":"es","tag":"Primeros pasos","count":8},{"language":"pt-BR","tag":"Primeiros passos","count":8},{"language":"es","tag":"Solución de problemas","count":7},{"language":"pt-BR","tag":"Solução de problemas","count":7},{"language":"en","tag":"Features","count":6},{"language":"fr","tag":"Fonctionnalités","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"pt-BR/windsurf/accounts/api-reference/api-introduction","slug":"/pt-BR/windsurf/accounts/api-reference/api-introduction","pageMetadata":{"title":"Referência da API","description":"API Enterprise para consultar dados de uso do Windsurf e gerenciar configurações com autenticação via Service Key.","keywords":["API","enterprise","Service Key","autenticação","dados de uso","configuração","referência"],"href":"/pt-BR/windsurf/accounts/api-reference/api-introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"API Enterprise para consultar dados de uso do Windsurf e gerenciar configurações com autenticação via Service Key.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(`div`,{id:`overview`,children:_jsx(Heading,{level:`2`,id:`visão-geral`,children:`Visão geral`})}),`\n`,_jsx(_components.p,{children:`A API do Windsurf permite que clientes Enterprise acessem programaticamente análises detalhadas de uso e gerenciem as configurações de uso de suas equipes.`}),`\n`,_jsx(Note,{children:`A API está disponível apenas para planos Enterprise`}),`\n`,_jsx(`div`,{id:`base-url`,children:_jsx(Heading,{level:`2`,id:`url-base`,children:`URL base`})}),`\n`,_jsx(_components.p,{children:`Todas as requisições à API devem ser feitas para:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://server.codeium.com/api/v1/`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(`div`,{id:`authentication`,children:_jsx(Heading,{level:`2`,id:`autenticação`,children:`Autenticação`})}),`\n`,_jsx(_components.p,{children:`A API do Windsurf usa chaves de serviço para autenticação. As chaves de serviço devem ser incluídas no corpo da requisição de todas as chamadas de API.`}),`\n`,_jsx(`div`,{id:`creating-a-service-key`,children:_jsx(Heading,{level:`3`,id:`criando-uma-chave-de-serviço`,children:`Criando uma Chave de serviço`})}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Acesse a sua `,_jsx(_components.a,{href:`https://windsurf.com/team/settings`,children:`página de configurações da equipe`})]}),`\n`,_jsx(_components.li,{children:`Vá até a seção “Chaves de serviço”`}),`\n`,_jsx(_components.li,{children:`Crie uma nova Chave de serviço com as permissões apropriadas`}),`\n`,_jsx(_components.li,{children:`Copie a Chave de serviço gerada para usar em solicitações à API`}),`\n`]}),`\n`,_jsx(`div`,{id:`required-permissions`,children:_jsx(Heading,{level:`3`,id:`permissões-necessárias`,children:`Permissões necessárias`})}),`\n`,_jsx(_components.p,{children:`Diferentes endpoints de API exigem permissões diferentes. Consulte a documentação de cada endpoint para saber qual permissão é necessária:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Endpoint`}),_jsx(_components.th,{children:`Permissão necessária`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.a,{href:`/pt-BR/windsurf/accounts/api-reference/custom-analytics`,children:`Custom Analytics`}),` (`,_jsx(_components.code,{children:`/Analytics`}),`)`]}),_jsx(_components.td,{children:`Analytics Read`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.a,{href:`/pt-BR/windsurf/accounts/api-reference/user-page-analytics`,children:`User Page Analytics`}),` (`,_jsx(_components.code,{children:`/UserPageAnalytics`}),`)`]}),_jsx(_components.td,{children:`Teams somente leitura`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.a,{href:`/pt-BR/windsurf/accounts/api-reference/cascade-analytics`,children:`Cascade Analytics`}),` (`,_jsx(_components.code,{children:`/CascadeAnalytics`}),`)`]}),_jsx(_components.td,{children:`Teams somente leitura`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.a,{href:`/pt-BR/windsurf/accounts/api-reference/usage-config`,children:`Set Usage Configuration`}),` (`,_jsx(_components.code,{children:`/UsageConfig`}),`)`]}),_jsx(_components.td,{children:`Billing Write`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.a,{href:`/pt-BR/windsurf/accounts/api-reference/get-usage-config`,children:`Get Usage Configuration`}),` (`,_jsx(_components.code,{children:`/GetUsageConfig`}),`)`]}),_jsx(_components.td,{children:`Billing Read`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.a,{href:`/pt-BR/windsurf/accounts/api-reference/get-team-credit-balance`,children:`Get Team Credit Balance`}),` (`,_jsx(_components.code,{children:`/GetTeamCreditBalance`}),`)`]}),_jsx(_components.td,{children:`Billing Read`})]})]})]}),`\n`,_jsx(`div`,{id:`using-service-keys`,children:_jsx(Heading,{level:`3`,id:`usando-chaves-de-serviço`,children:`Usando Chaves de serviço`})}),`\n`,_jsx(_components.p,{children:`Inclua sua Service Key no corpo da requisição de todas as chamadas à API:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"service_key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your_service_key_here\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // ... outros parâmetros`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Warning,{children:`Mantenha suas chaves de serviço seguras e nunca as exponha em código do lado do cliente ou em repositórios públicos`}),`\n`,_jsx(`div`,{id:`rate-limits`,children:_jsx(Heading,{level:`2`,id:`limites-de-taxa`,children:`Limites de taxa`})}),`\n`,_jsxs(_components.p,{children:[`As solicitações à API estão sujeitas a limitação de taxa para garantir a estabilidade do serviço. Se você exceder esse limite, receberá uma resposta `,_jsx(_components.code,{children:`429 Too Many Requests`}),`.`]}),`\n`,_jsx(`div`,{id:`support`,children:_jsx(Heading,{level:`2`,id:`suporte`,children:`Suporte`})}),`\n`,_jsxs(_components.p,{children:[`Para suporte à API e outras dúvidas, entre em contato com o `,_jsx(_components.a,{href:`https://windsurf.com/support`,children:`Windsurf Support`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Referência da API","description":"API Enterprise para consultar dados de uso do Windsurf e gerenciar configurações com autenticação via Service Key.","keywords":["API","enterprise","Service Key","autenticação","dados de uso","configuração","referência"],"href":"/pt-BR/windsurf/accounts/api-reference/api-introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Visão geral","slug":"visão-geral","depth":2,"children":[]},{"title":"URL base","slug":"url-base","depth":2,"children":[]},{"title":"Autenticação","slug":"autenticação","depth":2,"children":[{"title":"Criando uma Chave de serviço","slug":"criando-uma-chave-de-serviço","depth":3,"children":[]},{"title":"Permissões necessárias","slug":"permissões-necessárias","depth":3,"children":[]},{"title":"Usando Chaves de serviço","slug":"usando-chaves-de-serviço","depth":3,"children":[]}]},{"title":"Limites de taxa","slug":"limites-de-taxa","depth":2,"children":[]},{"title":"Suporte","slug":"suporte","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"codeium","siteName":"Windsurf Docs","title":"Referência da API - Windsurf Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/windsurf/accounts/api-reference/api-introduction","matchLevel":1},"fr":{"href":"/fr/windsurf/accounts/api-reference/api-introduction","matchLevel":1},"es":{"href":"/es/windsurf/accounts/api-reference/api-introduction","matchLevel":1},"de":{"href":"/de/windsurf/accounts/api-reference/api-introduction","matchLevel":1},"pt-BR":{"href":"/pt-BR/windsurf/accounts/api-reference/api-introduction","matchLevel":0},"zh":{"href":"/zh/windsurf/accounts/api-reference/api-introduction","matchLevel":1},"ja":{"href":"/ja/windsurf/accounts/api-reference/api-introduction","matchLevel":1},"ro":{"href":"/ro/windsurf/accounts/api-reference/api-introduction","matchLevel":1}}},"lastModified":"2026-03-09T16:57:17.928Z","originalFileLocation":"pt-BR/windsurf/accounts/api-reference/api-introduction.mdx","locale":"pt-BR"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"API Enterprise para consultar dados de uso do Windsurf e gerenciar configurações com autenticação via Service Key.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Windsurf Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/codeium/fpJcfiGfVrP-tNfE/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/codeium/fpJcfiGfVrP-tNfE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/codeium/fpJcfiGfVrP-tNfE/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/codeium/fpJcfiGfVrP-tNfE/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/codeium/fpJcfiGfVrP-tNfE/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/codeium/fpJcfiGfVrP-tNfE/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/codeium/fpJcfiGfVrP-tNfE/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/codeium/fpJcfiGfVrP-tNfE/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/codeium/fpJcfiGfVrP-tNfE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Referência da API - Windsurf Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Docs for Windsurf (formerly Codeium): your modern coding superpowers.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Windsurf Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.windsurf.com/pt-BR/windsurf/accounts/api-reference/api-introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://exafunction.github.io/public/hero/thumbnail_docs.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Referência da API - Windsurf Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Docs for Windsurf (formerly Codeium): your modern coding superpowers.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://exafunction.github.io/public/hero/thumbnail_docs.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/codeium/fpJcfiGfVrP-tNfE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Windsurf Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#34E8BB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.windsurf.com/pt-BR/windsurf/accounts/api-reference/api-introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pt-BR/windsurf/accounts/api-reference/api-introduction.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.windsurf.com/pt-BR/windsurf/accounts/api-reference/api-introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.windsurf.com/windsurf/accounts/api-reference/api-introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.windsurf.com/fr/windsurf/accounts/api-reference/api-introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.windsurf.com/es/windsurf/accounts/api-reference/api-introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.windsurf.com/de/windsurf/accounts/api-reference/api-introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.windsurf.com/zh/windsurf/accounts/api-reference/api-introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.windsurf.com/ja/windsurf/accounts/api-reference/api-introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ro\" href=\"https://docs.windsurf.com/ro/windsurf/accounts/api-reference/api-introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.windsurf.com/windsurf/accounts/api-reference/api-introduction\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.windsurf.com/#organization\",\"name\":\"Windsurf Docs\",\"url\":\"https://docs.windsurf.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/codeium/Hr_wKmLaXZaiQOb6/assets/windsurf-black-logo.svg?fit=max\u0026auto=format\u0026n=Hr_wKmLaXZaiQOb6\u0026q=85\u0026s=9d8592a768328271378364064a81840f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.windsurf.com#website\",\"name\":\"Windsurf Docs\",\"url\":\"https://docs.windsurf.com\",\"publisher\":{\"@id\":\"https://docs.windsurf.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.windsurf.com/pt-BR/windsurf/accounts/api-reference/api-introduction#webpage\",\"url\":\"https://docs.windsurf.com/pt-BR/windsurf/accounts/api-reference/api-introduction\",\"name\":\"Referência da API\",\"description\":\"API Enterprise para consultar dados de uso do Windsurf e gerenciar configurações com autenticação via Service Key.\",\"dateModified\":\"2026-03-09T16:57:17.928Z\",\"isPartOf\":{\"@id\":\"https://docs.windsurf.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.windsurf.com/pt-BR/windsurf/accounts/api-reference/api-introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.windsurf.com/pt-BR/windsurf/accounts/api-reference/api-introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Contas\",\"item\":\"https://docs.windsurf.com/pt-BR/windsurf/accounts/usage\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Teams e Enterprise\",\"item\":\"https://docs.windsurf.com/pt-BR/windsurf/accounts/teams-getting-started\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Referência da API\",\"item\":\"https://docs.windsurf.com/pt-BR/windsurf/accounts/api-reference/api-introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.windsurf.com/pt-BR/windsurf/accounts/api-reference/api-introduction#article\",\"headline\":\"Referência da API\",\"name\":\"Referência da API\",\"description\":\"API Enterprise para consultar dados de uso do Windsurf e gerenciar configurações com autenticação via Service Key.\",\"url\":\"https://docs.windsurf.com/pt-BR/windsurf/accounts/api-reference/api-introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.windsurf.com/pt-BR/windsurf/accounts/api-reference/api-introduction#webpage\"},\"image\":\"https://exafunction.github.io/public/hero/thumbnail_docs.png\",\"dateModified\":\"2026-03-09T16:57:17.928Z\",\"keywords\":\"API, enterprise, Service Key, autenticação, dados de uso, configuração, referência\",\"publisher\":{\"@id\":\"https://docs.windsurf.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.windsurf.com#website\"}}]}\u003c/script>","agentPointerHref":"/pt-BR/windsurf/accounts/api-reference/api-introduction.md","siteName":"Windsurf Docs","nav":{"global":null,"languages":[{"language":"en","pages":[{"title":"en","href":"/windsurf/accounts/api-reference/api-introduction"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/windsurf/accounts/api-reference/api-introduction"}]},{"language":"es","pages":[{"title":"es","href":"/es/windsurf/accounts/api-reference/api-introduction"}]},{"language":"de","pages":[{"title":"de","href":"/de/windsurf/accounts/api-reference/api-introduction"}]},{"language":"pt-BR","tabs":[{"tab":"Windsurf","groups":[{"group":"Editor","pages":[{"group":"Primeiros passos","pages":[{"title":"Bem-vindo ao Windsurf","sidebarTitle":"Configuração","href":"/pt-BR/windsurf/getting-started"},{"group":"Extensões recomendadas","pages":[{"title":"Extensões recomendadas","href":"/pt-BR/windsurf/recommended-extensions"},{"title":"C#, .NET e CPP","href":"/pt-BR/windsurf/csharp-cpp"}]}]},{"title":"Modelos de IA","sidebarTitle":"Modelos","href":"/pt-BR/windsurf/models"},{"title":"Windsurf Tab","sidebarTitle":"Tab","href":"/pt-BR/tab/overview"},{"title":"Command","sidebarTitle":"Command","href":"/pt-BR/command/windsurf-overview"},{"title":"Code Lenses","href":"/pt-BR/command/windsurf-related-features"},{"title":"Terminal","sidebarTitle":"Terminal","href":"/pt-BR/windsurf/terminal"},{"title":"Windsurf Previews","sidebarTitle":"Previews no navegador","href":"/pt-BR/windsurf/previews"},{"title":"Mensagens de commit com IA","href":"/pt-BR/windsurf/ai-commit-message"},{"title":"DeepWiki","sidebarTitle":"DeepWiki","href":"/pt-BR/windsurf/deepwiki"},{"title":"Codemaps","href":"/pt-BR/windsurf/codemaps"},{"title":"Vibe and Replace","sidebarTitle":"Vibe and Replace","href":"/pt-BR/windsurf/vibe-and-replace"},{"title":"Configuração Avançada","sidebarTitle":"Avançado","href":"/pt-BR/windsurf/advanced"}]},{"group":"Cascade","pages":[{"title":"Visão geral do Cascade","sidebarTitle":"Visão geral","href":"/pt-BR/windsurf/cascade/cascade"},{"title":"Modo Arena","sidebarTitle":"Modo Arena","href":"/pt-BR/windsurf/cascade/arena"},{"title":"Modos do Cascade","sidebarTitle":"Modos","href":"/pt-BR/windsurf/cascade/modes"},{"title":"Implantações de aplicativos","href":"/pt-BR/windsurf/cascade/app-deploys"},{"title":"Pesquisa na Web e em Documentação","href":"/pt-BR/windsurf/cascade/web-search"},{"title":"Memories \u0026 Rules","href":"/pt-BR/windsurf/cascade/memories"},{"title":"Skills","href":"/pt-BR/windsurf/cascade/skills"},{"title":"AGENTS.md","sidebarTitle":"AGENTS.md","href":"/pt-BR/windsurf/cascade/agents-md"},{"title":"Workflows","sidebarTitle":"Workflows","href":"/pt-BR/windsurf/cascade/workflows"},{"title":"Worktrees","sidebarTitle":"Worktrees","href":"/pt-BR/windsurf/cascade/worktrees"},{"title":"Model Context Protocol (MCP)","href":"/pt-BR/windsurf/cascade/mcp"},{"title":"Hooks do Cascade","href":"/pt-BR/windsurf/cascade/hooks"}]},{"group":"Contas","pages":[{"title":"Planos e uso de créditos","sidebarTitle":"Uso","href":"/pt-BR/windsurf/accounts/usage"},{"title":"Analytics","href":"/pt-BR/windsurf/accounts/analytics"},{"group":"Teams e Enterprise","pages":[{"group":"Primeiros passos","pages":[{"title":"Introdução ao Teams e Enterprise","sidebarTitle":"Introdução","href":"/pt-BR/windsurf/accounts/teams-getting-started"},{"title":"Guia para administradores","href":"/pt-BR/windsurf/guide-for-admins"}]},{"title":"Gerenciamento e Controle de Acesso Baseado em Funções","sidebarTitle":"Acesso Baseado em Funções","description":"Configure permissões de RBAC, crie funções personalizadas e gerencie o acesso de usuários nos planos Windsurf Teams e Enterprise.","href":"/pt-BR/windsurf/accounts/rbac-role-management"},{"group":"Referência da API","pages":[{"title":"Referência da API","href":"/pt-BR/windsurf/accounts/api-reference/api-introduction"},{"group":"Analytics API","pages":[{"title":"Analytics API","description":"Analytics API do plano Enterprise para consultar dados de uso do Windsurf, incluindo métricas de Autocomplete, Chat, Command e Cascade.","href":"/pt-BR/windsurf/accounts/api-reference/analytics-api-introduction"},{"title":"Obter Analytics da página do usuário","api":"POST https://server.codeium.com/api/v1/UserPageAnalytics","href":"/pt-BR/windsurf/accounts/api-reference/user-page-analytics"},{"title":"Obter Analytics do Cascade","api":"POST https://server.codeium.com/api/v1/CascadeAnalytics","href":"/pt-BR/windsurf/accounts/api-reference/cascade-analytics"},{"title":"Consulta personalizada do Analytics","api":"POST https://server.codeium.com/api/v1/Analytics","href":"/pt-BR/windsurf/accounts/api-reference/custom-analytics"},{"title":"Tratamento de erros","href":"/pt-BR/windsurf/accounts/api-reference/errors"}]},{"group":"API de utilização","pages":[{"title":"Definir configuração de uso","api":"POST https://server.codeium.com/api/v1/UsageConfig","href":"/pt-BR/windsurf/accounts/api-reference/usage-config"},{"title":"Obter configuração de uso","api":"POST https://server.codeium.com/api/v1/GetUsageConfig","href":"/pt-BR/windsurf/accounts/api-reference/get-usage-config"},{"title":"Obter saldo de créditos da equipe","api":"POST https://server.codeium.com/api/v1/GetTeamCreditBalance","href":"/pt-BR/windsurf/accounts/api-reference/get-team-credit-balance"}]}]},{"title":"Configurando SSO e SCIM","sidebarTitle":"SSO e SCIM","href":"/pt-BR/windsurf/accounts/sso-scim"},{"title":"Verificação de domínio","sidebarTitle":"Verificação de domínio","href":"/pt-BR/windsurf/accounts/domain-verification"}]}]},{"group":"Consciência de contexto","pages":[{"title":"Consciência de contexto do Windsurf","sidebarTitle":"Visão geral","href":"/pt-BR/context-awareness/windsurf-overview"},{"title":"Fast Context","href":"/pt-BR/context-awareness/fast-context"},{"title":"Windsurf Ignore","href":"/pt-BR/context-awareness/windsurf-ignore"}]},{"group":"Resolução de problemas","pages":[{"title":"Problemas comuns no Windsurf","sidebarTitle":"Problemas comuns","href":"/pt-BR/troubleshooting/windsurf-common-issues"},{"title":"Configuração de proxy no Windsurf Editor","sidebarTitle":"Configuração de proxy","href":"/pt-BR/troubleshooting/windsurf-proxy-configuration"},{"title":"Problemas de Inspeção TLS / SSL no Windsurf","sidebarTitle":"Inspeção SSL","href":"/pt-BR/troubleshooting/windsurf-ssl-inspection"},{"title":"Language Server falha com 'No Space Left on Device' no Linux","sidebarTitle":"Limites de inotify no Linux","href":"/pt-BR/troubleshooting/windsurf-inotify-limits"},{"title":"Problemas Conhecidos do WSL","sidebarTitle":"Problemas do WSL","href":"/pt-BR/troubleshooting/windsurf-wsl-performance"},{"title":"Coleta de logs do Windsurf","sidebarTitle":"Coleta de logs","href":"/pt-BR/troubleshooting/windsurf-gathering-logs"}]},{"group":"Segurança","pages":[{"title":"Guia de Administração de Segurança FedRAMP","sidebarTitle":"Guia de Administração de Segurança FedRAMP","href":"/pt-BR/security/security-admin-guide"},{"title":"Como reportar preocupações de segurança","sidebarTitle":"Reportar","href":"/pt-BR/security/reporting"}]}]},{"tab":"Windsurf Plugins","pages":[{"title":"Windsurf Plugins","href":"/pt-BR/plugins/getting-started"}]}],"global":{"anchors":[{"anchor":"Comunidade no Discord","icon":"discord","href":"https://discord.com/invite/3XFf78nAx5"},{"anchor":"Blog da Windsurf","icon":"newspaper","href":"https://windsurf.com/blog"},{"anchor":"Suporte","icon":"bug","href":"https://windsurf.com/support"}]}},{"language":"zh","pages":[{"title":"zh","href":"/zh/windsurf/accounts/api-reference/api-introduction"}]},{"language":"ja","pages":[{"title":"ja","href":"/ja/windsurf/accounts/api-reference/api-introduction"}]},{"language":"ro","pages":[{"title":"ro","href":"/ro/windsurf/accounts/api-reference/api-introduction"}]}]},"basePath":"","title":"Referência da API - Windsurf Docs","buildId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","deploymentId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","dynamics":[],"chunks":[]}
