Form Fields Result Check - Datalab Documentation

GET

/

api

/

v1

/

form-fields

/

{request_id}

Form Fields Result Check

import requests

url = "https://www.datalab.to/api/v1/form-fields/{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/form-fields/{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/form-fields/{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>",
  "pages": [
    {
      "page": 123,
      "fields": [
        {
          "field_type": "<string>",
          "bbox": [
            123
          ],
          "label": ""
        }
      ],
      "error": ""
    }
  ],
  "page_count": 123,
  "total_cost": 123,
  "cost_breakdown": {},
  "runtime": 123,
  "versions": {}
}

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

Authorizations

X-API-Key

string

header

required

Path Parameters

request_id

string

required

Cookies

wos-session

string

datalab_active_team

string

Response

Successful Response

Response model for the form fields endpoint.

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 field detection was successful.

error

string | null

Error message if form field detection failed.

pages

FormFieldsPage · object[] | null

The fields found on each processed page.

Show child attributes

page_count

integer | null

Number of pages processed.

total_cost

number | null

cost_breakdown

Cost Breakdown · object | null

A dictionary of the cost breakdown of this request.

runtime

number | null

Processing time in seconds.

versions

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

Form Fields Result Check

import requests

url = "https://www.datalab.to/api/v1/form-fields/{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/form-fields/{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/form-fields/{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>",
  "pages": [
    {
      "page": 123,
      "fields": [
        {
          "field_type": "<string>",
          "bbox": [
            123
          ],
          "label": ""
        }
      ],
      "error": ""
    }
  ],
  "page_count": 123,
  "total_cost": 123,
  "cost_breakdown": {},
  "runtime": 123,
  "versions": {}
}

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