> ## Documentation Index
> Fetch the complete documentation index at: https://monid.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Inspect

> Get full details for a specific data endpoint.

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

## Request

```text theme={null}
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

<CodeGroup>
  ```bash curl theme={null}
  curl -X POST https://api.monid.ai/v1/inspect \
    -H "Authorization: Bearer monid_live_..." \
    -H "Content-Type: application/json" \
    -d '{
      "provider": "apify",
      "endpoint": "/apidojo/tweet-scraper"
    }'
  ```

  ```typescript TypeScript theme={null}
  const response = await fetch("https://api.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 Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response

### 200 OK

| Field               | Type                   | Description                                                                                                                                              |
| ------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                | string                 | Unique inspection identifier                                                                                                                             |
| `provider`          | string                 | Provider slug                                                                                                                                            |
| `providerName`      | string \| undefined    | Provider display name (may be absent)                                                                                                                    |
| `endpoint`          | string                 | Endpoint path                                                                                                                                            |
| `method`            | string \| undefined    | HTTP method for this endpoint                                                                                                                            |
| `description`       | string                 | What the endpoint does                                                                                                                                   |
| `summary`           | string \| undefined    | Detailed overview                                                                                                                                        |
| `input`             | object \| undefined    | Structured input — a JSON Schema per parameter location                                                                                                  |
| `input.pathParams`  | object \| undefined    | JSON Schema for URL path parameters                                                                                                                      |
| `input.queryParams` | object \| undefined    | JSON Schema for query string parameters                                                                                                                  |
| `input.body`        | object \| undefined    | JSON Schema for the request body                                                                                                                         |
| `input.bodyType`    | string \| undefined    | Body content type: `"json"`, `"form"`, or `"multipart"`                                                                                                  |
| `price`             | object \| undefined    | Pricing information                                                                                                                                      |
| `price.type`        | string                 | Pricing model, e.g. `"PER_CALL"`, `"PER_RESULT"` (other types such as `"BY_PERIOD"`, `"PER_UNIT_MATRIX"`, `"METERED"` may appear with additional fields) |
| `price.amount`      | object                 | Price as `{ "value": number, "currency": "USD" }`                                                                                                        |
| `price.flatFee`     | object \| undefined    | Base fee per call as `{ "value": number, "currency": "USD" }` (PER\_RESULT only)                                                                         |
| `price.notes`       | string\[] \| undefined | Pricing notes                                                                                                                                            |
| `docUrl`            | string \| undefined    | Link to provider documentation                                                                                                                           |
| `notes`             | string\[] \| undefined | Operator-curated notes — quirks, pitfalls, best practices                                                                                                |
| `tags`              | string\[]              | Endpoint tags (e.g. `["verified"]`)                                                                                                                      |
| `hints`             | object \| undefined    | Ready-to-use next-step commands, keyed by a descriptive phrase                                                                                           |

### Example Response

```json theme={null}
{
  "id": "01HXYZ...",
  "provider": "apify",
  "providerName": "Apify",
  "endpoint": "/apidojo/tweet-scraper",
  "method": "POST",
  "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.",
  "input": {
    "body": {
      "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"
        }
      }
    },
    "bodyType": "json"
  },
  "price": {
    "type": "PER_CALL",
    "amount": {
      "value": 0.003,
      "currency": "USD"
    }
  },
  "docUrl": "https://apify.com/apidojo/tweet-scraper",
  "tags": ["verified"],
  "hints": {
    "run this endpoint": "curl -X POST https://api.monid.ai/v1/run -H 'Authorization: Bearer <API_KEY>' -H 'Content-Type: application/json' -d '{\"provider\":\"apify\",\"endpoint\":\"/apidojo/tweet-scraper\",\"input\":{...}}'"
  }
}
```

## Next Step

Use [`POST /v1/run`](/docs/api/run) to execute the endpoint with your input.