Create Web template
curl --request POST \
--url https://platform.inklink.com/api/v1/web/template \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"query": "<string>",
"start_url": "<string>",
"return_url": "<string>",
"name": "<string>",
"description": "<string>",
"capture_type": "screenshot",
"fields": [
{
"name": "<string>",
"required": true,
"description": "<string>"
}
],
"user_instruction": "<string>",
"acceptance_guide": "<string>",
"ai_instruction": "<string>",
"login_methods": [
{
"provider": "<string>",
"config": {}
}
],
"allowed_modes": [],
"settings": {
"show_acceptance_guide": true,
"show_cover_page": true
},
"metadata": {},
"status": "draft",
"theme_id": "<string>"
}
'import requests
url = "https://platform.inklink.com/api/v1/web/template"
payload = {
"query": "<string>",
"start_url": "<string>",
"return_url": "<string>",
"name": "<string>",
"description": "<string>",
"capture_type": "screenshot",
"fields": [
{
"name": "<string>",
"required": True,
"description": "<string>"
}
],
"user_instruction": "<string>",
"acceptance_guide": "<string>",
"ai_instruction": "<string>",
"login_methods": [
{
"provider": "<string>",
"config": {}
}
],
"allowed_modes": [],
"settings": {
"show_acceptance_guide": True,
"show_cover_page": True
},
"metadata": {},
"status": "draft",
"theme_id": "<string>"
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
start_url: '<string>',
return_url: '<string>',
name: '<string>',
description: '<string>',
capture_type: 'screenshot',
fields: [{name: '<string>', required: true, description: '<string>'}],
user_instruction: '<string>',
acceptance_guide: '<string>',
ai_instruction: '<string>',
login_methods: [{provider: '<string>', config: {}}],
allowed_modes: [],
settings: {show_acceptance_guide: true, show_cover_page: true},
metadata: {},
status: 'draft',
theme_id: '<string>'
})
};
fetch('https://platform.inklink.com/api/v1/web/template', 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://platform.inklink.com/api/v1/web/template",
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([
'query' => '<string>',
'start_url' => '<string>',
'return_url' => '<string>',
'name' => '<string>',
'description' => '<string>',
'capture_type' => 'screenshot',
'fields' => [
[
'name' => '<string>',
'required' => true,
'description' => '<string>'
]
],
'user_instruction' => '<string>',
'acceptance_guide' => '<string>',
'ai_instruction' => '<string>',
'login_methods' => [
[
'provider' => '<string>',
'config' => [
]
]
],
'allowed_modes' => [
],
'settings' => [
'show_acceptance_guide' => true,
'show_cover_page' => true
],
'metadata' => [
],
'status' => 'draft',
'theme_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$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://platform.inklink.com/api/v1/web/template"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"start_url\": \"<string>\",\n \"return_url\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"capture_type\": \"screenshot\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"description\": \"<string>\"\n }\n ],\n \"user_instruction\": \"<string>\",\n \"acceptance_guide\": \"<string>\",\n \"ai_instruction\": \"<string>\",\n \"login_methods\": [\n {\n \"provider\": \"<string>\",\n \"config\": {}\n }\n ],\n \"allowed_modes\": [],\n \"settings\": {\n \"show_acceptance_guide\": true,\n \"show_cover_page\": true\n },\n \"metadata\": {},\n \"status\": \"draft\",\n \"theme_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
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://platform.inklink.com/api/v1/web/template")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"start_url\": \"<string>\",\n \"return_url\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"capture_type\": \"screenshot\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"description\": \"<string>\"\n }\n ],\n \"user_instruction\": \"<string>\",\n \"acceptance_guide\": \"<string>\",\n \"ai_instruction\": \"<string>\",\n \"login_methods\": [\n {\n \"provider\": \"<string>\",\n \"config\": {}\n }\n ],\n \"allowed_modes\": [],\n \"settings\": {\n \"show_acceptance_guide\": true,\n \"show_cover_page\": true\n },\n \"metadata\": {},\n \"status\": \"draft\",\n \"theme_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.inklink.com/api/v1/web/template")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"start_url\": \"<string>\",\n \"return_url\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"capture_type\": \"screenshot\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"description\": \"<string>\"\n }\n ],\n \"user_instruction\": \"<string>\",\n \"acceptance_guide\": \"<string>\",\n \"ai_instruction\": \"<string>\",\n \"login_methods\": [\n {\n \"provider\": \"<string>\",\n \"config\": {}\n }\n ],\n \"allowed_modes\": [],\n \"settings\": {\n \"show_acceptance_guide\": true,\n \"show_cover_page\": true\n },\n \"metadata\": {},\n \"status\": \"draft\",\n \"theme_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"key": "<string>",
"version": 123,
"is_latest": true,
"status": "draft",
"name": "<string>",
"description": "<string>",
"query": "<string>",
"fields": [
{
"name": "<string>",
"required": true,
"description": "<string>"
}
],
"user_instruction": "<string>",
"acceptance_guide": "<string>",
"start_url": "<string>",
"return_url": "<string>",
"capture_type": "screenshot",
"settings": {
"show_acceptance_guide": true,
"show_cover_page": true
},
"metadata": {},
"theme_id": "<string>",
"org_id": "<string>",
"created_by": "<string>",
"published_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}Web Inquiry
Create Web Template
Creates a new Web inquiry template. The server assigns a unique key (for example web_tpl_key_...); you cannot choose the key. Request bodies may use snake_case or camelCase. The public API requires non-empty query, start_url, and return_url. Optional status defaults to draft (draft or published). If acceptance_guide is empty but query is set, the server may generate a guide. If name is omitted, it may be derived from query. settings and metadata on PATCH (not this create) merge with existing; on create, values are set as given. For the draft → publish workflow, see Inquiry templates.
POST
/
web
/
template
Create Web template
curl --request POST \
--url https://platform.inklink.com/api/v1/web/template \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"query": "<string>",
"start_url": "<string>",
"return_url": "<string>",
"name": "<string>",
"description": "<string>",
"capture_type": "screenshot",
"fields": [
{
"name": "<string>",
"required": true,
"description": "<string>"
}
],
"user_instruction": "<string>",
"acceptance_guide": "<string>",
"ai_instruction": "<string>",
"login_methods": [
{
"provider": "<string>",
"config": {}
}
],
"allowed_modes": [],
"settings": {
"show_acceptance_guide": true,
"show_cover_page": true
},
"metadata": {},
"status": "draft",
"theme_id": "<string>"
}
'import requests
url = "https://platform.inklink.com/api/v1/web/template"
payload = {
"query": "<string>",
"start_url": "<string>",
"return_url": "<string>",
"name": "<string>",
"description": "<string>",
"capture_type": "screenshot",
"fields": [
{
"name": "<string>",
"required": True,
"description": "<string>"
}
],
"user_instruction": "<string>",
"acceptance_guide": "<string>",
"ai_instruction": "<string>",
"login_methods": [
{
"provider": "<string>",
"config": {}
}
],
"allowed_modes": [],
"settings": {
"show_acceptance_guide": True,
"show_cover_page": True
},
"metadata": {},
"status": "draft",
"theme_id": "<string>"
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
start_url: '<string>',
return_url: '<string>',
name: '<string>',
description: '<string>',
capture_type: 'screenshot',
fields: [{name: '<string>', required: true, description: '<string>'}],
user_instruction: '<string>',
acceptance_guide: '<string>',
ai_instruction: '<string>',
login_methods: [{provider: '<string>', config: {}}],
allowed_modes: [],
settings: {show_acceptance_guide: true, show_cover_page: true},
metadata: {},
status: 'draft',
theme_id: '<string>'
})
};
fetch('https://platform.inklink.com/api/v1/web/template', 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://platform.inklink.com/api/v1/web/template",
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([
'query' => '<string>',
'start_url' => '<string>',
'return_url' => '<string>',
'name' => '<string>',
'description' => '<string>',
'capture_type' => 'screenshot',
'fields' => [
[
'name' => '<string>',
'required' => true,
'description' => '<string>'
]
],
'user_instruction' => '<string>',
'acceptance_guide' => '<string>',
'ai_instruction' => '<string>',
'login_methods' => [
[
'provider' => '<string>',
'config' => [
]
]
],
'allowed_modes' => [
],
'settings' => [
'show_acceptance_guide' => true,
'show_cover_page' => true
],
'metadata' => [
],
'status' => 'draft',
'theme_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$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://platform.inklink.com/api/v1/web/template"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"start_url\": \"<string>\",\n \"return_url\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"capture_type\": \"screenshot\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"description\": \"<string>\"\n }\n ],\n \"user_instruction\": \"<string>\",\n \"acceptance_guide\": \"<string>\",\n \"ai_instruction\": \"<string>\",\n \"login_methods\": [\n {\n \"provider\": \"<string>\",\n \"config\": {}\n }\n ],\n \"allowed_modes\": [],\n \"settings\": {\n \"show_acceptance_guide\": true,\n \"show_cover_page\": true\n },\n \"metadata\": {},\n \"status\": \"draft\",\n \"theme_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
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://platform.inklink.com/api/v1/web/template")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"start_url\": \"<string>\",\n \"return_url\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"capture_type\": \"screenshot\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"description\": \"<string>\"\n }\n ],\n \"user_instruction\": \"<string>\",\n \"acceptance_guide\": \"<string>\",\n \"ai_instruction\": \"<string>\",\n \"login_methods\": [\n {\n \"provider\": \"<string>\",\n \"config\": {}\n }\n ],\n \"allowed_modes\": [],\n \"settings\": {\n \"show_acceptance_guide\": true,\n \"show_cover_page\": true\n },\n \"metadata\": {},\n \"status\": \"draft\",\n \"theme_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.inklink.com/api/v1/web/template")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"start_url\": \"<string>\",\n \"return_url\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"capture_type\": \"screenshot\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"description\": \"<string>\"\n }\n ],\n \"user_instruction\": \"<string>\",\n \"acceptance_guide\": \"<string>\",\n \"ai_instruction\": \"<string>\",\n \"login_methods\": [\n {\n \"provider\": \"<string>\",\n \"config\": {}\n }\n ],\n \"allowed_modes\": [],\n \"settings\": {\n \"show_acceptance_guide\": true,\n \"show_cover_page\": true\n },\n \"metadata\": {},\n \"status\": \"draft\",\n \"theme_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"key": "<string>",
"version": 123,
"is_latest": true,
"status": "draft",
"name": "<string>",
"description": "<string>",
"query": "<string>",
"fields": [
{
"name": "<string>",
"required": true,
"description": "<string>"
}
],
"user_instruction": "<string>",
"acceptance_guide": "<string>",
"start_url": "<string>",
"return_url": "<string>",
"capture_type": "screenshot",
"settings": {
"show_acceptance_guide": true,
"show_cover_page": true
},
"metadata": {},
"theme_id": "<string>",
"org_id": "<string>",
"created_by": "<string>",
"published_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}Headers
Example:
"secret_live_xxx"
Body
application/json
What the inquiry should establish (required, non-empty).
URL where the capture session starts (required, non-empty).
Redirect URL after capture (required, non-empty).
Display name; may be auto-generated from query if omitted.
Available options:
screenshot, document Fields to extract from evidence.
Show child attributes
Show child attributes
Not returned on GET responses; stored for processing.
Not returned on template GET responses; optional on create.
Show child attributes
Show child attributes
Not returned on template GET responses.
Available options:
manual, auto Show child attributes
Show child attributes
String key-value metadata.
Show child attributes
Show child attributes
Available options:
draft, published Must reference a theme that belongs to your org.
Response
Template created.
Web inquiry template row. Responses omit ai_instruction, login_methods, and allowed_modes even if set in the request body.
Row id (web_tpl_...).
Use as template_key on Create Web inquiry.
Available options:
draft, published Show child attributes
Show child attributes
Available options:
screenshot, document Show child attributes
Show child attributes
Show child attributes
Show child attributes