POST
/
v1
/
automations
/
links
curl --request POST \
  --url https://api.uiform.com/v1/automations/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "object": "link",
  "id": "<string>",
  "name": "<string>",
  "password": "<string>",
  "webhook_url": "<string>",
  "webhook_headers": {},
  "updated_at": "2023-11-07T05:31:56Z",
  "modality": "text",
  "image_settings": {
    "correct_image_orientation": true,
    "dpi": 72,
    "image_to_text": "ocr",
    "browser_canvas": "A4"
  },
  "model": "<string>",
  "json_schema": {},
  "temperature": 0
}'
{
  "object": "link",
  "id": "<string>",
  "name": "<string>",
  "password": "<string>",
  "webhook_url": "<string>",
  "webhook_headers": {},
  "updated_at": "2023-11-07T05:31:56Z",
  "modality": "text",
  "image_settings": {
    "correct_image_orientation": true,
    "dpi": 72,
    "image_to_text": "ocr",
    "browser_canvas": "A4"
  },
  "model": "<string>",
  "json_schema": {},
  "temperature": 0,
  "schema_data_id": "<string>",
  "schema_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Name of the link

​
webhook_url
string
required

Url of the webhook to send the data to

Required string length: 1 - 2083
​
modality
enum<string>
required
Available options:
text,
image,
native,
image+text
​
model
string
required

Model used for chat completion

​
json_schema
object
required

JSON schema format used to validate the output data.

​
object
string
default:
link
Allowed value: "link"
​
id
string

Unique identifier for the extraction link

​
password
string | null

Password to access the link

​
webhook_headers
object

Headers to send with the request

​
updated_at
string
​
image_settings
object

Preprocessing operations applied to image before sending them to the llm

​
temperature
number
default:
0

Temperature for sampling. If not provided, the default temperature for the model will be used.

Response

200
application/json
Successful Response
​
name
string
required

Name of the link

​
webhook_url
string
required

Url of the webhook to send the data to

Required string length: 1 - 2083
​
modality
enum<string>
required
Available options:
text,
image,
native,
image+text
​
model
string
required

Model used for chat completion

​
json_schema
object
required

JSON schema format used to validate the output data.

​
schema_data_id
string
required

Returns the SHA1 hash of the schema data, ignoring all prompt/description/default fields.

Returns: str: A SHA1 hash string representing the schema data version.

​
schema_id
string
required

Returns the SHA1 hash of the complete schema.

Returns: str: A SHA1 hash string representing the complete schema version.

​
object
string
default:
link
Allowed value: "link"
​
id
string

Unique identifier for the extraction link

​
password
string | null

Password to access the link

​
webhook_headers
object

Headers to send with the request

​
updated_at
string
​
image_settings
object

Preprocessing operations applied to image before sending them to the llm

​
temperature
number
default:
0

Temperature for sampling. If not provided, the default temperature for the model will be used.

Models/ListList