Metadata-Version: 2.4
Name: awp
Version: 0.2.0
Summary: AWP Agentic Web Protocol
Project-URL: Homepage, https://github.com/blueraai/agentic-web-protocol
Project-URL: Bug Tracker, https://github.com/blueraai/agentic-web-protocol/issues
Author-email: "Bluera Inc." <bluera@bluera.ai>
License: Copyright 2025 Bluera Inc. | All rights reserved.
        
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: <3.13,>=3.10
Provides-Extra: community
Requires-Dist: accelerate; extra == 'community'
Requires-Dist: huggingface-hub; extra == 'community'
Requires-Dist: llama-cpp-python; extra == 'community'
Requires-Dist: protobuf; extra == 'community'
Requires-Dist: psutil; extra == 'community'
Requires-Dist: torch; extra == 'community'
Requires-Dist: transformers; extra == 'community'
Provides-Extra: cuda
Requires-Dist: accelerate; extra == 'cuda'
Requires-Dist: auto-gptq; extra == 'cuda'
Requires-Dist: autoawq; extra == 'cuda'
Requires-Dist: bitsandbytes; extra == 'cuda'
Requires-Dist: llama-cpp-python; extra == 'cuda'
Requires-Dist: optimum; extra == 'cuda'
Provides-Extra: dev
Requires-Dist: black>=24.2.0; extra == 'dev'
Requires-Dist: isort>=5.13.2; extra == 'dev'
Requires-Dist: ruff>=0.3.0; extra == 'dev'
Provides-Extra: mcp
Requires-Dist: mcp; extra == 'mcp'
Provides-Extra: mps
Requires-Dist: mlx; extra == 'mps'
Requires-Dist: mlx-lm; extra == 'mps'
Description-Content-Type: text/markdown

![awp-banner](https://fasplnlepuuumfjocrsu.supabase.co/storage/v1/object/public/web-assets//awp-banner-rsmrx.png)

<p align="center">
    <a href="https://github.com/blueraai/agentic-web-protocol/releases"><img alt="GitHub Release" src="https://img.shields.io/github/release/blueraai/agentic-web-protocol.svg?color=1c4afe"></a>
    <a href="https://github.com/blueraai/agentic-web-protocol/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/blueraai/agentic-web-protocol.svg?color=00bf48"></a>
    <a href="https://discord.gg/7g9SrEc5yT"><img alt="Discord" src="https://img.shields.io/badge/Join-Discord-7289DA?logo=discord&logoColor=white&color=4911ff"></a>
</p>

> ![lng_icon](https://fasplnlepuuumfjocrsu.supabase.co/storage/v1/object/public/web-assets//icons8-python-16.png) This page aims to document **Python** protocols and usage (e.g. cloud, desktop).
>
> Looking for [**Javascript/Typescript instructions**](https://github.com/blueraai/agentic-web-protocol/blob/main/README_WEB.md)?

## Overview

The `Agentic Web Protocol`, or `AWP`, *allows **AI agents** to reliably **understand and interact with the web***.

It is composed of two protocols, for web pages and APIs, allowing them to be usable by AI agents.

A standard [Universal Tool](https://github.com/blueraai/universal-intelligence) is also provided, for AI agents to be able to instantly leverage `AWP` compliant pages and APIs.

> 🤖 Discoverable Websites and APIs, for AI Agents interactions. [Bluera Inc.](https://bluera.ai)

## Get Started

Learn more about how to support `AWP`, by clicking the most appropriate option for you:
<details>
<summary><strong style="display: inline; cursor: pointer; margin: 0; padding: 0;">I make websites or APIs, what do I need to do?</strong></summary>

##### Websites

- See the `AWP` *Protocol Specifications* below, and familiarize yourself with the standard `ai` parameters
- Add the appropriate `ai` parameters to your website.

> 🎉 Your website can be reliably used by any AI agent!

##### APIs

- See the `AWP` *Protocol Specifications* below, and familiarize yourself with the standard `/ai-handshake` endpoint
- Add the standard `/ai-handshake` endpoint to your API.

> 🎉 Your API can be reliably used by any AI agent!

</details>

<details>
<summary><strong style="display: inline; cursor: pointer; margin: 0; padding: 0;">I make/use AI Agents, what do I need to do?</strong></summary>
<br>

- See the `AWP` *Tool* below, and familiarize yourself with its `parse_html` and `parse_api` methods.
- Add the `AWP` *Tool* to your AI Agent.

> 🎉 Your AI agent can now reliably use any `AWP` compliant websites or APIs!

</details>

## Documentation

<details>
<summary><strong style="display: inline; cursor: pointer; margin: 0; padding: 0;">Protocol Specifications</strong></summary>

## Protocol Specifications

### Web pages

#### Introduction

> ##### The Challenge of Web Interactivity for AI Agents
> 
> Without information about what a web page is for, how it is structured, what features it provides, and how to interact with it, an AI agent has to figure out everything on its own.
>
> This is commonly done through scrappers and/or vision models aimed at guessing what the agent sees.
>
> Websites being diverse, complex, dynamic, Javascript-heavy and often moslty made of generic `<div>`s, this exercise often leads to unreliable parsing and broken/unintended interactions.
>
> Intelligent agents need richer semantic hints to parse and interact with these pages reliably.

The premise of `AWP` is simple: **include standard information in the HTML page** itself, for **any agent to be able to reliably understand and interact** with it.

For an agent to so, the following information needs to be attached to *meaninful* and/or *interactive* HTML tags:

1. A `description`, for it to know what it is.
2. A list of possible `interactions`, for it to know what to do.
3. A list of `prerequisites`, for it to know what to do prior to interacting.
4. A list of subsequent `features`, for it to know what those interactions lead to.

Additional optional information such as `states`, or established *accessibility* parameters (eg. `role`, `aria-*`) may also be used to complement the agent's understanding of the page.

#### Contract

Let's start with a simple example. Your agent just found this website by crawling the web:

```html
<html>
  <body>
    <form>
      This site uses cookies
      <button>Configure</button>
    </form>
    <form>
      <h1> Website name </h1>
      <label> What's next? </label>
      <input
        type="text"
        name="destination"
        required
        minlength="3"
        maxlength="30"/>
      <div>
        <button disabled> -> </button>
        <button> Back </button>
      </div>
    </form>
  </body>
</html>
```

It now needs to *understand what it is for*, to know if it can be used to answer your query, and if so, *how to interact* with it?

With `AWP`, this information is now declared in the HTML itself, through standard ***optional*** `ai-*` parameters.

Here is a simple example:

```html
<html ai-description="Travel site to book flights and trains">
  <body>
    <form>
      This site uses cookies
      <button>Configure</button>
    </form>
    <form ai-description="Form to book a flight">
      <h1>
        Website name
      </h1>
      <label>
        What's next?
      </label>
      <input
        ai-ref="<input-ai-ref>"
        ai-description="Form input where to enter the destination"
        ai-interactions="input: enables the form confirmation button, given certain constraints;"
        type="text"
        name="destination"
        required
        minlength="3"
        maxlength="30"/>
      <div>
        <button
          ai-description="Confirmation button to proceed with booking a flight"
          ai-interactions="click: proceed; hover: diplay additonal information about possible flights;"
          ai-prerequisite-click="<input-ai-ref>: input destination;"
          ai-next-click="list of available flights; book a flight; login;"
          disabled>
          ->
        </button>
        <button
          ai-description="Cancel button to get back to the home page"
          ai-interactions="click: dismiss form and return to home page;"
          ai-next-click="access forms to book trains; access forms to book flights;">
          Back
        </button>
      </div>
    </form>
  </body>
</html>
```

##### Standard Parameters

| Parameter | Description | Requirement |
|--------|-------------|----------|
| `ai-description` | A natural language description for agents to know what the element is | • Meaningful Element: `required`<br>• Interactive Element: `required`<br>• Other Element: `absent` |
| `ai-interactions` | A list of possible interactions, for agents to know what to do with the element<br><br>Format:<br><br>`<interaction>: <behavior>; <interaction>: <behavior>;..` | • Meaningful Element: `absent`<br>• Interactive Element: `required`<br>• Other Element: `absent` |
| `ai-prerequisite-<interaction>` | A list of prerequisite interactions, for agents to know what to do prior to interacting with the element<br><br>Format:<br><br>`<ai-ref>: <interaction>;..` | • Meaningful Element: `absent`<br>• Interactive Element: `optional`<br>• Other Element: `absent` |
| `ai-ref` | A unique identifier for agents to know where those prerequisite interactions should be made | • Meaningful Element: `absent`<br>• Interactive Element: `optional`<br>• Other Element: `absent` |
| `ai-next-<interaction>` | A list of subsequent features, for agents to know what those interactions lead to<br><br>Format:<br><br>`<next feature>; <next feature>;..` | • Meaningful Element: `absent`<br>• Interactive Element: `optional`<br>• Other Element: `absent` |
| `ai-state` | A natural language description of the state the component is in | • Meaningful Element: `optional`<br>• Interactive Element: `optional`<br>• Other Element: `optional` |

> An **AWP Tool** is also distributed by this library to allow any AI agent to reliably use `AWP` compliant websites.

### APIs

Without information about what an API is for, how it is structured, what features it provides, and how to interact with it, an AI agent has to figure out everything on its own. This is commonly passed manually as context, fetched via web crawlers attempting to find documentation online, or by spinning up additional middleware servers (eg. [mcp](https://github.com/modelcontextprotocol)) to allow them to be discoverable.

The premise of `AWP` is simple: **include standard information in the API** itself, for **any agent to be able to reliably understand and interact** with it, without requiring additional middleware servers to do so.

For an agent to know how to use any API, the following information needs to be discoverable:

1. A list of all each available `endpoints` on that API, to know what they are
2. A `description` for each endpoint, to know what they are for
3. `meta` information for each endpoint, to know how to access them
4. An `input` documentation for each endpoint, to know what to provide
5. An `output` documentation for each endpoint, to know what to expect

#### Contract

With `AWP`, the API documentation is made accessible on the API itself, with a standard `/ai-handshake` endpoint.

This allows AI agents to query `/ai-handshake`, get a complete description of the API, and know how to further interact with it.

For simplicity, and since it is a well established standard on the web, the `AWP` expects a [OpenAPI](https://swagger.io/specification/) compliant documentation to be returned by that endpoint.

Here is a simple example:
[https://editor.swagger.io](https://editor.swagger.io)

##### Standard Endpoint

| Path | Description | Type | Method | Input | Output | Requirement |
|--------|--------------------------------|----------|----------|----------|----------|----------|
| `/ai-handshake` | Standard endpoint returning a [OpenAPI](https://swagger.io/specification/) compliant documentation of the API which hosts the endpoint, excluding `/ai-handshake`, JSON or YAML based on headers | REST | GET | Headers:<br><br>`"Content-Type": "application/yaml"`(recommended)<br>or<br>`"Content-Type": "application/json"` | [OpenAPI](https://swagger.io/specification/) compliant documentation, of requested `Content-Type` (eg. YAML, JSON, text) | `required` |

> An AWP Tool is also distributed by this library to allow any AI agent to reliably use `AWP` compliant API.

</details>

<details>
<summary><strong style="display: inline; cursor: pointer; margin: 0; padding: 0;">AWP Tool</strong></summary>

## AWP Tool

This project also shares a [Universal Tool](https://github.com/blueraai/universal-intelligence) for your agents to be able **reliably understand and interact with the AWP compliant Web pages and APIs**.

> For more information about `Universal Tools`, see [◉ Universal Intelligence](https://github.com/blueraai/universal-intelligence)

### Installation

```bash
pip install awp

# (if using universal tool) Choose relevant UIN install for your device
pip install "universal-intelligence[community,mps]" # Apple
pip install "universal-intelligence[community,cuda]" # NVIDIA
```

### Usage

#### Standard

```python
import awp

# Get HTML documentation
html_doc = awp.parse_html(html)

# Get API documentation
api_doc = awp.parse_api(url)
```

| Method | Parameters | Return Type | Description |
|--------|------------|-------------|-------------|
| `parse_html` | • `html: str`: HTML page to parse<br>• `format: str \| None = "YAML"`: Output format | `Any` | Parses all AWP `ai-*` parameters on the page and returns a documentation in the requested format (YAML, JSON), usable by any AI agent to reliably understand and interact with that web page |
| `parse_api` | • `url: str`: URL of the API to parse<br>• `authorization: str \| None = None`: Authentication header if required<br>• `format: str \| None = "YAML"`: Output format | `Any` | Calls the standard `/ai-handshake` endpoint of that API and returns an [OpenAPI](https://swagger.io/specification/) compliant documentation of that API in the requested format (YAML, JSON), usable by any AI agent to reliably understand and interact with that API |

#### As [Universal Tool](https://github.com/blueraai/universal-intelligence)

```python
from awp import UniversalTool as AWP

# Get HTML documentation
html_doc, logs = AWP().parse_html(html)

# Get API documentation
api_doc, logs = AWP().parse_api(url)
```

| Method | Parameters | Return Type | Description |
|--------|------------|-------------|-------------|
| `__init__` | • `verbose: bool \| str = "DEFAULT"`: Enable/Disable logs, or set a specific log level | `None` | Initialize a Universal Tool |
| `parse_html` | • `html: str`: HTML page to parse<br>• `format: str \| None = "YAML"`: Output format | `Tuple[Any, Dict]` | Parses all AWP `ai-*` parameters on the page and returns a documentation in the requested format (YAML, JSON), usable by any AI agent to reliably understand and interact with that web page |
| `parse_api` | • `url: str`: URL of the API to parse<br>• `authorization: str \| None = None`: Authentication header if required<br>• `format: str \| None = "YAML"`: Output format | `Tuple[Any, Dict]` | Calls the standard `/ai-handshake` endpoint of that API and returns an [OpenAPI](https://swagger.io/specification/) compliant documentation of that API in the requested format (YAML, JSON), usable by any AI agent to reliably understand and interact with that API |
| `(class).contract` | None | `Contract` | Tool description and interface specification |
| `(class).requirements` | None | `List[Requirement]` | Tool configuration requirements |

#### Example Output

##### Parse HTML

###### Input

```html
<html ai-description="Travel site to book flights and trains">
  <body>
    <form 
      ai-description="Form to book a flight" 
      ai-state="pending"
      class="form-booking-flight">
      <h1>
        Book a flight
      </h1>
      <label>
        Where to?
      </label>
      <input
        ai-ref="<input-ai-ref>"
        ai-description="Form input where to enter the destination"
        ai-interactions="input: enables the form confirmation button, given certain constraints;"
        role="destination-input"
        aria-required="true"
        alt="destination input"
        type="text"
        id="destination"
        name="destination"
        required
        minlength="3"
        maxlength="30"
        size="10" />
      <div>
        <button
          ai-description="Confirmation button to proceed with booking a flight"
          ai-interactions="click: proceed; hover: diplay additonal information about possible flights;"
          ai-prerequisite-click="<input-ai-ref>: input destination;"
          ai-next-click="list of available flights; book a flight; login;"
          aria-disabled="true"
          disabled>
          See available flights
        </button>
        <button
          ai-description="Cancel button to get back to the home page"
          ai-interactions="click: dismiss form and return to home page;"
          ai-next-click="access forms to book trains; access forms to book flights;">
          Back
        </button>
      </div>
    </form>
  </body>
</html>
```

###### Output

```yaml
elements:
- selector: html
  description: Travel site to book flights and trains
  contains:
  - selector: html body form.form-booking-flight
    description: Form to book a flight
    state: pending
    content: Book a flight Where to?
    contains:
    - selector: html body form.form-booking-flight input#destination[name='destination'][type='text'][role='destination-input']
      description: Form input where to enter the destination
      available_interactions:
      - type: input
        description: enables the form confirmation button, given certain constraints
      attributes:
        name: destination
        role: destination-input
        alt: destination input
        aria-required: 'true'
        maxlength: 30
        minlength: 3
        required: true
        type: text
    - selector: html body form.form-booking-flight div button
      description: Confirmation button to proceed with booking a flight
      content: See available flights
      available_interactions:
      - type: click
        description: proceed
        prerequisites:
        - selector: html body form.form-booking-flight input#destination[name='destination'][type='text'][role='destination-input']
          interaction: input destination
        next_features:
        - list of available flights
        - book a flight
        - login
      - type: hover
        description: diplay additonal information about possible flights
      attributes:
        aria-disabled: 'true'
    - selector: html body form.form-booking-flight div button:nth-of-type(2)
      description: Cancel button to get back to the home page
      content: Back
      available_interactions:
      - type: click
        description: dismiss form and return to home page
        next_features:
        - access forms to book trains
        - access forms to book flights
```

> YAML (default) or JSON per requested format. 
> 
> YAML recommended for improved token efficiency and stability.

##### Parse API

###### Input

`GET https//example.api.com/ai-handshake`

###### Output

[OpenAPI](https://swagger.io/specification/) compliant documentation, YAML (default) or JSON per requested format.

Example available [here](https://editor.swagger.io).

> **Tip**: Tools like [Swagger](https://swagger.io) can automatically generate a [OpenAPI](https://swagger.io/specification/) compliant documentation for your API which you may serve at `/ai-handshake`. They usually also provide no-code UIs to display and interact wich that documentation on the web (eg. [Swagger UI](https://editor.swagger.io)).

#### Playground

A ready-made playground is available to help familiarize yourself with the AWP protocols and tools.

```sh
# Install project dependencies
pip install -r requirements.txt 
# Choose relevant UIN install for your device
pip install "universal-intelligence[community,mps]" # Apple
pip install "universal-intelligence[community,cuda]" # NVIDIA

# Run
python -m playground.example 
```

### Cross-Platform Support

![lng_icon](https://fasplnlepuuumfjocrsu.supabase.co/storage/v1/object/public/web-assets//icons8-python-16.png) ![lng_icon](https://fasplnlepuuumfjocrsu.supabase.co/storage/v1/object/public/web-assets//icons8-javascript-16.png) The `AWP` tool can be used across **all platforms** (cloud, desktop, web, mobile).

- ![lng_icon](https://fasplnlepuuumfjocrsu.supabase.co/storage/v1/object/public/web-assets//icons8-python-16.png) [How to use natively with `python` (cloud, desktop)](https://github.com/blueraai/agentic-web-protocol/blob/main/README.md)
- ![lng_icon](https://fasplnlepuuumfjocrsu.supabase.co/storage/v1/object/public/web-assets//icons8-javascript-16.png) [How to use on the web, or in web-native apps, with `javascript/typescript` (cloud, desktop, web, mobile)](https://github.com/blueraai/agentic-web-protocol/blob/main/README_WEB.md)

</details>

## Support

This software is open source, free for everyone, and lives on thanks to the community's support ☕

If you'd like to support to `agentic-web-protocol` here are a few ways to do so:

- ⭐ Consider leaving a star on this repository to support our team & help with visibility
- 👽 Tell your friends and collegues
- 📰 Support this project on social medias (e.g. LinkedIn, Youtube, Medium, Reddit)
- ✅ Adopt the `AWP` specification
- 💪 Use the [AWP Tool](https://pypi.org/project/agentic-web-protocol/)
- 💡 Help surfacing/resolving issues
- 💭 Help shape the `AWP` specification
- 🔧 Help maintain, test, enhance the [AWP Tool](https://github.com/blueraai/agentic-web-protocol/blob/main/awp/)
- ✉️ Email us security concerns
- ❤️ Sponsor this project on Github
- 🤝 [Partner with Bluera](mailto:contact@bluera.ai)


## License

Apache 2.0 License - [Bluera Inc.](https://bluera.ai)