Quickstart
Get an API key, find your project and add your first website.
This page takes about five minutes. At the end, you have a website in your project and its analysis runs.
Get an API key
- Sign in to the DeepScout Console. Your first sign-in creates your account.
- Open Settings → API keys and click Generate new key.
- In Scope, select All my projects.
- Copy the key. The console shows it only one time.
Keep the key in an environment variable. The examples in these docs read it from SCOUT_API_KEY.
export SCOUT_API_KEY="your-api-key"A key for one project works only in this project. It cannot read the customer or the credit, so some steps in the guides need a key with the scope All my projects. See Key scopes.
Find your project
All websites, jobs and exports belong to a project. Your account has a default project. The list shows it first.
curl https://api.deepscout.ai/v1/projects \
-H "Authorization: Bearer $SCOUT_API_KEY"[
{
"project_id": "proj_01k7c2r9v8e3s0b1x6m4q5n2tz",
"name": "Default project",
"customer_id": "cust_01k7c2r9t2f8a5d3h7j9k1m6pw",
"is_default": true
}
]Keep the project_id. Most requests need it.
Add a website
Send the URL of the store, the country of the shoppers and the currency of the prices. This starts a setup job. The first 10 setup jobs of each month are free.
curl https://api.deepscout.ai/v1/jobs/setup \
-H "Authorization: Bearer $SCOUT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"project_id": "proj_01k7c2r9v8e3s0b1x6m4q5n2tz",
"url": "https://www.example-shop.cz",
"country": "CZ",
"currency": "CZK"
}'{
"job_id": "jobreq_01k7c3a4b5c6d7e8f9g0h1j2k3",
"job_type": "WEBSITE_SETUP",
"status": "ANALYZING",
"project_id": "proj_01k7c2r9v8e3s0b1x6m4q5n2tz",
"url": "https://www.example-shop.cz",
"country": "cz",
"currency": "CZK",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Follow the progress
Read the job again to see the progress of the analysis. The analysis usually takes a few minutes. Then a training scrape starts.
curl https://api.deepscout.ai/v1/jobs/setup/jobreq_01k7c3a4b5c6d7e8f9g0h1j2k3 \
-H "Authorization: Bearer $SCOUT_API_KEY"When the status is COMPLETED, the website is ready. You can look at the sample data and get a quote for the full scrape.