Skip to main content
Use this endpoint to review template configuration before using it in a job.
GET
/
v1
/
templates
/
{template_id}
Get a template
curl --request GET \
  --url https://api.peepal.dev/v1/templates/{template_id} \
  --header 'x-api-key: <api-key>'
{
  "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": {}
}
Retrieve the full details of a specific template including all schemas and configurations. 
curl -X GET "https://api.peepal.dev/v1/templates/tpl_01ARZ3NDEKTSV4RRFFQ69G5FAV" \
  -H "x-api-key: YOUR_API_KEY"

{
  "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

Path Parameters

​
template_id
string
required

Response

Template details

​
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