Skip to content

monid inspect

Get full details for a specific data endpoint, including input schema, pricing, and documentation.

Usage

bash
monid inspect -p <provider> -e <endpoint> [--json]

Flags

FlagTypeRequiredDescription
-p, --provider <provider>stringYesProvider slug (e.g., apify)
-e, --endpoint <endpoint>stringYesEndpoint path (e.g., /apidojo/tweet-scraper)
-j, --jsonbooleanNoOutput raw JSON

Examples

bash
# Inspect a Twitter scraper
monid inspect -p apify -e /apidojo/tweet-scraper

# Inspect a Google Maps scraper
monid inspect -p apify -e /damilo/google-maps-scraper

# Get raw JSON output
monid inspect -p apify -e /apidojo/tweet-scraper --json

Output

The inspect command displays:

  • Provider and endpoint name
  • Description -- what the endpoint does
  • Summary -- detailed overview (when available)
  • Input schema -- JSON schema of accepted parameters
  • Pricing -- type (PER_CALL or PER_RESULT), amount, flat fee, and notes
  • Documentation URL -- link to the provider's docs
  • Usage examples -- ready-to-use CLI and API commands

Example output:

Provider:    apify
Endpoint:    /apidojo/tweet-scraper
Description: Scrape tweets by search terms, hashtags, or user handles

Price:
  Type:   PER_CALL
  Amount: $0.003

Input Schema:
  {
    "searchTerms": ["string"],
    "maxItems": "number",
    "sort": "string"
  }

Documentation: https://apify.com/apidojo/tweet-scraper

Usage:
  CLI: monid run -p apify -e /apidojo/tweet-scraper -i '{"searchTerms":["AI"]}'
  API: POST /v1/run {"provider":"apify","endpoint":"/apidojo/tweet-scraper","input":{...}}

TIP

Always inspect before running. The input schema tells you exactly what parameters the endpoint accepts -- never guess.

Next Steps

After inspecting an endpoint, use monid run to execute it.

The data layer for AI agents.