{% columns %}
{% column %}
### Get started in 5 minutes
Setting up your first API call should be the easiest part of getting started. With clear endpoints, copy-paste-ready examples, and quick authentication, you’ll be up and running in minutes—not hours.
No guesswork, no complexity—just your first successful call, fast.
Get startedAPI reference
{% endcolumn %}
{% column %}
{% code title="index.js" overflow="wrap" %}
```javascript
// Import the SDK
import ExampleAPI from "example-api";
// Initialize the client
const client = new ExampleAPI({ apiKey: "YOUR_API_KEY" });
// Send your first message
const response = await client.messages.send({
message: "Hello, world!"
});
```
{% endcode %}
{% endcolumn %}
{% endcolumns %}
{% columns %}
{% column %}
{% endcolumn %}
{% column %}
### Learn more about the developer platform
Read guides, watch tutorials, and learn more about working with the developer platform and integrating it with your own stack.
GuidesDocumentation
{% endcolumn %}
{% endcolumns %}
Join a community of over 3,000 developers
Join our Discord community or create your first PR in just a few steps.
:discord:
Discord community
Join our Discord community to post questions, get help, and share resources with over 3,000 like-minded developers.
# 文档 Welcome
Welcome to the GitBook starter template! Here you'll get an overview of all the amazing features GitBook offers to help you build beautiful, interactive documentation.
You'll see some of the best parts of GitBook in action — and find help on how you can turn this template into your own.
### Jump right in
# Quickstart
Beautiful documentation starts with the content you create — and GitBook makes it easy to get started with any pre-existing content.
{% hint style="info" %}
Want to learn about writing content from scratch? Head to the [Basics](/docs/basics/editor) section to learn more.
{% endhint %}
### Import
GitBook supports importing content from many popular writing tools and formats. If your content already exists, you can upload a file or group of files to be imported.
### Sync a repository
GitBook also allows you to set up a bi-directional sync with an existing repository on GitHub or GitLab. Setting up Git Sync allows you and your team to write content in GitBook or in code, and never have to worry about your content becoming out of sync.
# Publish your docs
Once you’ve finished writing, editing, or importing your content, you can publish your work to the web as a docs site. Once published, your site will be accessible online only to your selected audience.
You can publish your site and find related settings from your docs site's homepage.
# Editor
GitBook has a powerful block-based editor that allows you to seamlessly create, update, and enhance your content.
### Writing content
GitBook offers a range of block types for you to add to your content inline — from simple text and tables, to code blocks and more. These elements will make your pages more useful to readers, and offer extra information and context.
Either start typing below, or press `/` to see a list of the blocks you can insert into your page.
### Add a new block
{% stepper %}
{% step %}
#### Open the insert block menu
Press `/` on your keyboard to open the insert block menu.
{% endstep %}
{% step %}
#### Search for the block you need
Try searching for “Stepper”, for exampe, to insert the stepper block.
{% endstep %}
{% step %}
#### Insert and edit your block
Click or press Enter to insert your block. From here, you’ll be able to edit it as needed.
{% endstep %}
{% endstepper %}
# Markdown
GitBook supports many different types of content, and is backed by Markdown — meaning you can copy and paste any existing Markdown files directly into the editor!
Feel free to test it out and copy the Markdown below by hovering over the code block in the upper right, and pasting into a new line underneath.
```markdown
# Heading
This is some paragraph text, with a [link](https://docs.gitbook.com) to our docs.
## Heading 2
- Point 1
- Point 2
- Point 3
```
{% hint style="info" %}
If you have multiple files, GitBook makes it easy to import full repositories too — allowing you to keep your GitBook content in sync.
{% endhint %}
# Images & media
GitBook allows you to add images and media easily to your docs. Simply drag a file into the editor, or use the file manager in the upper right corner to upload multiple images at once.
Add alt text and captions to your images
{% hint style="info" %}
You can also add images simply by copying and pasting them directly into the editor — and GitBook will automatically add it to your file manager.
{% endhint %}
# Interactive blocks
In addition to the default Markdown you can write, GitBook has a number of out-of-the-box interactive blocks you can use. You can find interactive blocks by pressing `/` from within the editor.
### Tabs
{% tabs %}
{% tab title="First tab" %}
Each tab is like a mini page — it can contain multiple other blocks, of any type. So you can add code blocks, images, integration blocks and more to individual tabs in the same tab block.
{% endtab %}
{% tab title="Second tab" %}
Add images, embedded content, code blocks, and more.
```javascript
const handleFetchEvent = async (request, context) => {
return new Response({message: "Hello World"});
};
```
{% endtab %}
{% endtabs %}
### Expandable sections
Click me to expand
Expandable blocks are helpful in condensing what could otherwise be a lengthy paragraph. They are also great in step-by-step guides and FAQs.
### Embedded content
{% embed url="" %}
{% hint style="info" %}
GitBook supports thousands of embedded websites out-of-the-box, simply by pasting their links. Feel free to check out which ones[ are supported natively](https://iframely.com).
{% endhint %}
# Integrations
GitBook integrations allow you to connect your GitBook spaces to some of your favorite platforms and services. You can install integrations into your GitBook page from the *Integrations* menu in the top left.
### Types of integrations
# Developer Platform API
Learn more about documenting APIs in GitBook.
GitBook automatically generates pages and endpoints for your OpenAPI spec. Fully customizable and equipped with testing capabilities, your documentation has never been more powerful.
The API reference below is automatically generated from a demo OpenAPI spec in this space.
View OpenAPI spec
# Welcome to the GitBook Petstore API
This GitBook API documentation template serves as a starting point for creating clear, interactive, and user-friendly API documentation.
Use this template to explore best practices in structuring your docs, showcasing endpoints, and guiding users through your API. Everything here can be adapted to fit your own product.
#### How this demo works
This reference is automatically generated from an OpenAPI spec uploaded to this GitBook space. GitBook reads the spec and creates a page for each tag, with interactive endpoint blocks for every operation — no manual authoring required.
A few things worth noticing as you explore:
* **Page groups** — tags with no endpoints (like *Store* and *Pets*) become navigation sections automatically, keeping related endpoints grouped without any extra configuration.
* **Auto-split pages** — `##` headings inside `info.description` are automatically split into separate pages in the navigation, which is how this welcome section is structured.
* **Stability badges** — some endpoints are marked `experimental` or `beta` using the `x-stability` extension. You'll see these highlighted on the endpoint itself.
* **Deprecation warnings** — `GET /pets/{petId}` is marked deprecated with a sunset date, surfaced as a warning banner on that endpoint's page.
* **Code samples** — each endpoint includes hand-written examples in cURL, JavaScript, and Python via `x-codeSamples`, supplementing the auto-generated snippets.
* **Try it panel** — most endpoints have a live testing panel on the right. `GET /store/orders` has it disabled via `x-hideTryItPanel` to show that control is per-endpoint.
To use this template for your own API, replace the spec with your own OpenAPI file and adjust the `info.description` to match your product.
# Servers & Authentication
#### Servers
{% tabs %}
{% tab title="Production" %}
**Base URL** `https://petstore.example.com/v1`
{% endtab %}
{% tab title="Staging" %}
**Base URL** `https://staging.petstore.example.com/v1`
{% endtab %}
{% endtabs %}
{% hint style="info" %}
Both servers are available in the **Try it** panel on each endpoint page. Use the server switcher in the top-right of the panel to toggle between Production and Staging without leaving the docs.
{% endhint %}
#### Authentication
All requests must include your API key in the `Authorization` header:
```
Authorization: Bearer YOUR_API_KEY
```
{% hint style="info" %}
Generate an API key from your [account dashboard](https://petstore.example.com/dashboard/keys). Keys are scoped to a single workspace.
{% endhint %}
# Getting started
{% stepper %}
{% step %}
### Create an account
Sign up at [petstore.example.com](https://petstore.example.com) — it's free.
{% endstep %}
{% step %}
### Get your API key
Head to your dashboard and copy your key from the **API Keys** section.
{% endstep %}
{% step %}
### Make your first request
Call `GET /pets` to verify connectivity and see available pets.
{% endstep %}
{% endstepper %}
# Error responses
All errors follow a consistent structure:
```json
{
"error": {
"code": "not_found",
"message": "The requested resource could not be found.",
"status": 404
}
}
```
| Status | Meaning |
| ------ | ----------------------------------------- |
| `400` | Bad request — check your request body |
| `401` | Unauthorized — missing or invalid API key |
| `403` | Forbidden — insufficient permissions |
| `404` | Not found |
| `429` | Rate limited — back off and retry |
| `500` | Server error |
{% hint style="warning" %}
This API is for demo purposes only — **don't** use it in production.
{% endhint %}
# Store
# Orders
Place and manage customer orders.
## List orders
> Returns all orders placed in the store. Does not currently support filtering or pagination.\
> \
> {% hint style="info" %}\
> Filtering and pagination are planned for v2. Subscribe to the \[changelog]\() for updates.\
> {% endhint %}
```json
{"openapi":"3.0.3","info":{"title":"GitBook Petstore API","version":"1.0.0"},"tags":[{"name":"orders"}],"servers":[{"url":"https://petstore.example.com/v1","description":"Production"},{"url":"https://staging.petstore.example.com/v1","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Pass your API key as a Bearer token in the `Authorization` header."}},"schemas":{"Order":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique order identifier."},"petId":{"type":"integer","format":"int64","description":"The ID of the animal in this order."},"quantity":{"type":"integer","description":"Number of units ordered."},"shipDate":{"type":"string","format":"date-time","description":"Expected or actual ship date in ISO 8601 format."},"complete":{"type":"boolean","description":"Whether the order has been fulfilled."}}},"Error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable description of the error."},"status":{"type":"integer","description":"The HTTP status code."}}}},"responses":{"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/store/orders":{"get":{"summary":"List orders","description":"Returns all orders placed in the store. Does not currently support filtering or pagination.\n\n{% hint style=\"info\" %}\nFiltering and pagination are planned for v2. Subscribe to the [changelog](https://petstore.example.com/changelog) for updates.\n{% endhint %}\n","tags":["orders"],"operationId":"listOrders","responses":{"200":{"description":"An array of orders.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Order"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```
## Cancel an order
> Cancels an order by ID. Only orders with a status of \`pending\` can be cancelled — orders that have already shipped cannot be reversed.
```json
{"openapi":"3.0.3","info":{"title":"GitBook Petstore API","version":"1.0.0"},"tags":[{"name":"orders"}],"servers":[{"url":"https://petstore.example.com/v1","description":"Production"},{"url":"https://staging.petstore.example.com/v1","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Pass your API key as a Bearer token in the `Authorization` header."}},"responses":{"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable description of the error."},"status":{"type":"integer","description":"The HTTP status code."}}}}},"paths":{"/store/orders/{orderId}":{"delete":{"summary":"Cancel an order","description":"Cancels an order by ID. Only orders with a status of `pending` can be cancelled — orders that have already shipped cannot be reversed.","tags":["orders"],"operationId":"cancelOrder","parameters":[{"name":"orderId","in":"path","required":true,"description":"The ID of the order to cancel.","schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Order cancelled successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Order cannot be cancelled — it has already shipped."}}}}}}
```
# Inventory
Track and update stock levels for pets in the store.
## List inventory
> Returns current stock levels for all pets in the store.
```json
{"openapi":"3.0.3","info":{"title":"GitBook Petstore API","version":"1.0.0"},"tags":[{"name":"inventory"}],"servers":[{"url":"https://petstore.example.com/v1","description":"Production"},{"url":"https://staging.petstore.example.com/v1","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Pass your API key as a Bearer token in the `Authorization` header."}},"schemas":{"InventoryItem":{"type":"object","required":["petId","quantity","status"],"properties":{"petId":{"type":"integer","format":"int64","description":"The ID of the animal this entry tracks."},"quantity":{"type":"integer","description":"Current stock count."},"status":{"$ref":"#/components/schemas/PetStatus"}}},"PetStatus":{"type":"string","enum":["available","pending","sold"]},"Error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable description of the error."},"status":{"type":"integer","description":"The HTTP status code."}}}},"responses":{"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/inventory":{"get":{"summary":"List inventory","description":"Returns current stock levels for all pets in the store.","tags":["inventory"],"operationId":"listInventory","responses":{"200":{"description":"An array of inventory entries.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InventoryItem"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```
## Update stock level
> Updates the stock quantity for a specific pet. Use this to record new arrivals, returns, or manual adjustments.\
> \
> {% hint style="warning" %}\
> This endpoint is \*\*experimental\*\* — the request shape may change before it reaches stable.\
> {% endhint %}
```json
{"openapi":"3.0.3","info":{"title":"GitBook Petstore API","version":"1.0.0"},"tags":[{"name":"inventory"}],"servers":[{"url":"https://petstore.example.com/v1","description":"Production"},{"url":"https://staging.petstore.example.com/v1","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Pass your API key as a Bearer token in the `Authorization` header."}},"schemas":{"InventoryUpdate":{"type":"object","required":["quantity"],"properties":{"quantity":{"type":"integer","description":"The new stock count."}}},"InventoryItem":{"type":"object","required":["petId","quantity","status"],"properties":{"petId":{"type":"integer","format":"int64","description":"The ID of the animal this entry tracks."},"quantity":{"type":"integer","description":"Current stock count."},"status":{"$ref":"#/components/schemas/PetStatus"}}},"PetStatus":{"type":"string","enum":["available","pending","sold"]},"Error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable description of the error."},"status":{"type":"integer","description":"The HTTP status code."}}}},"responses":{"BadRequest":{"description":"The request body is missing required fields or contains invalid values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/inventory/{petId}":{"patch":{"summary":"Update stock level","description":"Updates the stock quantity for a specific pet. Use this to record new arrivals, returns, or manual adjustments.\n\n{% hint style=\"warning\" %}\nThis endpoint is **experimental** — the request shape may change before it reaches stable.\n{% endhint %}\n","tags":["inventory"],"operationId":"updateInventory","parameters":[{"name":"petId","in":"path","required":true,"description":"The ID of the pet to update stock for.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryUpdate"}}}},"responses":{"200":{"description":"Updated inventory entry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryItem"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```
# Pets
# Animals
Browse and manage individual animals available for adoption.
## List all animals
> Returns a paginated list of all animals in the store. Use \`limit\` to control page size and \`status\` to filter by availability.
```json
{"openapi":"3.0.3","info":{"title":"GitBook Petstore API","version":"1.0.0"},"tags":[{"name":"animals"}],"servers":[{"url":"https://petstore.example.com/v1","description":"Production"},{"url":"https://staging.petstore.example.com/v1","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Pass your API key as a Bearer token in the `Authorization` header."}},"schemas":{"PetStatus":{"type":"string","enum":["available","pending","sold"]},"Pets":{"type":"array","items":{"$ref":"#/components/schemas/Pet"}},"Pet":{"allOf":[{"$ref":"#/components/schemas/NewPet"},{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier assigned on creation."}}}]},"NewPet":{"type":"object","required":["name","categoryId"],"properties":{"name":{"type":"string","description":"The animal's name."},"categoryId":{"type":"integer","format":"int64","description":"The ID of the category this animal belongs to."},"status":{"$ref":"#/components/schemas/PetStatus"}}},"Error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable description of the error."},"status":{"type":"integer","description":"The HTTP status code."}}}},"responses":{"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/pets":{"get":{"summary":"List all animals","description":"Returns a paginated list of all animals in the store. Use `limit` to control page size and `status` to filter by availability.","tags":["animals"],"operationId":"listPets","parameters":[{"name":"limit","in":"query","description":"Maximum number of animals to return. Defaults to 20, max 100.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"status","in":"query","description":"Filter by availability status.","schema":{"$ref":"#/components/schemas/PetStatus"}}],"responses":{"200":{"description":"A paginated list of animals.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pets"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```
## Add an animal
> Adds a new animal to the store. The \`name\` and \`categoryId\` fields are required.
```json
{"openapi":"3.0.3","info":{"title":"GitBook Petstore API","version":"1.0.0"},"tags":[{"name":"animals"}],"servers":[{"url":"https://petstore.example.com/v1","description":"Production"},{"url":"https://staging.petstore.example.com/v1","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Pass your API key as a Bearer token in the `Authorization` header."}},"schemas":{"NewPet":{"type":"object","required":["name","categoryId"],"properties":{"name":{"type":"string","description":"The animal's name."},"categoryId":{"type":"integer","format":"int64","description":"The ID of the category this animal belongs to."},"status":{"$ref":"#/components/schemas/PetStatus"}}},"PetStatus":{"type":"string","enum":["available","pending","sold"]},"Pet":{"allOf":[{"$ref":"#/components/schemas/NewPet"},{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier assigned on creation."}}}]},"Error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable description of the error."},"status":{"type":"integer","description":"The HTTP status code."}}}},"responses":{"BadRequest":{"description":"The request body is missing required fields or contains invalid values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/pets":{"post":{"summary":"Add an animal","description":"Adds a new animal to the store. The `name` and `categoryId` fields are required.","tags":["animals"],"operationId":"createPet","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPet"}}}},"responses":{"201":{"description":"Animal added successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pet"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```
## Get an animal
> Returns details for a single animal by ID.\
> \
> {% hint style="danger" %}\
> \*\*This endpoint is deprecated\*\* and will be removed on \*\*5 December 2030\*\*. Use \`GET /pets\` with a \`status\` filter instead.\
> {% endhint %}
```json
{"openapi":"3.0.3","info":{"title":"GitBook Petstore API","version":"1.0.0"},"tags":[{"name":"animals"}],"servers":[{"url":"https://petstore.example.com/v1","description":"Production"},{"url":"https://staging.petstore.example.com/v1","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Pass your API key as a Bearer token in the `Authorization` header."}},"schemas":{"Pet":{"allOf":[{"$ref":"#/components/schemas/NewPet"},{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier assigned on creation."}}}]},"NewPet":{"type":"object","required":["name","categoryId"],"properties":{"name":{"type":"string","description":"The animal's name."},"categoryId":{"type":"integer","format":"int64","description":"The ID of the category this animal belongs to."},"status":{"$ref":"#/components/schemas/PetStatus"}}},"PetStatus":{"type":"string","enum":["available","pending","sold"]},"Error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable description of the error."},"status":{"type":"integer","description":"The HTTP status code."}}}},"responses":{"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/pets/{petId}":{"get":{"summary":"Get an animal","description":"Returns details for a single animal by ID.\n\n{% hint style=\"danger\" %}\n**This endpoint is deprecated** and will be removed on **5 December 2030**. Use `GET /pets` with a `status` filter instead.\n{% endhint %}\n","tags":["animals"],"operationId":"getPet","parameters":[{"name":"petId","in":"path","required":true,"description":"The ID of the animal to retrieve.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The requested animal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pet"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"deprecated":true}}}}
```
# Categories
Manage the species and breed categories used to classify pets.
## List categories
> Returns all categories available for classifying pets (e.g. dog, cat, rabbit).
```json
{"openapi":"3.0.3","info":{"title":"GitBook Petstore API","version":"1.0.0"},"tags":[{"name":"categories"}],"servers":[{"url":"https://petstore.example.com/v1","description":"Production"},{"url":"https://staging.petstore.example.com/v1","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Pass your API key as a Bearer token in the `Authorization` header."}},"schemas":{"Category":{"allOf":[{"$ref":"#/components/schemas/NewCategory"},{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier assigned on creation."}}}]},"NewCategory":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The category name (e.g. Dog, Cat, Rabbit)."},"description":{"type":"string","description":"A short description of the category."}}},"Error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable description of the error."},"status":{"type":"integer","description":"The HTTP status code."}}}},"responses":{"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/categories":{"get":{"summary":"List categories","description":"Returns all categories available for classifying pets (e.g. dog, cat, rabbit).","tags":["categories"],"operationId":"listCategories","responses":{"200":{"description":"An array of categories.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```
## Create a category
> Adds a new category for classifying pets.
```json
{"openapi":"3.0.3","info":{"title":"GitBook Petstore API","version":"1.0.0"},"tags":[{"name":"categories"}],"servers":[{"url":"https://petstore.example.com/v1","description":"Production"},{"url":"https://staging.petstore.example.com/v1","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Pass your API key as a Bearer token in the `Authorization` header."}},"schemas":{"NewCategory":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The category name (e.g. Dog, Cat, Rabbit)."},"description":{"type":"string","description":"A short description of the category."}}},"Category":{"allOf":[{"$ref":"#/components/schemas/NewCategory"},{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier assigned on creation."}}}]},"Error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable description of the error."},"status":{"type":"integer","description":"The HTTP status code."}}}},"responses":{"BadRequest":{"description":"The request body is missing required fields or contains invalid values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/categories":{"post":{"summary":"Create a category","description":"Adds a new category for classifying pets.","tags":["categories"],"operationId":"createCategory","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewCategory"}}}},"responses":{"201":{"description":"Category created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```
# Site-Changelog-cn
New updates and improvements
{% updates format="full" %}
{% update date="2025-12-03" %}
## Product update
See what’s new and improved in our latest update.
### Product feature
* Feature description
* Feature description
Read the documentation
# Sites-Welcome
Welcome to the GitBook starter template! Here you'll get an overview of all the amazing features GitBook offers to help you build beautiful, interactive documentation.
You'll see some of the best parts of GitBook in action — and find help on how you can turn this template into your own.
### Jump right in
# Quickstart
Beautiful documentation starts with the content you create — and GitBook makes it easy to get started with any pre-existing content.
{% hint style="info" %}
Want to learn about writing content from scratch? Head to the [Basics](/blog/basics/editor) section to learn more.
{% endhint %}
### Import
GitBook supports importing content from many popular writing tools and formats. If your content already exists, you can upload a file or group of files to be imported.
### Sync a repository
GitBook also allows you to set up a bi-directional sync with an existing repository on GitHub or GitLab. Setting up Git Sync allows you and your team to write content in GitBook or in code, and never have to worry about your content becoming out of sync.
# Publish your docs
Once you’ve finished writing, editing, or importing your content, you can publish your work to the web as a docs site. Once published, your site will be accessible online only to your selected audience.
You can publish your site and find related settings from your docs site's homepage.
# Editor
GitBook has a powerful block-based editor that allows you to seamlessly create, update, and enhance your content.
### Writing content
GitBook offers a range of block types for you to add to your content inline — from simple text and tables, to code blocks and more. These elements will make your pages more useful to readers, and offer extra information and context.
Either start typing below, or press `/` to see a list of the blocks you can insert into your page.
### Add a new block
{% stepper %}
{% step %}
#### Open the insert block menu
Press `/` on your keyboard to open the insert block menu.
{% endstep %}
{% step %}
#### Search for the block you need
Try searching for “Stepper”, for exampe, to insert the stepper block.
{% endstep %}
{% step %}
#### Insert and edit your block
Click or press Enter to insert your block. From here, you’ll be able to edit it as needed.
{% endstep %}
{% endstepper %}
# Markdown
GitBook supports many different types of content, and is backed by Markdown — meaning you can copy and paste any existing Markdown files directly into the editor!
Feel free to test it out and copy the Markdown below by hovering over the code block in the upper right, and pasting into a new line underneath.
```markdown
# Heading
This is some paragraph text, with a [link](https://docs.gitbook.com) to our docs.
## Heading 2
- Point 1
- Point 2
- Point 3
```
{% hint style="info" %}
If you have multiple files, GitBook makes it easy to import full repositories too — allowing you to keep your GitBook content in sync.
{% endhint %}
# Images & media
GitBook allows you to add images and media easily to your docs. Simply drag a file into the editor, or use the file manager in the upper right corner to upload multiple images at once.
Add alt text and captions to your images
{% hint style="info" %}
You can also add images simply by copying and pasting them directly into the editor — and GitBook will automatically add it to your file manager.
{% endhint %}
# Interactive blocks
In addition to the default Markdown you can write, GitBook has a number of out-of-the-box interactive blocks you can use. You can find interactive blocks by pressing `/` from within the editor.
### Tabs
{% tabs %}
{% tab title="First tab" %}
Each tab is like a mini page — it can contain multiple other blocks, of any type. So you can add code blocks, images, integration blocks and more to individual tabs in the same tab block.
{% endtab %}
{% tab title="Second tab" %}
Add images, embedded content, code blocks, and more.
```javascript
const handleFetchEvent = async (request, context) => {
return new Response({message: "Hello World"});
};
```
{% endtab %}
{% endtabs %}
### Expandable sections
Click me to expand
Expandable blocks are helpful in condensing what could otherwise be a lengthy paragraph. They are also great in step-by-step guides and FAQs.
### Embedded content
{% embed url="" %}
{% hint style="info" %}
GitBook supports thousands of embedded websites out-of-the-box, simply by pasting their links. Feel free to check out which ones[ are supported natively](https://iframely.com).
{% endhint %}
# Integrations
GitBook integrations allow you to connect your GitBook spaces to some of your favorite platforms and services. You can install integrations into your GitBook page from the *Integrations* menu in the top left.
### Types of integrations
#### **1. vUser Telegram 批量发送机器人**
Virtual-User（vUser）是一类典型的 **Windows Telegram 群发软件**。 它主打批量发送与自动化操作。 你可以把它当成“群发私信工具 + 成员采集工具”的组合。
我们建议您仔细查看它的各种功能，并与竞争对手进行比较。
它通常支持从群组提取 ID。 也支持向用户名、ID 或手机号发送私信。 部分版本会提供限速与防封建议。
#### 2. 适用于 PC 的 Telegram 群发消息工具（批量私信）
[Telegram Sender](https://telegramsender.com/)是一款适用于 Windows PC 的软件，用于向 Telegram 群组或频道成员批量发送消息。只需单击一下，即可向所有 Telegram 用户发送消息。您可以手动添加用户，也可以从文件中导入。
无论你是否是管理员，它都能帮你提取群组中所有用户的用户ID。因此，Telegram Sender 也为向竞争对手的群组成员进行营销提供了一种绝佳的方式。
#### 3. 适用于 Android 的 Telegram 群发消息器（逐个发送）
[PackGram](https://play.google.com/store/apps/details?id=com.telegraph.telegram)是一款适用于安卓手机的免费应用，用于批量发送 Telegram 消息。您可以搜索感兴趣的 Telegram 群组，输入个性化消息，然后逐个发送给每位成员。
只需轻轻一点，所有 Telegram 群组成员即可收到您的推广信息。您还可以获取收到您信息的用户的详细信息。
#### 4. Telegram 批量消息 Python 脚本（自动化私信）
另一种在 Telegram 上发送批量消息的方法是使用自定义 Python 脚本。[这里有一个来自 GitHub 的脚本](https://github.com/inforkgodara/telegram-automated-bulk-messages)，它使用 Telegram 桌面应用程序发送消息。要使此脚本正常工作，您需要一个包含所有要发送消息的 Telegram 用户名的 Excel 表格。
设置完成后，只需登录 Telegram 桌面版并运行脚本即可。脚本会读取 Excel 表格中的数据，并将配置好的消息逐一发送给所有用户。
#### 5. Chrome 扩展程序：抓取成员并群发 Telegram 消息
[BulkTele](https://chrome.google.com/webstore/detail/bulktele-mass-invite-%20-me/lkabifackfijfdhlemldnjmipmgcacno) Chrome 扩展程序是向 Telegram 群组成员发送批量消息的最简便方法之一。您可以从 Telegram 群组中抓取成员用户名，并轻松地向他们发送您的营销信息。
它还可以帮助提取竞争对手群组的用户名，并批量邀请他们加入你自己的群组。对于希望通过 Telegram 营销发展业务的人来说，它是理想的扩展程序。
#### 6. Telegram 自动转发器（广播式群发）
[自动转发 Telegram 机器人](https://sktechhub.com/auto-forward)是一种向多个 Telegram 用户发送消息的替代方案。对于需要开展交易或自动化 Telegram 营销的用户来说，这款机器人非常实用。
它可以接收来自群组、频道或个人用户的消息，并将其转发给选定的 Telegram 用户。它还可以在转发前翻译和自定义消息。
### 如何选择 Telegram 群发工具（减少封禁与举报风险）
优先看这几个点。
1. **发送方式**：批量私信、群组广播、还是自动转发。
2. **人群来源**：是否支持从群组/频道导入成员用户名与 ID。
3. **限速与间隔**：能否设置随机间隔、每日上限、分批发送。
4. **内容能力**：变量模板、个性化字段、A/B 文案。
5. **账号安全**：多账号轮换、代理支持、错误重试与日志。
{% hint style="info" %}
你发的越“像真人”，越不容易触发风控。 优先做分组、分批、低频触达。
{% endhint %}
### 总结
Telegram 群发消息适合做低成本触达。 你可以用群发工具批量私信群组成员。 也可以用自动转发做“广播式”分发。
#### 常见问题（FAQ）
**Telegram 可以直接群发私信给群组所有成员吗？**\
Telegram 没有官方“一键群发私信”能力。 通常需要第三方工具或脚本逐个发送。
**Telegram 群发会被封号吗？**\
高频、重复文案、被多人举报时，风险会上升。 用限速、分批、人群筛选和个性化文案能降风险。
**给非联系人发消息可以吗？**\
能否成功取决于对方隐私设置与账号状态。 先做价值交换式触达，避免硬广开场。
# How to Send Bulk Messages to Telegram Group Members? -Broadcast Telegram Messages
Although Telegram is feature-rich, sending bulk messages to Telegram group members can be frustrating. There’s no easy way to select all users at once and broadcast your message.
Thus, custom-made Telegram tools to the rescue. Custom Telegram apps, bots, and scripts can easily scrape target audience details from different groups. They can segment the users and send them automated direct messages.
So, in this article, we’re providing you with five ways to send bulk messages to Telegram group members. Using these tools, you can find niche target audiences and get high open rates for your messages.
Let’s dive in.
### Why should businesses use Telegram to send bulk messages?
Telegram marketing is cost-effective to market your business to your target audience. In the present times, where people are averse to promotional messages, you can reach out to them. Some of the benefits of using Telegram for bulk messages are:
* Find niche audience:
Telegram is an ideal app to find and target a niche audience. By looking into the right groups and channels, you can grow a broad user base for your business marketing.
* Get high open rates:
Telegram is a messenger app. So, the messages sent on Telegram reach the users directly. It speeds up organic growth and brings leads fast.
* Automate tasks:
Telegram has bots to perform a variety of tasks. You can even create custom bots to automate different processes and engage your audience.
### Five ways to send bulk messages to Telegram group members
Following are the five ways to use Telegram bulk message sender tools.
#### **1. vUser Telegram Bulk Sender Bot**
The first and best software for sending bulk messages in Telegram is the Virtual-User software, which has more features than any of its competitors. This software is installed on your Windows system and sends as many messages as you want without the need for a fee. However, this software is not free, but it has a very reasonable price and is definitely worth buying compared to the other free software programs and its own competitors.
We recommend that you take a look at the various features it has and compare it with competitors.
The bot, that comes with a lifetime license, can extract IDs from groups and send direct messages to IDs or mobile numbers. Using this bot, you can add IDs or send messages to the groups automatically. The bot package also includes the valuable tutorial on tips and tricks not to get blocked and reported.
#### 2. Telegram bulk message sender for PC
[Telegram Sender](https://telegramsender.com/) is a software for Windows PC to send bulk messages to Telegram group or channel members. With one click, you can send messages to all the Telegram users you have. You can add users manually or import them from a file.
It helps you extract the user ID of all users from groups, whether you’re the admin or not. So, Telegram Sender offers a great way to market to your competitor group members too.
#### 3. Telegram bulk message sender for Android
[PackGram](https://play.google.com/store/apps/details?id=com.telegraph.telegram) is a free app for Android mobile phones to send bulk Telegram messages. You can search for Telegram groups of your interest, type a personalised message and send it to each member individually.
With one tap, all Telegram group members receive your promotional message. You can also get the details of the users who received your message.
#### 4. Python script to send bulk messages on Telegram
Another way to send bulk messages on Telegram is via custom Python scripts. [Here’s one from GitHub](https://github.com/inforkgodara/telegram-automated-bulk-messages), which uses the Telegram Desktop app to send messages. For this script to work, you’ll need an Excel sheet with all the Telegram usernames to send your message.
Once set up, you just log into Telegram Desktop and run the script. The script reads the data from the Excel sheet and sends the configured message to all the users one by one.
#### 5. Chrome extension to send bulk Telegram messages
[BulkTele](https://chrome.google.com/webstore/detail/bulktele-mass-invite-%20-me/lkabifackfijfdhlemldnjmipmgcacno) Chrome extension is among the easiest ways to send bulk messages to Telegram group members. You can scrape member usernames from a Telegram group and easily send them your marketing message.
It can also help extract usernames from competitor groups, and mass invite them to your own group. It is the ideal extension for those looking to grow using Telegram marketing.
#### 6. Telegram bulk message auto forwarder
[Auto forwarder Telegram bot](https://sktechhub.com/auto-forward) is an alternative to send messages to multiple Telegram users. The bot can be mighty beneficial for those who need to run deals or automate their Telegram marketing.
It takes messages from groups, channels or individual users and forwards them to the selected Telegram users. It can also translate messages and customise them before forwarding them.
A little something to keep in mind
Use Telegram bulk messaging sensibly to build a respectful and warm relationship with your customers. You can communicate about new launches or new offers using it. However, try to refrain from sending anything that might be considered spam. Sending spam messages would affect your reputation and harm your business.
### Wrapping it up
Telegram bulk messaging is an affordable and efficient way to reach out to your target market. It’s among the easiest way to promote your products and services. You can extract user details and send bulk messages to Telegram group members quickly using the custom tools.
# Welcome
Welcome to the GitBook starter template! Here you'll get an overview of all the amazing features GitBook offers to help you build beautiful, interactive documentation.
You'll see some of the best parts of GitBook in action — and find help on how you can turn this template into your own.
### Jump right in
# Quickstart
Beautiful documentation starts with the content you create — and GitBook makes it easy to get started with any pre-existing content.
{% hint style="info" %}
Want to learn about writing content from scratch? Head to the [Basics](/news/basics/editor) section to learn more.
{% endhint %}
### Import
GitBook supports importing content from many popular writing tools and formats. If your content already exists, you can upload a file or group of files to be imported.
### Sync a repository
GitBook also allows you to set up a bi-directional sync with an existing repository on GitHub or GitLab. Setting up Git Sync allows you and your team to write content in GitBook or in code, and never have to worry about your content becoming out of sync.
# Publish your docs
Once you’ve finished writing, editing, or importing your content, you can publish your work to the web as a docs site. Once published, your site will be accessible online only to your selected audience.
You can publish your site and find related settings from your docs site's homepage.
# Editor
GitBook has a powerful block-based editor that allows you to seamlessly create, update, and enhance your content.
### Writing content
GitBook offers a range of block types for you to add to your content inline — from simple text and tables, to code blocks and more. These elements will make your pages more useful to readers, and offer extra information and context.
Either start typing below, or press `/` to see a list of the blocks you can insert into your page.
### Add a new block
{% stepper %}
{% step %}
#### Open the insert block menu
Press `/` on your keyboard to open the insert block menu.
{% endstep %}
{% step %}
#### Search for the block you need
Try searching for “Stepper”, for exampe, to insert the stepper block.
{% endstep %}
{% step %}
#### Insert and edit your block
Click or press Enter to insert your block. From here, you’ll be able to edit it as needed.
{% endstep %}
{% endstepper %}
# Markdown
GitBook supports many different types of content, and is backed by Markdown — meaning you can copy and paste any existing Markdown files directly into the editor!
Feel free to test it out and copy the Markdown below by hovering over the code block in the upper right, and pasting into a new line underneath.
```markdown
# Heading
This is some paragraph text, with a [link](https://docs.gitbook.com) to our docs.
## Heading 2
- Point 1
- Point 2
- Point 3
```
{% hint style="info" %}
If you have multiple files, GitBook makes it easy to import full repositories too — allowing you to keep your GitBook content in sync.
{% endhint %}
# Images & media
GitBook allows you to add images and media easily to your docs. Simply drag a file into the editor, or use the file manager in the upper right corner to upload multiple images at once.
Add alt text and captions to your images
{% hint style="info" %}
You can also add images simply by copying and pasting them directly into the editor — and GitBook will automatically add it to your file manager.
{% endhint %}
# Interactive blocks
In addition to the default Markdown you can write, GitBook has a number of out-of-the-box interactive blocks you can use. You can find interactive blocks by pressing `/` from within the editor.
### Tabs
{% tabs %}
{% tab title="First tab" %}
Each tab is like a mini page — it can contain multiple other blocks, of any type. So you can add code blocks, images, integration blocks and more to individual tabs in the same tab block.
{% endtab %}
{% tab title="Second tab" %}
Add images, embedded content, code blocks, and more.
```javascript
const handleFetchEvent = async (request, context) => {
return new Response({message: "Hello World"});
};
```
{% endtab %}
{% endtabs %}
### Expandable sections
Click me to expand
Expandable blocks are helpful in condensing what could otherwise be a lengthy paragraph. They are also great in step-by-step guides and FAQs.
### Embedded content
{% embed url="" %}
{% hint style="info" %}
GitBook supports thousands of embedded websites out-of-the-box, simply by pasting their links. Feel free to check out which ones[ are supported natively](https://iframely.com).
{% endhint %}
# Integrations
GitBook integrations allow you to connect your GitBook spaces to some of your favorite platforms and services. You can install integrations into your GitBook page from the *Integrations* menu in the top left.
### Types of integrations
