Documentation

How to Use Qexur

Two types of users, one unified protocol. Pick your path below.

AI DevelopersWebsite Owners

For AI Developers

Build AI agents that act on listed websites.

Instead of writing 100 different integrations, use one Qexur API key to let your AI interact with every website on the Qexur network.

01

Sign Up & Get Your API Key

Create a free Qexur account and select AI Developer as your role. Go to your dashboard and click Generate Key. You'll get a key like qex_292f86...

Create free account →
02

Fetch Available Tools for a Website

Query the /api/v1/tools endpoint with a target site ID to get a list of available actions. The response is a pre-formatted OpenAI-compatible tool definition — drop it straight into GPT-4 function calling.

GET /api/v1/tools
curl https://qexur.me/api/v1/tools?site_id=YOUR_SITE_ID \
  -H "Authorization: Bearer qex_your_key"
03

Execute an Action

When your AI decides to take an action (e.g., buy a product), send a POST to /api/v1/execute. Qexur validates, signs, and proxies the request to the target website securely in milliseconds.

POST /api/v1/executeLIVE
curl -X POST https://qexur.me/api/v1/execute \
  -H "Authorization: Bearer qex_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "target_site_id": "site-uuid-here",
    "action_name":    "create_order",
    "parameters":     { "product_id": "prod_xyz", "quantity": 2 }
  }'
04

Debug with Audit Logs

Every request is stored in your dashboard with the exact payload sent, the website's response, and any errors. Debug your AI agent workflows without guesswork — click View Payload on any log entry.

For Website Owners

Become AI-ready in minutes.

Register your website on Qexur and instantly open your platform to millions of AI agents worldwide — for free. You even earn a revenue share on every AI-driven transaction.

01

Sign Up & Register Your Website

Create a free account and select Website Owner. In your dashboard, click Add Website and enter your site name and your webhook URL.

02

Connect Your Website — Choose Your Method

Option A

Custom Coded Sites (Next.js / Node.js / Python)

Install the @qexur/sdk npm package or run npx @qexur/sdk init for automatic setup. It handles signature verification, routing, and response formatting — zero boilerplate.

Terminal
npm install @qexur/sdk
💡

Where does the secret go?

The QEXUR_WEBHOOK_SECRET goes into your own website's .env file. As a website owner, you host this secret on your servers. Qexur never asks you to submit your database credentials.

app/api/qexur/route.ts — wrap your existing functions
import { Qexur } from '@qexur/sdk';

// Just pass your existing backend functions — SDK does the rest!
export const POST = Qexur.createReceiver(
  { webhookSecret: process.env.QEXUR_WEBHOOK_SECRET! },
  {
    "get_products": async (params) => {
      return db.products.findAll(params);
    },
    "create_order": async (params) => {
      return db.orders.create(params);
    },
  }
);

// SDK automatically:
// ✅ Verifies the X-Qexur-Signature header
// ✅ Routes to the correct action function
// ✅ Returns response in Qexur-compatible format

After deploying, enter this file's URL as your Webhook URL in the Qexur dashboard.

Option B

Shopify / WooCommerce — No-Code Plugin

No terminal. No code. Just install the Qexur AI Gatewayplugin from your store's app marketplace and connect your account in one click.

Shopify Plugin

Coming Soon

WooCommerce Plugin

Available (Download ZIP)

Option C

Using Cursor, Copilot or "Vibe Coding"?

Building your site with an autonomous AI agent? Just copy this prompt and give it to your AI:

"Hey AI, I am integrating the Qexur API Gateway into this project so other AI agents can access its features. Please use the terminal to run `npm install @qexur/sdk` and then run `npx @qexur/sdk init`. Once the webhook file is generated, read it and fill in the business logic for these specific features using my existing database schema: 1. [Feature 1: e.g., Get Latest News] 2. [Feature 2: e.g., Read Premium Article] 3. [List other features here...] Give each feature a clear action_name. Do not change the Qexur signature verification. Finally: 1. Tell me the exact webhook URL I need to paste into my Qexur dashboard. 2. Generate a `qexur-schema.json` file containing the OpenAPI schema for these actions so I can upload it to the Qexur Dashboard."

03

Define Your Schema (1-Click Auto-Generate)

Tell Qexur what actions AI agents can take. Paste your existing OpenAPI / Swagger URL — our engine auto-generates the schema for you instantly. Or use the visual editor.

No manual JSON needed — paste your Swagger URL and done.
04

Monitor Revenue from AI Traffic

Check your Owner Dashboard to see a live audit log of every AI request. Revenue generated by AI agents is tracked and broken down per action. You receive a commission on every successful transaction — a completely new revenue stream on top of your existing business.

Ready to start?

Free to join. No credit card required. Start with 1,000 free credits.

Create Free Account