circle-info
GitBook Agent is here! Introducing a new way to ideate, plan, and ship docs.
Find out morearrow-up-right
LogoLogo
search
Ctrlk
Productchevron-downPricingLog inSign up
  • book-openDocumentation
  • rectangle-terminalDevelopers
  • bookGuides
  • bars-staggeredChangelog
GitBook Assistant
GitBook Assistant
Working...Thinking...
GitBook Assistant
Good morning

I'm here to help you with the docs.

Ctrli
AI Based on your contextquestion-circle
LogoLogo
  • Get Started
    • book-openGitBook documentation
    • boltQuickstart
    • lightbulbConcepts
    • swapMigrate to GitBook
    • sparklesAI-native documentation
    • code-pull-requestGitHub & GitLab Sync
  • Create
    • i-cursorFormatting your content
    • folder-treeContent structure
    • square-dashed-circle-plusBlocks
    • iconsVariables and expressions
    • repeatReusable content
    • magnifying-glassSearching internal content
    • rectangle-vertical-historyVersion control
  • GitBook Agent
    • bolt-autoWhat is GitBook Agent?
    • message-penAutomatic documentation suggestions
    • wand-magic-sparklesWriting with GitBook Agent
    • spell-checkReview change requests with GitBook Agent
    • earth-americasTranslations
  • Collaborate
    • user-plusInviting your team
    • code-branchChange requests
    • file-shieldMerge rules
    • commentComments
    • message-exclamationNotifications
    • file-pdfPDF export
    • file-penLive edits
  • Document an API
    • brackets-curlyOpenAPI
    • book-openGuides
      • Structuring your API reference
      • Adding custom code samples
      • Managing API operations
      • Configuring the “Test it” button
      • Describing enums
      • Integrating with CI/CD
    • codeExtensions reference
  • Publish Documentation
    • globePublish a docs site
    • window-restoreSite structure
    • paletteSite customization
    • globe-pointerSet a custom domain
    • folder-treeSetting a custom subdirectory
    • gearSite settings
    • chart-line-upSite insights
    • diamond-turn-rightSite redirects
    • keyAuthenticated access
    • starsAdaptive content
    • magnifying-glassAI Search
    • gitbook-assistantGitBook Assistant
    • user-robotLLM-ready docs
    • mcpMCP servers for published docs
    • window-restoreEmbed in your product
  • Integrations
    • puzzle-pieceInstall and manage integrations
  • Account management
    • money-check-dollar-penPlans
    • xmarkSubscription cancellations
    • userPersonal settings
    • sitemapOrganization settings
    • usersMember management
    • building-lockSSO & SAML
  • Resources
    • sidebarGitBook UI
    • keyboardKeyboard shortcuts
    • book-openGlossary
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-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?