AlterLabAPI Reference
Auto-generated
Templates
API reference for templates endpoints.
Auto-generated
This page was generated from the OpenAPI spec. Run
make generate-docs to refresh after spec changes.GET /api/v1/templates
GET
/api/v1/templatesList public scrape templates
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| page | integer | Optional | Page number (1-based)Default: 1 |
| page_size | integer | Optional | Items per pageDefault: 20 |
| tag | string | Optional | Filter by tag |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/templates \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"templates": [],
"total": 0,
"page": 0,
"page_size": 0
}GET /api/v1/templates/{slug}
GET
/api/v1/templates/{slug}Get a scrape template by slug
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| slug | string | Required | slug |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/templates/<slug> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"slug": "example",
"name": "example",
"description": "example",
"url_pattern": "example",
"request_config": {}
}