Developer Portal

Build with Flowtivity

Integrate AI-powered website scanning, automation analysis, and business intelligence into your applications. Free tier available.

OpenAPI SpecTry Free Scan

Quick Start

Get your first scan running in under 30 seconds.

1

Trigger a Scan

curl -X POST https://flowtivity.ai/api/insights/scan \
  -H "Content-Type: application/json" \
  -d '{
    "url": "example.com",
    "scanType": "basic"
  }'

# Response:
# { "scanId": "uuid-here", "status": "pending" }
2

Check Status

curl https://flowtivity.ai/api/insights/scan/{scanId}/status

# Response:
# { "status": "complete", "progress": 100 }
3

Get Results

curl https://flowtivity.ai/api/insights/scan/{scanId}/results

# Returns: readinessScore, aeoScore, workflows[],
#          opportunities[], keyFindings[], executiveSummary

Integration Options

Choose the integration method that fits your workflow.

REST API

Standard HTTP endpoints with JSON responses. OpenAPI 3.1 spec available (API key required).

View OpenAPI Spec

MCP Server

Model Context Protocol server with Streamable HTTP transport. Use with Claude, ChatGPT, and other AI agents.

Endpoint: /.well-known/mcp

Server Card: /.well-known/mcp/server-card.json

Transport: Streamable HTTP

Tools: 12 available

MCP Server (CLI)

Run the MCP server locally via stdio for direct integration with AI coding tools.

# Add to .mcp.json:
{
  "mcpServers": {
    "flowtivity": {
      "command": "npx",
      "args": [
        "flowtivity-insights-mcp"
      ],
      "env": {
        "MCP_API_KEY": "your-key"
      }
    }
  }
}

API Reference

Core endpoints for the Flowtivity API. Full spec at /openapi.json (API key required).

POST/api/insights/scanTrigger a new website scan
GET/api/insights/scan/{id}/statusCheck scan progress
GET/api/insights/scan/{id}/resultsGet full scan results with scores, workflows, opportunities
GET/api/insights/scan/{id}/comprehensiveGet results + playbook, AEO boost, directory listing
GET/api/insights/scansList recent scans with pagination and filters
GET/api/insights/playbook/{id}Get AI automation playbook
GET/api/directoryBrowse AI Business Directory
GET/api/directory/{slug}Get specific directory listing
GET/api/insights/analyticsAggregate analytics across scans

Authentication

Free tier requires no authentication. For higher limits and premium features, use an API key.

Free Tier

  • • 10 scans per day
  • • Full results access
  • • Directory browsing
  • • No credit card required

API Key

  • • Higher rate limits
  • • Playbook access
  • • Premium analytics
  • • Priority processing

Using your API key

# Via header
curl -H "x-mcp-api-key: your-key" \
  https://flowtivity.ai/api/insights/scans

# Via MCP server
MCP_API_KEY=your-key npx flowtivity-insights-mcp

# OAuth 2.0 (coming soon)
# Authorization: Bearer <token>

Scoped Permissions

insights:readinsights:writedirectory:readscans:readscans:writeanalytics:readplaybooks:read

Resources

OpenAPI Spec

Full API specification (OAS 3.1) — API key required

API Reference

Machine-readable API docs

Pricing

Machine-readable pricing tiers

Webhooks

Scan completion notifications

Agent Discovery Endpoints

Well-known URLs for automated AI agent discovery.

EndpointPurpose
/.well-known/agent.jsonAgent capabilities discovery
/.well-known/agent-card.jsonA2A agent card (skills, contact)
/.well-known/ai-plugin.jsonAI plugin manifest
/.well-known/mcpMCP server discovery & transport
/.well-known/mcp/server-card.jsonMCP server card (tools)
/.well-known/agent-skills/index.jsonAgent skills index
/.well-known/oauth-authorization-serverOAuth 2.0 metadata
/.well-known/openid-configurationOIDC Discovery
/.well-known/oauth-protected-resourceProtected resource metadata
/.well-known/api-catalogAPI catalog (RFC 9727)
/.well-known/http-message-signatures-directoryWeb Bot Auth keys
/.well-known/llms.txtLLMs documentation (well-known)
/.well-known/pricing.mdPricing (well-known)
/llms.txtAI-readable summary
/llms-full.txtFull AI documentation
/openapi.jsonOpenAPI 3.1 specification (API key required)
/pricing.mdMachine-readable pricing
/agents.mdAgent discovery file
/index.mdMarkdown homepage
/askNLWeb natural-language query endpoint
/api/healthHealth check (free, no auth)
/api/llms.txtAPI-scoped documentation
/api/webhooks/subscribeWebhook subscription
/docs/llms.txtProduct documentation

Ready to build?

Start scanning websites for free. No API key required.

Start Free ScanGet API Key