|
1 | | -# Project Name |
2 | | -> Short blurb about what your project does. |
| 1 | +# Agentic Product Protocol (APP) |
| 2 | + |
| 3 | +The **Agentic Product Protocol (APP)** is an interaction model and open standard for connecting AI agents and product data providers to enable seamless product discovery and comparison. |
| 4 | + |
| 5 | +The specification is maintained by the community and is currently in `draft`. |
| 6 | + |
| 7 | +- **For retailers & marketplaces** - Make your product catalog discoverable and searchable by AI agents while maintaining control of your inventory and pricing data. |
| 8 | +- **For AI agents** - Enable product discovery and comparison in your application, providing users with comprehensive product information and merchant offers. |
| 9 | +- **For comparison platforms** - Expose your aggregated product data through a standardized interface that AI agents can consume. |
| 10 | + |
| 11 | +Learn more at the [Agentic Product Protocol documentation](#). |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## 📦 Repo Structure |
| 16 | + |
| 17 | +```plaintext |
| 18 | +<repo-root>/ |
| 19 | +├── rfcs/ |
| 20 | +│ └── rfc.*.md |
| 21 | +│ |
| 22 | +├── spec/ |
| 23 | +│ ├── openapi/ |
| 24 | +│ │ └── openapi.*.yaml |
| 25 | +│ │ |
| 26 | +│ └── json-schema/ |
| 27 | +│ └── schema.*.json |
| 28 | +│ |
| 29 | +├── examples/ |
| 30 | +│ └── examples.*.json |
| 31 | +│ |
| 32 | +├── changelog/ |
| 33 | +│ └── *.md |
| 34 | +│ |
| 35 | +├── MAINTAINERS.md |
| 36 | +├── CONTRIBUTING.md |
| 37 | +├── LICENSE |
| 38 | +└── README.md |
| 39 | +``` |
3 | 40 |
|
4 | | -[![Build Status][ci-image]][ci-url] |
5 | | -[![License][license-image]][license-url] |
6 | | -[![Developed at Klarna][klarna-image]][klarna-url] |
| 41 | +--- |
7 | 42 |
|
| 43 | +## 🔗 Quick Links |
8 | 44 |
|
9 | | -One to two paragraph statement about your project and what it does. |
| 45 | +| Spec Type | Latest Version | Description | |
| 46 | +| ------------------ | -------------------------------------- | ------------------------------------------------------------------ | |
| 47 | +| **RFC (Markdown)** | [rfcs/](rfcs/) | Human-readable design doc with rationale, flows, and rollout plan. | |
| 48 | +| **OpenAPI (YAML)** | [spec/openapi/](spec/openapi/) | Machine-readable HTTP API spec for integrating product endpoints. | |
| 49 | +| **JSON Schema** | [spec/json-schema/](spec/json-schema/) | Data models for products, offers, and search results. | |
| 50 | +| **Examples** | [examples/](examples/) | Sample requests, responses. | |
| 51 | +| **Changelog** | [changelog/](changelog/) | API version history and breaking changes. | |
10 | 52 |
|
11 | | -## First steps |
| 53 | +--- |
12 | 54 |
|
13 | | -<details> |
14 | | - <summary>Installation (for Admins)</summary> |
15 | | - |
16 | | - Currently, new repositories can be created only by a Klarna Open Source community lead. Please reach out to us if you need assistance. |
17 | | - |
18 | | - 1. Create a new repository by clicking ‘Use this template’ button. |
19 | | - |
20 | | - 2. Make sure your newly created repository is private. |
21 | | - |
22 | | - 3. Enable Dependabot alerts in your candidate repo settings under Security & analysis. You need to enable ‘Allow GitHub to perform read-only analysis of this repository’ first. |
23 | | -</details> |
| 55 | +## 🛠 Getting Started |
24 | 56 |
|
25 | | -1. Update `README.md` and `CHANGELOG.md`. |
| 57 | +The Agentic Product Protocol provides standardized endpoints for: |
26 | 58 |
|
27 | | -2. Optionally, clone [the default contributing guide](https://github.com/klarna-incubator/.github/blob/main/CONTRIBUTING.md) into `.github/CONTRIBUTING.md`. |
| 59 | +1. **Product Search** - Search and filter products with rich query capabilities |
| 60 | +2. **Product Listing** - Retrieve detailed product information with merchant offers |
| 61 | +3. **Category Discovery** - Browse product hierarchies and categories |
28 | 62 |
|
29 | | -3. Do *not* edit `LICENSE`. |
| 63 | +To start building with APP: |
30 | 64 |
|
31 | | -## Usage example |
| 65 | +1. Review this repo's [OpenAPI specs](spec/openapi/) and [JSON Schemas](spec/json-schema/). |
| 66 | +2. Implement the required endpoints on your product data platform. |
| 67 | +3. Test using the [examples](examples/) provided in this repo. |
| 68 | +4. Register your implementation with AI agent platforms. |
32 | 69 |
|
33 | | -A few motivating and useful examples of how your project can be used. Spice this up with code blocks and potentially more screenshots. |
| 70 | +--- |
34 | 71 |
|
35 | | -_For more examples and usage, please refer to the [Docs](TODO)._ |
| 72 | +## 📚 Documentation |
36 | 73 |
|
37 | | -## Development setup |
| 74 | +| Area | Resource | |
| 75 | +| -------------------- | -------------------------------------------------------------------------------------- | |
| 76 | +| Product Search Spec | [spec/openapi/openapi.product_search.yaml](spec/openapi/openapi.product_search.yaml) | |
| 77 | +| Product Listing Spec | [spec/openapi/openapi.product_listing.yaml](spec/openapi/openapi.product_listing.yaml) | |
38 | 78 |
|
39 | | -Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms. |
| 79 | +--- |
40 | 80 |
|
41 | | -```sh |
42 | | -make install |
43 | | -npm test |
44 | | -``` |
| 81 | +## 📝 Contributing |
| 82 | + |
| 83 | +We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for: |
| 84 | + |
| 85 | +- Branching model |
| 86 | +- Pull request guidelines |
| 87 | +- Spec versioning and review process |
| 88 | + |
| 89 | +All changes must include: |
| 90 | + |
| 91 | +- Updated OpenAPI / JSON Schemas |
| 92 | +- New or updated examples |
| 93 | +- Changelog entry in `changelog/unreleased.md` |
| 94 | + |
| 95 | +--- |
| 96 | + |
| 97 | +## 🎯 Use Cases |
| 98 | + |
| 99 | +### Product Discovery |
| 100 | + |
| 101 | +AI agents can search across your entire product catalog using natural language queries, with support for filtering by price, category, brand, availability, and more. |
| 102 | + |
| 103 | +### Price Comparison |
45 | 104 |
|
46 | | -## How to contribute |
| 105 | +Provide comprehensive merchant offers with pricing, shipping costs, stock status, and delivery times, enabling AI agents to help users find the best deals. |
47 | 106 |
|
48 | | -See our guide on [contributing](.github/CONTRIBUTING.md). |
| 107 | +### Product Information |
49 | 108 |
|
50 | | -## Release History |
| 109 | +Expose detailed product attributes including descriptions, images, ratings, reviews, and technical specifications in a standardized format. |
51 | 110 |
|
52 | | -See our [changelog](CHANGELOG.md). |
| 111 | +--- |
53 | 112 |
|
54 | | -## License |
| 113 | +## 🔒 Security & Privacy |
55 | 114 |
|
56 | | -Copyright © 2022 Klarna Bank AB |
| 115 | +- **Authentication** - All endpoints require Bearer token authentication |
| 116 | +- **Rate Limiting** - Implement appropriate rate limits to prevent abuse |
| 117 | +- **Data Privacy** - Follow applicable data protection regulations (GDPR, CCPA, etc.) |
| 118 | +- **PII Handling** - Minimize collection of personally identifiable information |
57 | 119 |
|
58 | | -For license details, see the [LICENSE](LICENSE) file in the root of this project. |
| 120 | +--- |
59 | 121 |
|
| 122 | +## 📜 License |
60 | 123 |
|
61 | | -<!-- Markdown link & img dfn's --> |
62 | | -[ci-image]: https://img.shields.io/badge/build-passing-brightgreen?style=flat-square |
63 | | -[ci-url]: https://github.com/klarna-incubator/TODO |
64 | | -[license-image]: https://img.shields.io/badge/license-Apache%202-blue?style=flat-square |
65 | | -[license-url]: http://www.apache.org/licenses/LICENSE-2.0 |
66 | | -[klarna-image]: https://img.shields.io/badge/%20-Developed%20at%20Klarna-black?style=flat-square&labelColor=ffb3c7&logo=klarna&logoColor=black |
67 | | -[klarna-url]: https://klarna.github.io |
| 124 | +Licensed under the [Apache 2.0 License](LICENSE). |
0 commit comments