Create And Autofill Form
curl --request POST \
--url https://api.simplicity.ai/v1/forms/autofill \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"form_file_document_id": "<string>",
"source_document_ids": [
"<string>"
],
"instructions": "<string>",
"context": "<string>"
}
'import requests
url = "https://api.simplicity.ai/v1/forms/autofill"
payload = {
"form_file_document_id": "<string>",
"source_document_ids": ["<string>"],
"instructions": "<string>",
"context": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
form_file_document_id: '<string>',
source_document_ids: ['<string>'],
instructions: '<string>',
context: '<string>'
})
};
fetch('https://api.simplicity.ai/v1/forms/autofill', 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://api.simplicity.ai/v1/forms/autofill",
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([
'form_file_document_id' => '<string>',
'source_document_ids' => [
'<string>'
],
'instructions' => '<string>',
'context' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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://api.simplicity.ai/v1/forms/autofill"
payload := strings.NewReader("{\n \"form_file_document_id\": \"<string>\",\n \"source_document_ids\": [\n \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"context\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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://api.simplicity.ai/v1/forms/autofill")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"form_file_document_id\": \"<string>\",\n \"source_document_ids\": [\n \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"context\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simplicity.ai/v1/forms/autofill")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"form_file_document_id\": \"<string>\",\n \"source_document_ids\": [\n \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"context\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"task_id": "<string>",
"status": "processing"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Forms
Create And Autofill Form
Create a new form and automatically populate it with AI-extracted data. Pass the document_id of the uploaded form along with either a context (background information), instructions (explicit filling rules), or source_document_ids (IDs of previously uploaded documents the AI will extract data from to fill the form).
POST
/
v1
/
forms
/
autofill
Create And Autofill Form
curl --request POST \
--url https://api.simplicity.ai/v1/forms/autofill \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"form_file_document_id": "<string>",
"source_document_ids": [
"<string>"
],
"instructions": "<string>",
"context": "<string>"
}
'import requests
url = "https://api.simplicity.ai/v1/forms/autofill"
payload = {
"form_file_document_id": "<string>",
"source_document_ids": ["<string>"],
"instructions": "<string>",
"context": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
form_file_document_id: '<string>',
source_document_ids: ['<string>'],
instructions: '<string>',
context: '<string>'
})
};
fetch('https://api.simplicity.ai/v1/forms/autofill', 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://api.simplicity.ai/v1/forms/autofill",
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([
'form_file_document_id' => '<string>',
'source_document_ids' => [
'<string>'
],
'instructions' => '<string>',
'context' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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://api.simplicity.ai/v1/forms/autofill"
payload := strings.NewReader("{\n \"form_file_document_id\": \"<string>\",\n \"source_document_ids\": [\n \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"context\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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://api.simplicity.ai/v1/forms/autofill")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"form_file_document_id\": \"<string>\",\n \"source_document_ids\": [\n \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"context\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simplicity.ai/v1/forms/autofill")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"form_file_document_id\": \"<string>\",\n \"source_document_ids\": [\n \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"context\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"task_id": "<string>",
"status": "processing"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Request body for creating and autofilling a form from a PDF with source documents.
The document ID of the PDF form to fill
Array of document IDs containing data to extract
Optional instructions to guide the AI filling process
Optional text content to be used as context for filling the form using AI/LLM
⌘I