> For the complete documentation index, see [llms.txt](https://sentinel-11.gitbook.io/sentinel-scout-ai-data-layer/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sentinel-11.gitbook.io/sentinel-scout-ai-data-layer/scout-api-interface-easy.md).

# Scout API Interface (Easy)

## Sentinel Scout – Easy Mode Docs

***

### 1. What is Sentinel Scout?

Sentinel Scout is a system for **web scraping and data collection**.\
It uses a **global proxy network** and **smart scrapers** to get data from websites, even ones with protections like CAPTCHAs or dynamic content.

You can use it to:

* Collect datasets for AI/ML models.
* Automate research tasks.
* Run scraping agents without managing proxies yourself.

***

### 2. APIs

Scout has two main APIs:

* **REST API:** Easy to use, works with HTTP/JSON.
  * Base URL: `https://api.scout.sentinel.co`
  * Docs/Playground: [Swagger UI](https://api.scout.sentinel.co/swagger)
* **gRPC API:** High performance, for advanced users.
  * Endpoint: `grpc.scout.sentinel.co`

***

### 3. Submitting a Scraping Job

To scrape a page, use `POST /api/v1/probe`.\
You provide:

* `url` – the website you want.
* `countryCode` – where to scrape from (like `US` or `IN`).
* `tagsToStripOff` – HTML tags to remove (like `script`, `style`).
* Options like:
  * `fallBackRouting` (rotate proxies if blocked).
  * `antiBotScrape` (bypass bot protection).
  * `outputFileExtension` (`HTML` or `JSON`).

#### Example Request

```bash
curl -X POST "https://api.scout.sentinel.co/api/v1/probe" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://en.wikipedia.org/wiki/Artificial_intelligence",
    "countryCode": "US",
    "tagsToStripOff": ["script", "style"],
    "fallBackRouting": true,
    "antiBotScrape": true,
    "outputFileExtension": "EXTENSION_HTML"
  }'
```

This will return a `taskId` you can use to check status.

***

### 4. Checking Task Status

Use `GET /api/v1/probe/task?taskId=<id>` to see if your scrape finished.

#### Example

```bash
curl -X GET "https://api.scout.sentinel.co/api/v1/probe/task?taskId=1234" \
  -H "Authorization: Bearer <API_KEY>"
```

If completed, the response gives you a **download link** with the scraped data.

***

### 5. User API

Check your account, credits, and jobs with `GET /api/v1/user`.

#### Example

```bash
curl -X GET "https://api.scout.sentinel.co/api/v1/user" \
  -H "Authorization: Bearer <API_KEY>"
```

Response shows:

* Your `creditCoins` (used for scraping).
* Your `goldCoins` (earned by running a Scout node).
* Job summary (completed, in-progress, failed).

***

### 6. Coins

* **Credit Coins:** Used by users to pay for scraping. Right now, free daily top-ups.

***

### 7. What’s Next

Scout is growing. Upcoming features include:

* Direct **ML model integration** (MCP server).
* **Web3 storage** (Jackal) for long-term scraped data.
* More countries, cities, and ISPs in the proxy network.
* Output in **Markdown**.
* Smarter **anti-bot and CAPTCHA bypass**.

***

### 8. Getting Started

1. Get an API key from the dashboard at scout.sentinel.co
2. Use the **Swagger playground** to test endpoints.
3. Submit a scrape → check status → download results.