Developer

InWith API

Submit offers once. We turn them into crawlable, LLM‑ready agent pages that tools can surface.

Quickstart

Base URL

https://inwithai.com/api/v1/

Auth header

X-API-Key: iw_live_…

or Authorization: ApiKey <key>

Endpoints

POST /submit – create / update agent

GET /status/<id> – check status & URL

POST /api/v1/submit

Create or update an agent from your backend. InWith optimizes it and serves it at a crawlable /p/<slug> URL.

  • title (string, required)
  • description (string, required)
  • content_type (string, default: product)
  • category (string, optional)
  • location_zip (string, optional)
  • price (decimal, optional)
  • currency (string, default: USD)
  • external_url (URL, optional)
  • image_urls (array of URLs)
  • merchant_promo_code (string, optional)

Example request:

curl -X POST https://inwithai.com/api/v1/submit \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Summer Coffee Deal",
    "description": "20% off all lattes this week. In-store only.",
    "content_type": "product",
    "category": "Food & Drink",
    "location_zip": "84020",
    "price": "4.99",
    "currency": "USD",
    "external_url": "https://example.com/deals",
    "image_urls": ["https://example.com/latte.jpg"]
  }'

GET /api/v1/status/<id>

Poll for a submission’s status and public URL.

  • id – UUID returned by POST /submit
  • status – pending, processing, published, failed
  • public_url – full URL when published
  • slug – page slug when published
  • error_message – populated if status is failed

Example request:

curl https://inwithai.com/api/v1/status/UUID_HERE \
  -H "X-API-Key: YOUR_API_KEY"
← Back to Get InWith API See full schema in interactive docs →