https://github.com/swiftcomplete-public/swiftcomplete-api-docs
GitHub Pages with Swagger UI, llms.txt, llms-full.txt and openapi info
https://github.com/swiftcomplete-public/swiftcomplete-api-docs
address-autocomplete address-verification llms llms-txt openapi openapi-spec swiftcomplete
Last synced: 7 months ago
JSON representation
GitHub Pages with Swagger UI, llms.txt, llms-full.txt and openapi info
- Host: GitHub
- URL: https://github.com/swiftcomplete-public/swiftcomplete-api-docs
- Owner: swiftcomplete-public
- Created: 2025-05-14T12:18:10.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-05-28T15:19:00.000Z (8 months ago)
- Last Synced: 2025-06-08T21:06:41.890Z (8 months ago)
- Topics: address-autocomplete, address-verification, llms, llms-txt, openapi, openapi-spec, swiftcomplete
- Homepage: https://docs.swiftcomplete.com
- Size: 452 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Swiftcomplete API Docs
Welcome to the official documentation repository for the **Swiftcomplete API Docs**. This repository now hosts the OpenAPI specification for the **Address Autocomplete API** as well as resources for integrating with **LLMs (Large Language Models)**.
## 🔍 About
Address Autocomplete offers fast and accurate real-time address autocomplete, what3words search, and postcode lookup, enabling seamless user experiences in web forms and applications. Additionally, this repository includes resources for leveraging Swiftcomplete APIs with LLMs for advanced integrations.
## 🚀 Live Swagger Documentation
Explore the live interactive Swagger UI here:
👉 **[https://docs.swiftcomplete.com/openapi](https://docs.swiftcomplete.com/openapi)**
## 📂 Repository Structure
The repository is organised as follows:
```
docs/
├── assets/
├── openapi/
│ └── index.html
| └── openapi.json
| └── openapi.yaml
├── llms.txt
├── llms-full.txt
├── swiftcomplete.postman_collection.json
└── index.html
```
- **`docs/assets/`**: Contains static assets for the documentation.
- **`docs/openapi/`**: Contains the Swagger UI entry point for the OpenAPI specification.
- **`docs/openapi/index.html`**: The Swagger UI for the OpenAPI spec.
- **`docs/openapi/openapi.json`**: The OpenAPI specification file in JSON.
- **`docs/openapi/openapi.yaml`**: The OpenAPI specification file in YAML.
- **`docs/llms.txt`**: A concise guide or configuration for LLM integration.
- **`docs/llms-full.txt`**: A detailed guide or extended configuration for LLM integration.
- **`docs/index.html`**: The main entry point for the documentation.
- **`swiftcomplete.postman_collection.json`**: Postman Collection of the Swiftcomplete API
## 🌟 Demo and Pricing
- A live demo of the Address Autocomplete API is available at:
👉 **[www.swiftcomplete.com](https://www.swiftcomplete.com)**
- For pricing details, visit:
👉 **[Pricing Page](https://www.swiftcomplete.com/#pricing)**
## 🗂 More Resources
Find all Swiftcomplete public repositories on GitHub:
👉 **[https://github.com/swiftcomplete-public](https://github.com/swiftcomplete-public)**
## 📧 Contact
For support or inquiries, please contact us at:
📩 **[support@swiftcomplete.com](mailto:support@swiftcomplete.com)**
---
© 2025 Swiftcomplete Ltd. All rights reserved.