# What is GitBook Agent?

GitBook Agent is an AI teammate that works alongside you. It helps you keep your documentation accurate, complete, and current. GitBook Agent is deeply integrated into GitBook. You don’t need new workflows to use it.

{% hint style="info" %}
If you edit your docs locally with an AI assistant, use [GitBook’s skill.md file](/docs/creating-content/ai-coding-assistants-and-skillmd.md).
{% endhint %}

### What can GitBook Agent do?

GitBook Agent can:

* **Write docs based on a prompt:** Ask GitBook Agent to update a page, rename a product, or make any other change you need.
* **Import content into GitBook:** Attach files like PDFs and Microsoft Word documents in the GitBook Agent chat sidebar. GitBook Agent extracts and formats the content into pages in your space.
* **Plan and implement bigger changes:** Describe what you need. GitBook Agent opens a change request, explains its edits, responds to feedback, and implements the plan you create together.
* **Understand your style guide:** Add your style guide in your site settings, and GitBook Agent applies it when writing or reviewing content.
* **Follow custom, site-level instructions:** Give GitBook Agent site-specific instructions, such as how to add links or which block types to avoid.
* **Translate your documentation:** Choose the content you want to translate, select a language, and GitBook Agent localizes your docs.
* **Summon from a comment:** Add a comment to any block on your page, type `@gitbook`, and tell GitBook Agent what you need.
* **Review change requests:** Add GitBook Agent as a reviewer on your change request. It can act as a docs linter, flag style guide issues, and suggest or fix errors.

#### Automatic documentation suggestions

{% hint style="warning" %}
**Automatic docs suggestions are in early access**

Head to [Agent audit](/docs/gitbook-agent/agent-audit.md) to learn more.
{% endhint %}

GitBook Agent can also connect to the signals your team uses to understand your product and your customers’ needs: support conversations, tickets, and threads from your connected tools.

With this context, GitBook Agent can identify gaps, propose updates, and generate docs changes automatically.

As your docs evolve with your product, your customers get the right information when they need it.

### Explore GitBook Agent’s features

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Write with GitBook Agent</strong></td><td>Create content from a prompt, or edit a single block</td><td><a href="/pages/I1LzGfTgQ5YbJG6cOtPP">/pages/I1LzGfTgQ5YbJG6cOtPP</a></td></tr><tr><td><strong>Review with GitBook Agent</strong></td><td>Ask GitBook Agent to check your work for spelling, grammar, and style</td><td><a href="/pages/cfQTrT0DlBarmP7uWCDx">/pages/cfQTrT0DlBarmP7uWCDx</a></td></tr><tr><td><strong>Translate your docs site</strong></td><td>GitBook Agent can create auto-updating localizations</td><td><a href="/pages/SCIhFLnUtEbtkZm5zN9x">/pages/SCIhFLnUtEbtkZm5zN9x</a></td></tr></tbody></table>

### Add a style guide and custom instructions

You can configure GitBook Agent with your team’s style guide or site-specific instructions.

GitBook Agent uses this context whenever it creates or edits content for that site.

To add a style guide or custom instructions, open your site’s **Settings** and choose the **Agents** tab. Add your instructions in the custom instructions field.

You can also open this screen from a change request. Open the GitBook Agent chat window, then open the **Actions menu** <picture><source srcset="/files/YjlF3Z9KMYv9aQiFzZKD" media="(prefers-color-scheme: dark)"><img src="/files/Zw9q37vPYF03vQIqywTy" alt=""></picture> and choose **Configure GitBook Agent** <picture><source srcset="/files/CG9bVSmdbJnQxrYiNbRI" media="(prefers-color-scheme: dark)"><img src="/files/Z6mVPT1qwXi4oXlarEpK" alt=""></picture>.

#### Custom instructions example

Here’s an example of the custom instructions you can add in GitBook Agent’s settings.

{% code overflow="wrap" %}

```
You are a technical writer at Stripe. Use clear, direct language and prioritize accuracy over flourish. For guides, always introduce the concept with a one-sentence summary and break content into well-structured sections. For quickstarts, always use a stepper and keep every step action-first and concise.
```

{% endcode %}

### FAQs

<details>

<summary>How does GitBook Agent use my data?</summary>

We follow our data protection practices to keep your data private.

GitBook Agent does not use your data to train AI models. We share the information you add to GitBook Agent with OpenAI only to provide GitBook Agent. See OpenAI’s privacy policy for more information.

</details>

<details>

<summary>How much does GitBook Agent cost?</summary>

GitBook Agent is free for all plans while in beta. If you’re not on Pro and not on a trial, free usage includes 10 messages per week.

[Translations](/docs/gitbook-agent/translations.md) are priced separately as a monthly add-on. Visit [the pricing section](/docs/gitbook-agent/translations.md#pricing) to find out more.

</details>

<details>

<summary>Can I override the default tone of GitBook Agent’s output?</summary>

Yes. You can override GitBook Agent’s default personality and tone.

If you want more detailed output, or a specific style or tone, tell GitBook Agent in site-level instructions or in a prompt in a change request.

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://gitbook.com/docs/gitbook-agent/what-is-gitbook-agent.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.