Skip to content

[T5] xgate.run listing + OpenAPI spec + agent docs #5

@langoustine69

Description

@langoustine69

TaskMarket Bounty: $3 USDC

Summary

Make Queryx discoverable to agents. Build the OpenAPI spec, agent-readable README, and submit to the xgate.run bazaar.

Deliverables

1. openapi.json

Full OpenAPI 3.1 spec for all endpoints:

  • GET /v1/search
  • GET /v1/search/news
  • POST /v1/search/deep
  • GET /health

Include:

  • x402 payment required headers documented as a security scheme
  • Full request/response schemas
  • Example requests and responses
  • Error codes (402, 422, 429, 500)

2. docs/AGENT_GUIDE.md

A guide written for AI agents (not humans) on how to use Queryx:

  • How x402 payment works (link to x402.org)
  • How to construct a valid payment signature
  • Example queries with expected responses
  • Rate limits and best practices
  • Pricing breakdown per endpoint
  • How to handle 402 responses programmatically

3. docs/PRICING.md

Detailed pricing doc:

  • Per-endpoint costs in USDC (base units + human-readable)
  • Cost comparison table vs Perplexity, Tavily, Brave Answers
  • Example monthly cost at 1k/10k/100k queries
  • Facilitator address for x402

4. xgate.run Submission

Submit to the xgate.run bazaar with:

  • Name: Queryx
  • Description: Agent-native web search API. Pay per query in USDC via x402.
  • Tags: search, web, research, x402, base
  • Endpoint: https://queryx.run
  • Pricing: from $0.001/query

5. Update README badges

  • CI badge
  • xgate.run listing badge (if available)
  • Network: Base badge

Acceptance Criteria

  • openapi.json validates against OpenAPI 3.1 spec
  • All 4 endpoints documented with request/response examples
  • x402 payment flow documented in agent guide
  • xgate.run listing live and searchable
  • README links to all docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions