PayWeavePayWeaveBack to Home
Discovery

AI Plugin

PayWeave serves an ai-plugin.json manifest at the well-known path. This file follows the OpenAI plugin discovery schema (schema version v1) and allows any compatible agent or tool to automatically register PayWeave as a plugin without manual configuration.

URLs

ScopeURL
Global/.well-known/ai-plugin.json
Workspace-scoped/:workspaceId/.well-known/ai-plugin.json

The workspace-scoped variant scopes the plugin to a single workspace. The name_for_human and description_for_model fields reflect the workspace name when a valid workspaceId UUID is provided. Returns 404 if the workspace does not exist.

Global manifest example

GET/.well-known/ai-plugin.json
JSON
{
  "schema_version": "v1",
  "name_for_human": "PayWeave",
  "name_for_model": "payweave",
  "description_for_human": "Payment-enabled platform for monetizing APIs, functions, and file downloads with micropayments. Supports referral rewards via ?ref=WALLET_ADDRESS.",
  "description_for_model": "PayWeave is a payment-enabled platform. Use it to discover and invoke paid API endpoints, serverless functions, and file downloads. Each skill has endpoints with per-call pricing in USD, paid via the Machine Payment Protocol (MPP).",
  "auth": {
    "type": "none"
  },
  "api": {
    "type": "openapi",
    "url": "https://api.payweave.dev/api/discovery/skills"
  },
  "contact_email": "[email protected]",
  "legal_info_url": "https://payweave.dev/legal"
}

Workspace manifest example

GET/:workspaceId/.well-known/ai-plugin.json
JSON
{
  "schema_version": "v1",
  "name_for_human": "Acme AI Labs on PayWeave",
  "name_for_model": "payweave",
  "description_for_human": "Payment-enabled platform for monetizing APIs, functions, and file downloads with micropayments. Supports referral rewards via ?ref=WALLET_ADDRESS.",
  "description_for_model": "PayWeave workspace \"Acme AI Labs\" — discover and invoke paid API endpoints, serverless functions, and file downloads. Each skill has endpoints with per-call pricing in USD, paid via the Machine Payment Protocol (MPP).",
  "auth": {
    "type": "none"
  },
  "api": {
    "type": "openapi",
    "url": "https://api.payweave.dev/api/discovery/<workspaceId>/skills"
  },
  "contact_email": "[email protected]",
  "legal_info_url": "https://payweave.dev/legal"
}

Field reference

FieldDescription
schema_versionAlways "v1".
name_for_humanDisplay name shown to the user. Includes workspace name when scoped.
name_for_modelAlways "payweave". Used by the model to reference this plugin.
description_for_humanShort description shown in plugin marketplaces and UIs.
description_for_modelDetailed instructions for the model. Describes scope and payment method.
auth.typeAlways "none". No API key or OAuth is required for discovery.
api.typeAlways "openapi".
api.urlPoints to the Skills API. Workspace-scoped when workspaceId is provided.
contact_emailSupport contact for the plugin.
legal_info_urlURL to the PayWeave terms of service.
The api.url field points to the Skills API REST endpoint, not an OpenAPI spec file. Agents that fetch this URL will receive the full SkillSet JSON response described in the Skills API section.

Caching

The manifest is cached for ten minutes (600-second TTL). Changes to your workspace name may take up to ten minutes to appear in the manifest.