# ChatGPT Plugin

The Tomba ChatGPT Plugin allows you to access Tomba's powerful email-finding features directly within ChatGPT using OpenAI's plugin interface.

---

## Files Overview

| File                         | Description                                           |
| ---------------------------- | ----------------------------------------------------- |
| `.well-known/ai-plugin.json` | Manifest describing the plugin to OpenAI.             |
| `openapi.yml`                | OpenAPI 3.0 specification of all available endpoints. |
| `logo.png`                   | Branding used for the plugin in the ChatGPT UI.       |

---

## How It Works

Once installed in ChatGPT, the plugin enables natural language access to Tomba's APIs, such as:

- Finding emails by domain or name
- Verifying email addresses
- Discovering authors of articles
- Getting company details

---

## Installation

To use the Tomba ChatGPT Plugin:

1. Go to ChatGPT > Plugins > Plugin Store.
2. Search for **Tomba**.
3. Click **Install**.
4. Authenticate using your Tomba API credentials.

---

## API Capabilities

The plugin uses the endpoints defined in `openapi.yml`. These include:

- `/finder`
- `/search`
- `/verify`
- `/enrich`
- `/author`
- `/linkedin`

Each endpoint is documented with request/response schemas and authorization headers.

---

---

## Example Use in ChatGPT

> **Prompt:**  
> _"Find a professional email for Matt Mullenweg at tomba.io using Tomba plugin."_

> **Response from Plugin:**  
> _"The most likely email address for Matt Mullenweg at tomba.io is m@wordpress.org"_

---

## Plugin Manifest (`ai-plugin.json`)

```json
{
  "schema_version": "v1",
  "name_for_human": "Tomba",
  "name_for_model": "tomba_integration",
  "description_for_human": "Tomba Enrichment, search or verify email addresses in seconds.",
  "description_for_model": "Tomba Enrichment, search or verify email addresses in seconds. Always display results using markdown tables",
  "auth": {
    "type": "none"
  },
  "api": {
    "type": "openapi",
    "url": "https://yourdomain.com/openapi.yaml"
  },
  "logo_url": "https://yourdomain.com/logo.png",
  "contact_email": "support@yourdomain.com",
  "legal_info_url": "https://yourdomain.com/terms-of-service"
}
```
