API Reference

Complete reference for REST endpoints, MCP tools, and agent integration.

REST API Endpoints

Interactive OpenAPI specification. Expand endpoints to view schemas, try requests, and see responses.

MCP Tools for Claude

54 tools, grouped by capability — install via npx glashaus-mcp

Available in Claude Desktop after setup. This page is the canonical on-page catalogue; the full per-tool reference lives in /docs/TOOLS_REFERENCE.md.

Educational (13 tools)

Learn the platform before spending a single cent. Ask Claude to explain any concept.

  • explain_deployment_flow
  • explain_x402_payment
  • explain_wallet_setup
  • explain_setup
  • explain_architecture
  • explain_upload
  • explain_deploy
  • explain_domains
  • explain_wallet
  • explain_cid_and_indexing
  • explain_free_tier
  • get_implementation_guide
  • get_deployment_api

Wallet Management (7 tools)

Create, import, inspect wallets. Link GitHub for 100 MB free tier.

  • setup_wallet
  • import_wallet
  • get_wallet_info
  • start_github_link
  • check_github_link
  • get_free_tier_usage
  • remove_github_link

Upload & Deploy (10 tools)

Upload files, deploy websites, update deployments, preview costs, track status.

  • check_path
  • prepare_upload
  • upload_files
  • confirm_upload
  • deploy_as_website
  • update_deployment
  • get_deployment_status
  • delete_pin
  • get_pricing
  • get_system_info

Domains & Analytics (7 tools)

Manage custom domains, query analytics, list content, check stats.

  • add_domain
  • remove_domain
  • list_domains
  • list_files
  • get_analytics
  • get_agent_stats
  • get_network_info

Secrets & Proxy (4 tools)

Store encrypted API credentials for static websites. Secrets injected into proxy calls — sites never see raw keys.

  • create_secret
  • setup_secret
  • list_secrets
  • delete_secret

IPFS Node & Network (11 tools)

Inspect and manage the Glashaus IPFS node. Standard IPFS CLI equivalents.

  • ipfs_id
  • ipfs_swarm_peers
  • ipfs_pin_ls
  • ipfs_dag_stat
  • ipfs_block_stat
  • ipfs_ls
  • ipfs_routing_findprovs
  • ipfs_version
  • ipfs_swarm_addrs_local
  • ipfs_swarm_connect
  • ipfs_swarm_disconnect

Feedback (1 tool)

Submit feedback to help improve Glashaus.

  • submit_feedback

Agent Discovery Flow

Recommended sequence for agents to discover and interact with the platform.

1

Discover the Platform

Call /api/info to learn about available features, networks, and interfaces

2

Choose Your Network

Call /api/info/networks to select between testnet or mainnet with proper endpoints

3

Understand Authentication

Call /api/info/auth to grasp x402 signature-based payment verification

4

Implement Rate Limits

Call /api/info/limits to build rate-limit-aware retry logic

5

Preview Costs

Query /api/pricing to display deployment costs before requesting payment

6

Deploy with x402 Payments

Use MCP tools or REST endpoints to deploy files with signed wallet transactions

Best Practices

Key guidelines for building reliable integrations against the Glashaus API.

Caching

Cache /api/info* responses for 1+ hours — they rarely change. Never cache pricing or wallet balances; these change per request and per transaction.

Error Handling

Respect HTTP 429 Retry-After headers. Use exponential backoff (1s, 2s, 4s, 8s, max 60s). Handle 402 by signing the challenge and 403 by re-reading it.

Security

Validate all signatures to prevent replay attacks. Check wallet approval before payment. Verify USDC balance and store private keys encrypted — never in environment variables.