Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/sorgm/data-architecture-docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Welcome to the Plant Store API

The Plant Store API allows you to manage a collection of plants programmatically. This API demonstrates features of the OpenAPI 3.1.0 specification and provides a complete example of REST API best practices.

​
Base URL

All API requests should be made to: 
http://sandbox.mintlify.com

​
Authentication

All API endpoints require authentication using Bearer tokens. Include your token in the Authorization header of every request: 
curl -H "Authorization: Bearer YOUR_TOKEN" \
  http://sandbox.mintlify.com/plants
The authentication scheme is defined in the OpenAPI specification: 
"security": [
  {
    "bearerAuth": []
  }
]
Keep your API tokens secure and never commit them to version control. Rotate tokens regularly and revoke compromised tokens immediately.

​
Using OpenAPI with Mintlify

This API documentation is built using Mintlify’s OpenAPI integration. The complete API specification is available in the openapi.json file, which Mintlify uses to automatically generate interactive API references.

​
Benefits of OpenAPI Integration

  • Auto-generated documentation - API endpoints, parameters, and responses are automatically documented
  • Interactive playground - Test API calls directly from the documentation
  • Type safety - Request and response schemas are validated against the OpenAPI spec
  • Always up-to-date - Documentation updates automatically when the spec changes

View OpenAPI Specification

Explore the complete OpenAPI 3.1.0 specification file for the Plant Store API

​
Available Endpoints

The Plant Store API provides the following endpoints:

Get Plants

Retrieve all plants with optional filtering and pagination

Create Plant

Add a new plant to the store

Delete Plant

Remove a plant from the store by ID

Plant Webhook

Receive real-time notifications when plants are added

​
Quick Start

​
1. Get Your API Token

Contact your administrator to obtain a Bearer token for API access.

​
2. Make Your First Request

Retrieve all plants from the store: 
curl -H "Authorization: Bearer YOUR_TOKEN" \
  http://sandbox.mintlify.com/plants?limit=10

​
3. Create a Plant

Add a new plant to your collection: 
curl -X POST \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Monstera Deliciosa", "tag": "tropical"}' \
  http://sandbox.mintlify.com/plants

​
Response Format

All API responses are returned in JSON format. Successful responses include the requested data, while errors include an error code and descriptive message.

​
Success Response

{
  "id": 1,
  "name": "Monstera Deliciosa",
  "tag": "tropical"
}

​
Error Response

{
  "error": 400,
  "message": "Invalid request parameters"
}

​
Rate Limiting

API requests are rate-limited to ensure fair usage and system stability. Monitor response headers for rate limit information.

​
Support

If you encounter issues or have questions about the API, please refer to the individual endpoint documentation or contact support.

Build docs developers (and LLMs) love

Get started for freeTalk to us