Requstory

Find companies Requstory has already mapped and scored from their public websites, by name or website. Use this first to get the "slug" for get_company_score. For a company that is not found, use check_ai_readiness (quick, public) or map_website (full map, needs a key).

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Part of a company name or website, e.g. \"stripe\"."
    },
    "industry": {
      "type": "string",
      "description": "Optional industry id, e.g. \"dental\" or \"payments-fintech\"."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Up to 50; default 10."
    }
  },
  "required": [],
  "additionalProperties": false
}

Get a public company's ease-of-doing-business score (0–100, four parts: find and understand, get started online, get help, AI-agent ready), its ranking place, and the gaps that cost it points, most costly first, with proof. Use after search_companies. For a site with no public page, use check_ai_readiness instead.

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "Company slug from search_companies, e.g. \"posthog-com\"."
    }
  },
  "required": [
    "slug"
  ],
  "additionalProperties": false
}

Check whether AI agents can read, understand and act on any website (bots allowed, readable pages, product data, checkout, help). Reads up to 3 public pages; results are kept for 24 hours and public at requstory.com/ai-readiness/<domain>/. Faster and narrower than map_website. If status is "queued" or "running", call again with start=false.

{
  "type": "object",
  "properties": {
    "website": {
      "type": "string",
      "description": "Website address or domain, e.g. \"posthog.com\" or \"https://www.example.co.uk\"."
    },
    "start": {
      "type": "boolean",
      "description": "Start a new check if none is fresh (default true). Use false to only read the result."
    }
  },
  "required": [
    "website"
  ],
  "additionalProperties": false
}

Map how a company works from up to 6 pages of its public website: customer journey, teams, processes and handoffs. The map is saved to your Requstory account (free; 5 a day). Waits up to 25 seconds; if the job is still running, poll get_map_job. Then read it with get_map. Needs an API key.

{
  "type": "object",
  "properties": {
    "website": {
      "type": "string",
      "description": "Website address or domain, e.g. \"posthog.com\" or \"https://www.example.co.uk\"."
    }
  },
  "required": [
    "website"
  ],
  "additionalProperties": false
}

Check a map_website job that was still running. When status is "complete" it returns mapId for get_map. Needs an API key.

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "jobId returned by map_website."
    }
  },
  "required": [
    "jobId"
  ],
  "additionalProperties": false
}

List the maps saved in your Requstory account (newest first) with their ids. Use to find a mapId for get_map or ask_map. Needs an API key.

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

Read a saved map in brief: journey stages, teams with owners and processes, teams with no owner, checks peers pass but this company misses, AI-agent readiness gaps, fix progress and source pages. Set full=true for the whole JSON model. Use ask_map for a specific question instead. Needs an API key.

{
  "type": "object",
  "properties": {
    "mapId": {
      "type": "string",
      "description": "Saved map id (uuid) from list_maps or map_website."
    },
    "full": {
      "type": "boolean",
      "description": "Include the full JSON model (large). Default false."
    }
  },
  "required": [
    "mapId"
  ],
  "additionalProperties": false
}

Ask a question about a saved map. By default it answers free from the map's website pages and entries, with citations. Set ai=true for a written Requ AI answer, which uses account credits (Team). Prefer get_map for an overview. Needs an API key.

{
  "type": "object",
  "properties": {
    "mapId": {
      "type": "string",
      "description": "Saved map id (uuid) from list_maps or map_website."
    },
    "question": {
      "type": "string",
      "description": "The question, up to 1,000 characters."
    },
    "ai": {
      "type": "boolean",
      "description": "Use Requ AI (uses credits). Default false."
    }
  },
  "required": [
    "mapId",
    "question"
  ],
  "additionalProperties": false
}

Get a made-up company run end to end by AI agents, built from real public company maps, as a Requ template: teams as agent lanes, the model for each step, steps a person keeps, and monthly model cost. Use it as a starting point to design an AI-agent-run business; edit the Requ and render it with npx @requstory/cli. Needs an API key.

{
  "type": "object",
  "properties": {
    "company": {
      "type": "string",
      "enum": [
        "online-store",
        "software-startup",
        "agency",
        "professional-firm",
        "local-service-business"
      ],
      "description": "Kind of company."
    },
    "mix": {
      "type": "string",
      "enum": [
        "mixed",
        "large",
        "small"
      ],
      "description": "Model mix: mixed (default), large or small."
    },
    "name": {
      "type": "string",
      "description": "Optional company name for the template."
    }
  },
  "required": [
    "company"
  ],
  "additionalProperties": false
}

Show the account behind the API key: plan (free or team), credits left, number of saved maps and maps left today. Needs an API key.

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}