Create Web inquiry
curl --request POST \
--url https://platform.inklink.com/api/v1/web/inquiry \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"subject_id": "user_123",
"return_url": "<string>",
"template_key": "<string>",
"name": "<string>",
"description": "<string>",
"query": "<string>",
"fields": [
{
"name": "user_full_name",
"description": "The full name of the user"
}
],
"start_url": "<string>",
"acceptance_guide": "<string>",
"show_acceptance_guide": false,
"ai_instruction": "<string>",
"capture_type": "screenshot",
"metadata": {}
}
'import requests
url = "https://platform.inklink.com/api/v1/web/inquiry"
payload = {
"subject_id": "user_123",
"return_url": "<string>",
"template_key": "<string>",
"name": "<string>",
"description": "<string>",
"query": "<string>",
"fields": [
{
"name": "user_full_name",
"description": "The full name of the user"
}
],
"start_url": "<string>",
"acceptance_guide": "<string>",
"show_acceptance_guide": False,
"ai_instruction": "<string>",
"capture_type": "screenshot",
"metadata": {}
}
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({
subject_id: 'user_123',
return_url: '<string>',
template_key: '<string>',
name: '<string>',
description: '<string>',
query: '<string>',
fields: [{name: 'user_full_name', description: 'The full name of the user'}],
start_url: '<string>',
acceptance_guide: '<string>',
show_acceptance_guide: false,
ai_instruction: '<string>',
capture_type: 'screenshot',
metadata: {}
})
};
fetch('https://platform.inklink.com/api/v1/web/inquiry', 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/inquiry",
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([
'subject_id' => 'user_123',
'return_url' => '<string>',
'template_key' => '<string>',
'name' => '<string>',
'description' => '<string>',
'query' => '<string>',
'fields' => [
[
'name' => 'user_full_name',
'description' => 'The full name of the user'
]
],
'start_url' => '<string>',
'acceptance_guide' => '<string>',
'show_acceptance_guide' => false,
'ai_instruction' => '<string>',
'capture_type' => 'screenshot',
'metadata' => [
]
]),
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/inquiry"
payload := strings.NewReader("{\n \"subject_id\": \"user_123\",\n \"return_url\": \"<string>\",\n \"template_key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"user_full_name\",\n \"description\": \"The full name of the user\"\n }\n ],\n \"start_url\": \"<string>\",\n \"acceptance_guide\": \"<string>\",\n \"show_acceptance_guide\": false,\n \"ai_instruction\": \"<string>\",\n \"capture_type\": \"screenshot\",\n \"metadata\": {}\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/inquiry")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"subject_id\": \"user_123\",\n \"return_url\": \"<string>\",\n \"template_key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"user_full_name\",\n \"description\": \"The full name of the user\"\n }\n ],\n \"start_url\": \"<string>\",\n \"acceptance_guide\": \"<string>\",\n \"show_acceptance_guide\": false,\n \"ai_instruction\": \"<string>\",\n \"capture_type\": \"screenshot\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.inklink.com/api/v1/web/inquiry")
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 \"subject_id\": \"user_123\",\n \"return_url\": \"<string>\",\n \"template_key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"user_full_name\",\n \"description\": \"The full name of the user\"\n }\n ],\n \"start_url\": \"<string>\",\n \"acceptance_guide\": \"<string>\",\n \"show_acceptance_guide\": false,\n \"ai_instruction\": \"<string>\",\n \"capture_type\": \"screenshot\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "web_iq_xxxxxxxxxxxxxxxx",
"template_id": "web_tpl_xxxxxxxxxxxxxxxx",
"template_key": "web_tpl_key_xxxxxxxxxxxxxxxx",
"template_version": 1,
"status": "active",
"name": "Example awareness campaign inquiry",
"description": "",
"query": "Example question the inquiry should resolve from captured browsing.",
"fields": [],
"acceptance_guide": "## High Acceptance\n\n* Visit an official or primary source page that matches the inquiry topic; capture the section that states the program goals.\n\n---\n\n## Medium Acceptance\n\n* Use a well-known reference article that summarizes the topic; capture the lead paragraph.\n\n---\n\n## Low Acceptance\n\n* Capture a public social post that mentions the topic in passing.\n",
"start_url": "https://example.com/topics/example-topic",
"return_url": "https://your-app.com/web/inquiry-complete",
"capture_type": "screenshot",
"max_retries": 3,
"metadata": null,
"expires_at": "2026-01-20T12:00:00.000Z",
"created_at": "2026-01-15T10:00:00.000Z",
"updated_at": "2026-01-15T10:00:00.000Z",
"deleted_at": null,
"subject_id": "user_123"
}Web Inquiry
Create Web Inquiry
Creates a Web inquiry. With template_key, only subject_id is required; the inquiry inherits configuration from the template, including return_url, unless you override fields in the request. Without template_key, you must supply the full inquiry configuration (including return_url). Redirect the end user to https://platform.inklink.com/capture/<id> using the id from this response as the trailing path segment. When the hosted flow finishes, the user is returned to the configured return URL with the outcome in the query string (status and inquiry_id). Use GET /web/inquiry to list inquiries for your organization (paginated, with nested result per row). For full inquiry detail for one id from your server (configuration, nested result, sessions, and evidence), use GET /web/inquiry/{id}. See Web Inquiry Quickstart for the full flow.
POST
/
web
/
inquiry
Create Web inquiry
curl --request POST \
--url https://platform.inklink.com/api/v1/web/inquiry \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"subject_id": "user_123",
"return_url": "<string>",
"template_key": "<string>",
"name": "<string>",
"description": "<string>",
"query": "<string>",
"fields": [
{
"name": "user_full_name",
"description": "The full name of the user"
}
],
"start_url": "<string>",
"acceptance_guide": "<string>",
"show_acceptance_guide": false,
"ai_instruction": "<string>",
"capture_type": "screenshot",
"metadata": {}
}
'import requests
url = "https://platform.inklink.com/api/v1/web/inquiry"
payload = {
"subject_id": "user_123",
"return_url": "<string>",
"template_key": "<string>",
"name": "<string>",
"description": "<string>",
"query": "<string>",
"fields": [
{
"name": "user_full_name",
"description": "The full name of the user"
}
],
"start_url": "<string>",
"acceptance_guide": "<string>",
"show_acceptance_guide": False,
"ai_instruction": "<string>",
"capture_type": "screenshot",
"metadata": {}
}
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({
subject_id: 'user_123',
return_url: '<string>',
template_key: '<string>',
name: '<string>',
description: '<string>',
query: '<string>',
fields: [{name: 'user_full_name', description: 'The full name of the user'}],
start_url: '<string>',
acceptance_guide: '<string>',
show_acceptance_guide: false,
ai_instruction: '<string>',
capture_type: 'screenshot',
metadata: {}
})
};
fetch('https://platform.inklink.com/api/v1/web/inquiry', 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/inquiry",
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([
'subject_id' => 'user_123',
'return_url' => '<string>',
'template_key' => '<string>',
'name' => '<string>',
'description' => '<string>',
'query' => '<string>',
'fields' => [
[
'name' => 'user_full_name',
'description' => 'The full name of the user'
]
],
'start_url' => '<string>',
'acceptance_guide' => '<string>',
'show_acceptance_guide' => false,
'ai_instruction' => '<string>',
'capture_type' => 'screenshot',
'metadata' => [
]
]),
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/inquiry"
payload := strings.NewReader("{\n \"subject_id\": \"user_123\",\n \"return_url\": \"<string>\",\n \"template_key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"user_full_name\",\n \"description\": \"The full name of the user\"\n }\n ],\n \"start_url\": \"<string>\",\n \"acceptance_guide\": \"<string>\",\n \"show_acceptance_guide\": false,\n \"ai_instruction\": \"<string>\",\n \"capture_type\": \"screenshot\",\n \"metadata\": {}\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/inquiry")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"subject_id\": \"user_123\",\n \"return_url\": \"<string>\",\n \"template_key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"user_full_name\",\n \"description\": \"The full name of the user\"\n }\n ],\n \"start_url\": \"<string>\",\n \"acceptance_guide\": \"<string>\",\n \"show_acceptance_guide\": false,\n \"ai_instruction\": \"<string>\",\n \"capture_type\": \"screenshot\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.inklink.com/api/v1/web/inquiry")
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 \"subject_id\": \"user_123\",\n \"return_url\": \"<string>\",\n \"template_key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"user_full_name\",\n \"description\": \"The full name of the user\"\n }\n ],\n \"start_url\": \"<string>\",\n \"acceptance_guide\": \"<string>\",\n \"show_acceptance_guide\": false,\n \"ai_instruction\": \"<string>\",\n \"capture_type\": \"screenshot\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "web_iq_xxxxxxxxxxxxxxxx",
"template_id": "web_tpl_xxxxxxxxxxxxxxxx",
"template_key": "web_tpl_key_xxxxxxxxxxxxxxxx",
"template_version": 1,
"status": "active",
"name": "Example awareness campaign inquiry",
"description": "",
"query": "Example question the inquiry should resolve from captured browsing.",
"fields": [],
"acceptance_guide": "## High Acceptance\n\n* Visit an official or primary source page that matches the inquiry topic; capture the section that states the program goals.\n\n---\n\n## Medium Acceptance\n\n* Use a well-known reference article that summarizes the topic; capture the lead paragraph.\n\n---\n\n## Low Acceptance\n\n* Capture a public social post that mentions the topic in passing.\n",
"start_url": "https://example.com/topics/example-topic",
"return_url": "https://your-app.com/web/inquiry-complete",
"capture_type": "screenshot",
"max_retries": 3,
"metadata": null,
"expires_at": "2026-01-20T12:00:00.000Z",
"created_at": "2026-01-15T10:00:00.000Z",
"updated_at": "2026-01-15T10:00:00.000Z",
"deleted_at": null,
"subject_id": "user_123"
}Headers
Example:
"secret_live_xxx"
Body
application/json
Your stable identifier for the subject.
Example:
"user_123"
URL where the user is redirected after the hosted capture flow completes. When template_key is provided, omit this to use the template's return_url, or pass it to override. Required when template_key is not provided.
Key of a published template. When provided, only subject_id is required; the inquiry inherits configuration from the template (including return_url). Any field may be provided as an override.
Inquiry name. Required when template_key is not provided.
Inquiry description.
What you want to know from this inquiry. Required when template_key is not provided.
Fields to extract from the captured evidence. Required when template_key is not provided.
Show child attributes
Show child attributes
URL the user is sent to when the capture session starts.
Instructions for earning a high acceptance score.
Whether to show the acceptance guide to the user.
Additional instructions for AI processing.
How evidence is captured. screenshot uses a viewport capture; document uses files obtained from the site (for example PDF and other supported formats), not limited to PDF.
Available options:
screenshot, document Arbitrary key-value metadata attached to the inquiry.
Show child attributes
Show child attributes
Response
201 - application/json
Inquiry created.
Web inquiry id (web_iq_...).
Example:
"web_iq_xxxxxxxxxxxxxxxx"
Your stable identifier for the subject (echoed from the create request).
Example:
"user_123"
Resolved template id when the inquiry was created from a template.
Example:
"web_tpl_xxxxxxxxxxxxxxxx"
Template key when the inquiry was created from a template.
Example:
"web_tpl_key_xxxxxxxxxxxxxxxx"
Template version used when resolving configuration.
Example:
1
Available options:
active, expired, cancelled, completed Display name of the inquiry.
Inquiry description.
What the inquiry is trying to establish from captured evidence.
Configured extraction fields.
Show child attributes
Show child attributes
Markdown acceptance guide shown or used for scoring.
URL the user is sent to when the capture session starts.
URL where the user is redirected after the hosted capture flow completes.
How evidence is captured. screenshot uses a viewport capture; document uses files obtained from the site (for example PDF and other supported formats), not limited to PDF.
Available options:
screenshot, document Maximum capture or processing retries allowed for this inquiry.
Arbitrary metadata attached to the inquiry.
Show child attributes
Show child attributes
Present when the inquiry has been soft-deleted.