Skip to main content
POST
/
envelope
Create Envelope
curl --request POST \
  --url https://hub.inklink.com/api/v1/envelope \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data @- <<EOF
{
  "name": "LinkedIn Account Information",
  "description": "This envelope is used to capture the user's LinkedIn account information",
  "query": "Capture all information about the user's experience, skills, education, account information on LinkedIn",
  "acceptance_guide": "To earn a high acceptance score, navigate to the LinkedIn account information page and capture the information"
}
EOF
{
  "envelope_id": "iq_xxx",
  "envelope_url": "https://hub.inklink.com/capture/iq_xxx"
}

Headers

​
x-api-key
string
required
Example:

"secret_xxx"

Body

application/json
​
name
string
required

The name of the envelope

Example:

"LinkedIn Account Information"

​
query
string
required

What do you want to know from this envelope

Example:

"Capture all information about the user's experience, skills, education, account information on LinkedIn"

​
return_url
string
required

The URL to redirect the user to after they complete the process

Example:

"https://your-app.com/capture-complete?your-ref-id=xxx"

​
template_id
string

If provided, the envelope will be created using the template. The only required other field is return_url.

Example:

"env_tpl_xxx"

​
description
string

The description of the envelope

Example:

"This envelope is used to capture the user's LinkedIn account information"

​
acceptance_guide
string

The acceptance guide of the envelope

Example:

"To earn a high acceptance score, navigate to the LinkedIn account information page and capture the information"

​
show_acceptance_guide
boolean

Whether to show the acceptance guide to the user

Example:

true

​
redirect_url
string
default:https://duckduckgo.com

The URL the user will be redirected when they start the process

Example:

"https://www.linkedin.com/login"

​
ai_instruction
string

The additional instructions given to the AI at this step

Example:

"Capture all the information about the user's experience, skills, education, account information on LinkedIn"

​
fields
object[]
​
steps
object[]

Response

200 - application/json

Successfully created envelope. Response includes envelope_id, envelope_url, and other fields from the request body

​
envelope_id
string
Example:

"iq_xxx"

​
envelope_url
string
Example:

"https://hub.inklink.com/capture/iq_xxx"