curl --request POST \
--url https://api.example.com/v1/endpoints/inspect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"provider": "<string>",
"endpoint": "<string>",
"endpoint_version": 1
}
'import requests
url = "https://api.example.com/v1/endpoints/inspect"
payload = {
"provider": "<string>",
"endpoint": "<string>",
"endpoint_version": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({provider: '<string>', endpoint: '<string>', endpoint_version: 1})
};
fetch('https://api.example.com/v1/endpoints/inspect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/endpoints/inspect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'provider' => '<string>',
'endpoint' => '<string>',
'endpoint_version' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/endpoints/inspect"
payload := strings.NewReader("{\n \"provider\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"endpoint_version\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/endpoints/inspect")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"endpoint_version\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/endpoints/inspect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"endpoint_version\": 1\n}"
response = http.request(request)
puts response.read_body{
"provider": "<string>",
"provider_label": "<string>",
"endpoint": "<string>",
"endpoint_version": 123,
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"price": {
"rule": {
"type": "flat",
"amount_usd": "<string>"
},
"charges": {
"NO_RESULT": "<string>",
"PROVIDER_ERROR": "<string>",
"TIMED_OUT": "<string>",
"INTERNAL": "<string>"
}
},
"run_mode": "sync",
"method": "GET",
"input_schema": {},
"output_schema": {},
"output_schema_source": "provider",
"sample_input": {},
"doc_url": "<string>",
"timeout_ms": 1
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"reason": "<string>",
"control": "<string>",
"retry_after_ms": 123,
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"reason": "<string>",
"control": "<string>",
"retry_after_ms": 123,
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "not_found",
"message": "<string>",
"reason": "<string>",
"control": "<string>",
"retry_after_ms": 123,
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "endpoint_version_mismatch",
"message": "<string>",
"reason": "<string>",
"control": "<string>",
"retry_after_ms": 123,
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "rate_limited",
"message": "<string>",
"reason": "<string>",
"control": "<string>",
"retry_after_ms": 123,
"details": {}
},
"request_id": "<string>"
}Inspect one endpoint: schemas, price, version
Returns the full execution contract of one endpoint: the provider-native input JSON Schema, the output JSON Schema when a trustworthy one exists (null otherwise — samples never imply a contract), its source, the price with every charge clause, the current endpoint_version, the run mode, a sample input, and a link to the provider’s own documentation. A sync endpoint also publishes timeout_ms, the maximum time from request to terminal response — set your HTTP client timeout above it. Passing endpoint_version pins the version you expect: anything other than the current version answers 409, the same rule run applies.
curl --request POST \
--url https://api.example.com/v1/endpoints/inspect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"provider": "<string>",
"endpoint": "<string>",
"endpoint_version": 1
}
'import requests
url = "https://api.example.com/v1/endpoints/inspect"
payload = {
"provider": "<string>",
"endpoint": "<string>",
"endpoint_version": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({provider: '<string>', endpoint: '<string>', endpoint_version: 1})
};
fetch('https://api.example.com/v1/endpoints/inspect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/endpoints/inspect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'provider' => '<string>',
'endpoint' => '<string>',
'endpoint_version' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/endpoints/inspect"
payload := strings.NewReader("{\n \"provider\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"endpoint_version\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/endpoints/inspect")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"endpoint_version\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/endpoints/inspect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"endpoint_version\": 1\n}"
response = http.request(request)
puts response.read_body{
"provider": "<string>",
"provider_label": "<string>",
"endpoint": "<string>",
"endpoint_version": 123,
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"price": {
"rule": {
"type": "flat",
"amount_usd": "<string>"
},
"charges": {
"NO_RESULT": "<string>",
"PROVIDER_ERROR": "<string>",
"TIMED_OUT": "<string>",
"INTERNAL": "<string>"
}
},
"run_mode": "sync",
"method": "GET",
"input_schema": {},
"output_schema": {},
"output_schema_source": "provider",
"sample_input": {},
"doc_url": "<string>",
"timeout_ms": 1
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"reason": "<string>",
"control": "<string>",
"retry_after_ms": 123,
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"reason": "<string>",
"control": "<string>",
"retry_after_ms": 123,
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "not_found",
"message": "<string>",
"reason": "<string>",
"control": "<string>",
"retry_after_ms": 123,
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "endpoint_version_mismatch",
"message": "<string>",
"reason": "<string>",
"control": "<string>",
"retry_after_ms": 123,
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "rate_limited",
"message": "<string>",
"reason": "<string>",
"control": "<string>",
"retry_after_ms": 123,
"details": {}
},
"request_id": "<string>"
}Body
Response
Success
^[a-z0-9][a-z0-9-]*$The Provider's brand name, for display: "People Data Labs" for provider "pdl". Identity stays with provider — that is the value run and inspect take, and this one is never sent back.
^\/.+$Show child attributes
Show child attributes
sync, async GET, POST, PUT, PATCH, DELETE, HEAD provider, glasser x > 0