API Documentation

GYD.AI API Docs

Run Fetch, Map, and Crawl from dashboard sessions or external API keys. Requests now use a single `urls` list format for all three services.

Authentication

External API calls must send x-api-key.

Proxy Options

Allowed values: datacenter or residential.

Base URL

http://localhost/api

QA Playbook

Full QA reference with smoke tests, status flows, negative cases, dashboard checks, and edge-case runner.

Open QA Docs

OpenAPI + Swagger

Interactive contract docs with "Try it out" and downloadable OpenAPI spec.

Open Swagger Docs

Request Format

Send one or more URLs via urls. For a single URL, send one item in the array.

{
  "urls": ["https://example.com"],
  "proxy": { "type": "datacenter" }
}

Fetch

Create Fetch Job

curl -X POST http://localhost/api/v1/fetch \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": ["https://example.com"],
    "proxy": { "type": "datacenter" }
  }'

Map

Create Map Job

curl -X POST http://localhost/api/v1/map \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": ["https://example.com"],
    "proxy": { "type": "residential" }
  }'

Crawl

Create Crawl Job

curl -X POST http://localhost/api/v1/crawl \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": ["https://example.com"],
    "max_depth": 2,
    "proxy": { "type": "datacenter" }
  }'

Get Job Status (Example: Fetch)

curl -X GET http://localhost/api/v1/fetch/<job_id> \
  -H "x-api-key: YOUR_API_KEY"

Dashboard runs are available at /fetch, /map, and /crawl.