List form fields
POST
/v1/pdf/forms/fields
curl -H "X-Api-Key: $KEY" -F files=@form.pdf \ http://localhost:9027/v1/pdf/forms/fieldsimport { openAsBlob } from 'node:fs';
const form = new FormData();form.append('files', await openAsBlob('form.pdf'), 'form.pdf');
const response = await fetch('http://localhost:9027/v1/pdf/forms/fields', { method: 'POST', headers: { 'X-Api-Key': process.env.KEY }, body: form,});if (!response.ok) throw new Error(await response.text());console.log(await response.json());import os
import requests
response = requests.post( "http://localhost:9027/v1/pdf/forms/fields", headers={"X-Api-Key": os.environ["KEY"]}, files=[("files", open("form.pdf", "rb"))],)response.raise_for_status()print(response.json())package main
import ( "bytes" "io" "log" "mime/multipart" "net/http" "os" "path/filepath")
func main() { var body bytes.Buffer form := multipart.NewWriter(&body) attach(form, "files", "form.pdf") form.Close()
request, err := http.NewRequest("POST", "http://localhost:9027/v1/pdf/forms/fields", &body) if err != nil { log.Fatal(err) } request.Header.Set("X-Api-Key", os.Getenv("KEY")) request.Header.Set("Content-Type", form.FormDataContentType())
response, err := http.DefaultClient.Do(request) if err != nil { log.Fatal(err) } defer response.Body.Close() if response.StatusCode >= 300 { message, _ := io.ReadAll(response.Body) log.Fatalf("%s: %s", response.Status, message) } if _, err := io.Copy(os.Stdout, response.Body); err != nil { log.Fatal(err) }}
// attach adds the file at path to the form as the named field.func attach(form *multipart.Writer, field, path string) { file, err := os.Open(path) if err != nil { log.Fatal(err) } defer file.Close() part, err := form.CreateFormFile(field, filepath.Base(path)) if err != nil { log.Fatal(err) } if _, err := io.Copy(part, file); err != nil { log.Fatal(err) }}Lists a PDF’s form fields with their kinds, pages and values.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typemultipart/form-data
object
files
required
The PDF whose form fields to list.
string format: binary
Responses
Section titled “Responses”The form fields
Media typeapplication/json
Array<object>
One form field, as /v1/pdf/forms/fields lists them.
object
kind
required
text, checkbox, radio, choice, signature or button.
string
name
required
Fully qualified name, such as customer.name.
string
options
required
Array<string>
page
required
1-based page of the first widget.
integer format: int32
value
string | null
Example generated
[ { "kind": "example", "name": "example", "options": [ "example" ], "page": 1, "value": "example" }]The request is wrong
Media typeapplication/json
The JSON body of every error response.
object
error
required
A stable, machine-readable kind.
string
message
required
What went wrong, for a person.
string
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}Not supported in this version
Media typeapplication/json
The JSON body of every error response.
object
error
required
A stable, machine-readable kind.
string
message
required
What went wrong, for a person.
string
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}