API Reference

API Integration Documentation

Written by , Product docsLast updated

Use this reference when your application or agent already has a Hive key and needs the exact MCP, REST, discovery, and auth contracts. If you have not made a first request yet, start with Get Started or Quick Start.

Before you start

  • Create an API key at /dashboard/keys.
  • Send new requests with Authorization: Bearer YOUR_HIVE_API_KEY.
  • Use root MCP for general-purpose agents, category MCP for focused agents, and REST for backends or jobs.
  • Verify tool names through tools/list, hive://tools, or authenticated GET /api/v1/tools before hard-coding them.

Overview

Hive exposes three primary integration surfaces:

InterfaceEndpointPurpose
Root MCPhttps://mcp.hiveintelligence.xyz/mcpRecommended entry point for LLM and agent workflows
Category-scoped MCPhttps://mcp.hiveintelligence.xyz/hive_*/mcpSmaller direct tool surfaces by category
REST APIhttps://mcp.hiveintelligence.xyz/api/v1Direct HTTP access for listing and executing tools
B2B readinesshttps://mcp.hiveintelligence.xyz/api/v1/b2b/readinessCheck whether a server-side key is ready for signed downstream subject isolation

Current catalog shape

  • 10 category-scoped MCP endpoints
  • 351 categorized provider tools across those endpoints
  • 18 Hive-native stateful monitoring, memory, alert, report, and B2B subject tools
  • 369 callable tools in the full live catalog
  • 13 root MCP discovery tools that route into the provider catalog
  • 9 active provider integrations reflected in hive://providers

Authentication

Use Authorization: Bearer YOUR_HIVE_API_KEY. The legacy x-api-key header is still accepted for older integrations but is no longer recommended. New code should use Bearer.


Root MCP

Endpoint: POST https://mcp.hiveintelligence.xyz/mcp

The root endpoint is designed for discovery-heavy AI workflows.

What to use on root MCP

  • tools/list for the compact 13-tool root discovery layer
  • hive://tools for the full live tool inventory
  • hive://categories for the 10 scoped endpoints
  • hive://providers for provider status
  • hive://toolsets, hive://skills, and hive://status for task routing, agent skills, and runtime status semantics
  • get_api_endpoint_schema for exact input parameters
  • invoke_api_endpoint to execute any exact callable tool from root /mcp

Example tool call

bash
curl -X POST https://mcp.hiveintelligence.xyz/mcp \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -H "Authorization: Bearer YOUR_HIVE_API_KEY" \
  -d '{
    "jsonrpc": "2.0",
    "method": "tools/call",
    "params": {
      "name": "invoke_api_endpoint",
      "arguments": {
        "endpoint_name": "get_price",
        "args": {
          "ids": "bitcoin",
          "vs_currencies": "usd"
        }
      }
    },
    "id": 1
  }'

Category-scoped MCP endpoints

These endpoints expose direct tools/list results for one slice of the catalog.

CategoryEndpoint
Market Data/hive_market_data/mcp
DEX Analytics/hive_onchain_dex/mcp
Portfolio & Wallet/hive_portfolio_wallet/mcp
Token & Contract/hive_token_contract/mcp
DeFi Protocols/hive_defi_protocol/mcp
NFT Analytics/hive_nft_analytics/mcp
Security & Risk/hive_security_risk/mcp
Network & Infrastructure/hive_network_infrastructure/mcp
Search & Discovery/hive_search_discovery/mcp
Prediction Markets/hive_prediction_markets/mcp

REST API

Base URL: https://mcp.hiveintelligence.xyz/api/v1

List tools

bash
curl -X GET "https://mcp.hiveintelligence.xyz/api/v1/tools?search=price&limit=10" \
  -H "Authorization: Bearer YOUR_HIVE_API_KEY"

This endpoint lists the full live callable catalog, not just the categorized provider tools.

Useful query params:

  • search
  • limit
  • cursor
  • sort=name
  • order=asc|desc
  • fields=name,title,description,inputSchema

Execute a tool

bash
curl -X POST https://mcp.hiveintelligence.xyz/api/v1/execute \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_HIVE_API_KEY" \
  -d '{
    "tool": "get_price",
    "args": {
      "ids": "bitcoin",
      "vs_currencies": "usd"
    }
  }'

The current REST payload keys are tool and args. Older toolName / arguments examples are legacy.

B2B readiness

Partner products that serve many downstream customers should use one server-side Hive key and signed subject context. Check whether that key is B2B-ready before you write subject-scoped monitor, memory, alert, or report state:

bash
curl https://mcp.hiveintelligence.xyz/api/v1/b2b/readiness \
  -H "Authorization: Bearer YOUR_HIVE_API_KEY"

The endpoint reports whether the authenticated key is configured for B2B subjects and whether the subject-signing secret is present. It does not return the secret. See B2B Partner Adapter for the signed header contract.

Key and usage endpoints

Dashboard and CLI auth use the same API host:

EndpointMethodAuthPurpose
/auth/signupPOSTemail/password bodyCreate a Supabase-backed account and first key
/auth/loginPOSTemail/password bodyCreate a session token
/auth/meGETSupabase bearer tokenRead profile and plan
/api/v1/keysGETSupabase bearer tokenList API keys
/api/v1/keysPOSTSupabase bearer token + optional Idempotency-KeyCreate a one-time-revealed key; set b2b_subjects_enabled: true to issue a B2B key
/api/v1/keys/:idDELETESupabase bearer tokenDisable a key
/api/v1/usageGETSupabase bearer token or Hive API keyRead plan, credit wallet, and key summary

When POST /api/v1/keys receives b2b_subjects_enabled: true, the one-time response can include subject_signing_secret. Store it server-side with the API key; it is required for the signed subject headers described in B2B Partner Adapter.

Health and metadata endpoints

EndpointPurpose
/api/openapi.jsonOpenAPI document for REST clients
/docsHosted OpenAPI UI
/api/health, /api/health/quickGeneral health checks
/api/health/apis, /api/health/:apiNameProvider health checks
/api/health/toolsets, /api/health/toolsets/:toolsetIdTask toolset canaries
/api/health/toolsets/quick, /api/health/toolsets/historyFast canary status and history
/api/health/workflows, /api/health/workflows/quick, /api/health/workflows/historyWorkflow regression routing and schema checks
/statusFull server status snapshot
/live, /ready, /startupRuntime lifecycle probes
/ping, /healthCompatibility health probes

Discovery resources

Use these from the root MCP endpoint:

  • hive://providers
  • hive://categories
  • hive://tools
  • hive://toolsets
  • hive://task-canaries
  • hive://skills
  • hive://status

Prompts currently exposed by the server:

  • analyze_token - requires token; accepts optional chain.
  • compare_protocols - requires protocols, a comma-separated protocol list.
  • portfolio_audit - requires address, the wallet address to audit.