POST /v1/inspect

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

Request

POST /v1/inspect

Headers

Header	Required	Description
Authorization	Yes	Bearer <api-key>
Content-Type	Yes	application/json

Body

Field	Type	Required	Description
provider	string	Yes	Provider slug (e.g., "apify")
endpoint	string	Yes	Endpoint path (e.g., "/apidojo/tweet-scraper")

Example Request

curl

curl -X POST https://api.dev.monid.ai/v1/inspect \
  -H "Authorization: Bearer monid_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "apify",
    "endpoint": "/apidojo/tweet-scraper"
  }'

TypeScript

const response = await fetch("https://api.dev.monid.ai/v1/inspect", {
  method: "POST",
  headers: {
    "Authorization": "Bearer monid_live_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    provider: "apify",
    endpoint: "/apidojo/tweet-scraper",
  }),
});

const data = await response.json();

Python

import requests

response = requests.post(
    "https://api.dev.monid.ai/v1/inspect",
    headers={
        "Authorization": "Bearer monid_live_...",
        "Content-Type": "application/json",
    },
    json={
        "provider": "apify",
        "endpoint": "/apidojo/tweet-scraper",
    },
)

data = response.json()

Response

200 OK

Field	Type	Description
id	string	Unique endpoint identifier
provider	string	Provider slug
providerName	string	Provider display name
endpoint	string	Endpoint path
description	string	What the endpoint does
summary	string | null	Detailed overview
inputSchema	object | null	JSON schema of accepted input parameters
price	object	Pricing information
price.type	string	"PER_CALL" or "PER_RESULT"
price.amount	number	Price in USD
price.flatFee	number | null	Base fee per call (PER_RESULT only)
price.currency	string	"USD"
price.notes	string[] | null	Pricing notes
docUrl	string | null	Link to provider documentation
notes	string[] | null	Additional notes about the endpoint
usage	object	Usage examples
usage.api	string	API usage example

Example Response

{
  "id": "apify:/apidojo/tweet-scraper",
  "provider": "apify",
  "providerName": "Apify",
  "endpoint": "/apidojo/tweet-scraper",
  "description": "Scrape tweets by search terms, hashtags, or user handles",
  "summary": "A powerful Twitter scraping tool that allows you to extract tweets based on search queries.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "searchTerms": {
        "type": "array",
        "items": { "type": "string" },
        "description": "List of search terms to query"
      },
      "maxItems": {
        "type": "number",
        "description": "Maximum number of items to return per search term"
      }
    }
  },
  "price": {
    "type": "PER_CALL",
    "amount": 0.003,
    "currency": "USD"
  },
  "docUrl": "https://apify.com/apidojo/tweet-scraper",
  "notes": null,
  "usage": {
    "api": "POST /v1/run {\"provider\":\"apify\",\"endpoint\":\"/apidojo/tweet-scraper\",\"input\":{...}}"
  }
}

Next Step

Use POST /v1/run to execute the endpoint with your input.