Skip to main content
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": {}
}
'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.inklink.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
api-key
string
required
Example:

"secret_live_xxx"

Body

application/json
​
subject_id
string
required

Your stable identifier for the subject.

Example:

"user_123"

​
return_url
string<uri>

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.

​
template_key
string

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.

​
name
string

Inquiry name. Required when template_key is not provided.

​
description
string

Inquiry description.

​
query
string

What you want to know from this inquiry. Required when template_key is not provided.

​
fields
object[]

Fields to extract from the captured evidence. Required when template_key is not provided.

​
start_url
string<uri>

URL the user is sent to when the capture session starts.

​
acceptance_guide
string

Instructions for earning a high acceptance score.

​
show_acceptance_guide
boolean
default:false

Whether to show the acceptance guide to the user.

​
ai_instruction
string

Additional instructions for AI processing.

​
capture_type
enum<string>
default:screenshot

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
​
metadata
object

Arbitrary key-value metadata attached to the inquiry.

Response

201 - application/json

Inquiry created.

​
id
string

Web inquiry id (web_iq_...).

Example:

"web_iq_xxxxxxxxxxxxxxxx"

​
subject_id
string

Your stable identifier for the subject (echoed from the create request).

Example:

"user_123"

​
template_id
string | null

Resolved template id when the inquiry was created from a template.

Example:

"web_tpl_xxxxxxxxxxxxxxxx"

​
template_key
string | null

Template key when the inquiry was created from a template.

Example:

"web_tpl_key_xxxxxxxxxxxxxxxx"

​
template_version
integer

Template version used when resolving configuration.

Example:

1

​
status
enum<string>
Available options:
active,
expired,
cancelled,
completed
​
name
string

Display name of the inquiry.

​
description
string

Inquiry description.

​
query
string

What the inquiry is trying to establish from captured evidence.

​
fields
object[]

Configured extraction fields.

​
acceptance_guide
string

Markdown acceptance guide shown or used for scoring.

​
start_url
string<uri>

URL the user is sent to when the capture session starts.

​
return_url
string<uri>

URL where the user is redirected after the hosted capture flow completes.

​
capture_type
enum<string>

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
​
max_retries
integer

Maximum capture or processing retries allowed for this inquiry.

​
metadata
object

Arbitrary metadata attached to the inquiry.

​
expires_at
string<date-time>
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
deleted_at
string<date-time> | null

Present when the inquiry has been soft-deleted.