circle-info
The 2026 State of Docs report is here.
Read the reportarrow-up-right
LogoLogo
search
Ctrlk
Productchevron-downPricingLog inSign up
  • book-openDocumentation
  • bookGuides
  • rectangle-terminalDevelopers
  • bars-staggeredChangelog
GitBook Assistant
GitBook Assistant
Working...Thinking...
GitBook Assistant
Good night

I'm here to help you with the docs.

Ctrli
AI Based on your contextquestion-circle
  • Get Started
    • book-openOverview
    • boltQuickstart
    • sparklesAI-native documentation
    • swapMigrate to GitBook
    • code-pull-requestGitHub & GitLab Syncchevron-right
  • Your docs site
    • gearSite settings
    • paletteSite customizationchevron-right
    • window-restoreSite structurechevron-right
    • magnifying-glassAI Search
    • globe-pointerSet a custom domainchevron-right
    • globePublish a docs sitechevron-right
    • diamond-turn-rightSite redirects
    • picture-in-pictureEmbed in your productchevron-right
    • thumbs-upAI insights
    • chart-line-upSite analytics
    • file-pdfPDF export
  • Create content
    • i-cursorFormatting your contentchevron-right
    • folder-treeContent structurechevron-right
    • square-dashed-circle-plusBlockschevron-right
    • brainUsing skill.md
    • iconsVariables and expressions
    • repeatReusable content
    • magnifying-glassSearching internal contentchevron-right
    • rectangle-vertical-historyVersion control
  • Collaborate
    • user-plusInviting your team
    • usersMember managementchevron-right
    • code-branchChange requestschevron-right
    • file-shieldMerge rules
    • commentComments
    • message-exclamationNotifications
    • file-penLive edits
  • Site access
    • keyAuthenticated accesschevron-right
    • starsAdaptive contentchevron-right
  • AI & search
    • gitbook-assistantGitBook Assistant
    • link-simpleConnections
    • user-robotLLM-ready docs
    • mcpMCP servers for published docs
  • GitBook Agent
    • bolt-autoWhat is GitBook Agent?
    • wand-magic-sparklesWriting with GitBook Agent
    • spell-checkReview change requests with GitBook Agent
    • earth-americasTranslations
  • Document an API
    • brackets-curlyOpenAPIchevron-right
    • book-openGuideschevron-right
      • Structuring your API reference
      • Adding custom code samples
      • Managing API operations
      • Configuring the “Test it” button
      • Using OpenAPI proxy
      • Describing enums
      • Integrating with CI/CD
    • codeExtensions reference
  • Integrations
    • puzzle-pieceInstall and manage integrations
  • Account management
    • money-check-dollar-penPlanschevron-right
    • xmarkSubscription cancellations
    • userPersonal settings
    • sitemapOrganization settings
    • building-lockSSO & SAMLchevron-right
  • Resources
    • sidebarGitBook UIchevron-right
    • keyboardKeyboard shortcuts
    • book-openGlossary
    • lightbulbConcepts
gitbookPowered by GitBook
block-quoteOn this pagechevron-down
  1. Document an API

book-openGuides

Structuring your API referencechevron-rightAdding custom code sampleschevron-rightManaging API operationschevron-rightConfiguring the “Test it” buttonchevron-rightUsing OpenAPI proxychevron-rightDescribing enumschevron-rightIntegrating with CI/CDchevron-right

Was this helpful?

LogoLogo

Resources

  • Showcase
  • Enterprise
  • Status

Company

  • Careers
  • Blog
  • Community

Policies

  • Subprocessors
  • Terms of Service

Was this helpful?