> ## Documentation Index
> Fetch the complete documentation index at: https://developers.partoo.co/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAPI file

> View or download the Partoo REST API OpenAPI specification file in YAML format.

## Access the OpenAPI Specification

The OpenAPI specification defines all endpoints, parameters, request/response schemas, and authentication methods for the Partoo REST API.

You can <a href="https://developers.partoo.co/assets/openapi/openapi-bundled.yaml">view the specification in an API tool</a> or download it for offline use. Here's how:

* **Download the complete YAML file**
* **Import it into an OpenAPI-compatible tool** (Postman, Insomnia, Swagger UI, etc.)
* **Use it to automatically generate an API client (SDK)**

***

## Download the OpenAPI File (YAML)

Download the full bundled OpenAPI specification:

<a
  href="/assets/openapi/openapi-bundled.yaml"
  download="openapi.yaml"
  style={{
display: "inline-flex",
alignItems: "center",
gap: "8px",
padding: "10px 20px",
backgroundColor: "#0266F1",
color: "white",
borderRadius: "8px",
textDecoration: "none",
fontWeight: "500",
}}
>
  Download OpenAPI Specification (YAML)
</a>

<Info>
  The file downloads as a `.yaml` document and is ready to use in compatible API tools.
</Info>

***

## View the Specification in an API Tool

After downloading the file, you can import it into your preferred API tool.

### Example: Import into Postman

<Steps>
  <Step title="Open Postman">
    Launch the Postman application.
  </Step>

  <Step title="Import the file">
    Click **Import**, then select the `openapi-bundled.yaml` file.
  </Step>

  <Step title="Generate the collection">
    Postman automatically creates a collection containing all available API endpoints.

    <Info>
      You can see all API routes listed in your workspace.
    </Info>
  </Step>
</Steps>

***

## Generate an API Client Automatically

You can use the OpenAPI specification to generate a typed SDK client.

### Example with OpenAPI Generator (CLI)

```bash theme={null}
openapi-generator-cli generate \
  -i openapi-bundled.yaml \
  -g typescript-axios \
  -o ./partoo-api-client
```

This command generates a TypeScript client based on the official API definition.

<Tip>
  Always use the latest version of the OpenAPI file to ensure compatibility with recently added or updated endpoints.
</Tip>

***

## Need Help?

If you encounter issues while importing or generating a client:

* Verify that the YAML file is valid
* Ensure your OpenAPI tool supports the specification version
* Check the official documentation of the tool you are using

<Info>
  The OpenAPI specification reflects the current version of the Partoo REST API.
</Info>