Form Filling Result Check - Datalab Documentation

GET

/

api

/

v1

/

fill

/

{request_id}

Form Filling Result Check

import requests

url = "https://www.datalab.to/api/v1/fill/{request_id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://www.datalab.to/api/v1/fill/{request_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.datalab.to/api/v1/fill/{request_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "status": "<string>",
  "result_url": "<string>",
  "expires_in": 123,
  "success": true,
  "error": "<string>",
  "output_format": "<string>",
  "output_base64": "<string>",
  "fields_filled": [
    "<string>"
  ],
  "fields_not_found": [
    "<string>"
  ],
  "runtime": 123,
  "page_count": 123,
  "cost_breakdown": {},
  "versions": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Path Parameters

request_id

string

required

Cookies

wos-session

string

datalab_active_team

string

Response

Successful Response

status

string

required

The status of the request. Should be 'complete' when the request is done.

result_url

string | null

Signed URL for downloading the completed result JSON when direct result download is required.

expires_in

integer | null

Number of seconds until result_url expires.

success

boolean | null

Whether form filling succeeded.

error

string | null

Error message if form filling failed.

output_format

string | null

Output format: 'pdf' or 'png'.

output_base64

string | null

Base64-encoded filled form (PDF or PNG).

fields_filled

string[] | null

List of field keys that were successfully filled.

fields_not_found

string[] | null

List of field keys that couldn't be matched to form fields.

runtime

number | null

Processing time in seconds.

page_count

integer | null

Number of pages processed.

cost_breakdown

Cost Breakdown · object | null

A dictionary of the cost breakdown of this request.

versions

A dictionary of the versions of the libraries used in the request.

Form Filling Result Check

import requests

url = "https://www.datalab.to/api/v1/fill/{request_id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://www.datalab.to/api/v1/fill/{request_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.datalab.to/api/v1/fill/{request_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "status": "<string>",
  "result_url": "<string>",
  "expires_in": 123,
  "success": true,
  "error": "<string>",
  "output_format": "<string>",
  "output_base64": "<string>",
  "fields_filled": [
    "<string>"
  ],
  "fields_not_found": [
    "<string>"
  ],
  "runtime": 123,
  "page_count": 123,
  "cost_breakdown": {},
  "versions": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}