Skip to main content
Template Benefits
  • Consistency: Same verification logic across jobs
  • Efficiency: Pre-configured search and scoring
  • Version Control: Track template versions over time
  • Reusability: Reference by ID when creating jobs
Use templates for recurring verification patterns like employee onboarding or vendor verification.
POST
/
v1
/
templates
Create a template
curl --request POST \
  --url https://api.peepal.dev/v1/templates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "version": 2,
  "input_schema": {},
  "extraction_schema": {},
  "search_plan": {},
  "scoring_rubric": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "version": 123,
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "deprecated_at": "2023-11-07T05:31:56Z",
  "input_schema": {},
  "extraction_schema": {},
  "search_plan": {},
  "scoring_rubric": {},
  "metadata": {}
}
Create a reusable verification template with predefined schemas, search strategies, and scoring rules. Templates streamline job creation for common verification scenarios. 
curl -X POST "https://api.peepal.dev/v1/templates" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "name": "Employee Verification",
    "version": 1,
    "description": "Standard employee background check",
    "input_schema": {},
    "extraction_schema": {},
    "search_plan": {},
    "scoring_rubric": {}
  }'

{
  "id": "tpl_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "name": "Employee Verification",
  "version": 1,
  "description": "Standard employee background check",
  "created_at": "2025-12-31T10:00:00Z",
  "deprecated_at": null,
  "input_schema": {},
  "extraction_schema": {},
  "search_plan": {},
  "scoring_rubric": {},
  "metadata": {}
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required
​
version
integer
required
Required range: x >= 1
​
input_schema
object
required
​
extraction_schema
object
required
​
search_plan
object
required
​
scoring_rubric
object
required
​
description
string
​
metadata
object

Response

Template created

​
id
string
required
​
name
string
required
​
version
integer
required
​
description
string | null
required
​
created_at
string<date-time>
required
​
deprecated_at
string<date-time> | null
required
​
input_schema
object
required
​
extraction_schema
object
required
​
search_plan
object
required
​
scoring_rubric
object
required
​
metadata
object