Fill Forms

POST

generations

Fill Forms

curl --request POST \
  --url https://api.gonitro.dev/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form method=fill-forms \
  --form 'params={
  "strict": true,
  "fields": [
    {
      "field": "firstName",
      "value": "Jane"
    },
    {
      "field": "lastName",
      "value": "Doe"
    }
  ]
}' \
  --form file='@example-file' \
  --form files.items='@example-file'

import requests

url = "https://api.gonitro.dev/generations"

files = {
    "file": ("example-file", open("example-file", "rb")),
    "files.items": ("example-file", open("example-file", "rb"))
}
payload = {
    "method": "fill-forms",
    "params": "{
  \"strict\": true,
  \"fields\": [
    {
      \"field\": \"firstName\",
      \"value\": \"Jane\"
    },
    {
      \"field\": \"lastName\",
      \"value\": \"Doe\"
    }
  ]
}"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('method', 'fill-forms');
form.append('params', '{
  "strict": true,
  "fields": [
    {
      "field": "firstName",
      "value": "Jane"
    },
    {
      "field": "lastName",
      "value": "Doe"
    }
  ]
}');
form.append('file', '{
  "fileName": "example-file"
}');
form.append('files.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.gonitro.dev/generations', 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.gonitro.dev/generations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"method\"\r\n\r\nfill-forms\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"params\"\r\n\r\n{\r\n  \"strict\": true,\r\n  \"fields\": [\r\n    {\r\n      \"field\": \"firstName\",\r\n      \"value\": \"Jane\"\r\n    },\r\n    {\r\n      \"field\": \"lastName\",\r\n      \"value\": \"Doe\"\r\n    }\r\n  ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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.gonitro.dev/generations"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"method\"\r\n\r\nfill-forms\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"params\"\r\n\r\n{\r\n  \"strict\": true,\r\n  \"fields\": [\r\n    {\r\n      \"field\": \"firstName\",\r\n      \"value\": \"Jane\"\r\n    },\r\n    {\r\n      \"field\": \"lastName\",\r\n      \"value\": \"Doe\"\r\n    }\r\n  ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	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.gonitro.dev/generations")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"method\"\r\n\r\nfill-forms\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"params\"\r\n\r\n{\r\n  \"strict\": true,\r\n  \"fields\": [\r\n    {\r\n      \"field\": \"firstName\",\r\n      \"value\": \"Jane\"\r\n    },\r\n    {\r\n      \"field\": \"lastName\",\r\n      \"value\": \"Doe\"\r\n    }\r\n  ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gonitro.dev/generations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"method\"\r\n\r\nfill-forms\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"params\"\r\n\r\n{\r\n  \"strict\": true,\r\n  \"fields\": [\r\n    {\r\n      \"field\": \"firstName\",\r\n      \"value\": \"Jane\"\r\n    },\r\n    {\r\n      \"field\": \"lastName\",\r\n      \"value\": \"Doe\"\r\n    }\r\n  ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "file": {
    "URL": "<string>",
    "contentType": "application/json",
    "metadata": {
      "fileSizeBytes": 123,
      "pageCount": 123
    }
  }
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#400-bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Request validation failed",
  "instance": "/platform/generations"
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#401-unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Missing or invalid Authorization header",
  "instance": "/platform/generations"
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#404-not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "Resource not found",
  "instance": "/platform/generations"
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#413-content-too-large",
  "title": "Content too large",
  "status": 413,
  "detail": "Uploaded document exceeds the file size limit",
  "instance": "/platform/generations"
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#415-unsupported-media-type",
  "title": "Unsupported Media Type",
  "status": 415,
  "detail": "The provided media type is not supported",
  "instance": "/platform/generations"
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#422-unprocessable-entity",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "The request was well-formed but could not be processed",
  "instance": "/platform/generations"
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#500-internal-server-error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected error occurred",
  "instance": "/platform/generations"
}

Parameters

string

A JSON-encoded array of { "field": "<name>", "value": <value> } objects. Each field must match the field name as it appears in the PDF template. Omit or pass null to read values from the attached data file instead. If no data file is provided and this field is empty, a 422 error is raised.Example

[
  {"field": "first_name", "value": "Jane"},
  {"field": "last_name", "value": "Doe"},
  {"field": "is_active", "value": "yes"}
]

boolean

default:"false"

When true, the request fails if any supplied field name does not match a field present in the PDF. When false (default), unrecognised field names are silently ignored and the remaining fields are still filled.

Strict mode

By default, extra field names in your payload are discarded without error. Enable strict when you want a hard guarantee that every key you supply maps to a real form field — useful for catching typos or schema drift between your data source and the PDF template.

File Upload

There are two ways to provide form field values:

Inline form fields (using `params`):

Pass the PDF document via the file parameter, and provide field values directly in the fields array within params:

curl --request POST \
  --url https://api.gonitro.dev/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Accept: application/json' \
  --form method=fill-forms \
  --form 'params={"strict": false, "fields": [{"field": "first_name", "value": "Jane"}, {"field": "last_name", "value": "Doe"}]}' \
  --form 'file=@document.pdf;type=application/pdf'

Data file (using `files[0]` and `files[1]`):

Pass the PDF as files[0] and the data file as files[1]. The data file can be CSV, JSON, XFDF, or FDF format. Fill Forms accepts up to 25 input files per request, and their combined size must not exceed the 100 MB per-request limit.

curl --request POST \
  --url https://api.gonitro.dev/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Accept: application/json' \
  --form method=fill-forms \
  --form 'params={"strict": false}' \
  --form 'files[0]=@document.pdf;type=application/pdf' \
  --form 'files[1]=@form.csv;type=text/csv'

Fill a PDF form by supplying field values against a form template. The endpoint maps the provided field data onto the template’s form fields and returns a flattened PDF with the fields populated.

Supported data file formats

The files[1] data file must be sent with one of the following content types:

Format	Content type
CSV	`text/csv`
JSON	`application/json`
XFDF	`application/vnd.adobe.xfdf`
FDF	`application/vnd.fdf`

The data file must use one of the four content types above. Other content types (including application/octet-stream and text/plain) are rejected with a 415 error.

The formats are equivalent — each maps form field names to the values to set. The following all fill the same fields: CSV example:

first_name,last_name,is_active
Jane,Doe,yes

JSON example:

[
  {"field": "first_name", "value": "Jane"},
  {"field": "last_name", "value": "Doe"},
  {"field": "is_active", "value": "yes"}
]

XFDF example:

<?xml version="1.0" encoding="UTF-8"?>
<xfdf xmlns="http://ns.adobe.com/xfdf/">
  <fields>
    <field name="first_name"><value>Jane</value></field>
    <field name="last_name"><value>Doe</value></field>
    <field name="is_active"><value>yes</value></field>
  </fields>
</xfdf>

FDF example:

%FDF-1.2
1 0 obj
<< /FDF << /Fields [
<< /T (first_name) /V (Jane) >>
<< /T (last_name) /V (Doe) >>
<< /T (is_active) /V (yes) >>
] >> >>
endobj
trailer
<< /Root 1 0 R >>
%%EOF

The field names must match the respective AcroForms names. Recognized checkbox values are: true, yes, 1, x (case insensitive). All values are stringified (e.g. {"age": 27} is interpreted as {"age": "27"}).

Output File Format

The endpoint can return output either as JSON or as a binary file. The format depends on the Accept header (details below), which defaults to application/json.

Processing

When requesting JSON, you can run the operation synchronously or asynchronously. This is determined by the Prefer header (details below).

In sync mode, the response includes a URL pointing to the processed file.
In async mode, the request creates a Job, and the response contains the Job ID and status so you can track progress.

Binary (octet-stream) responses are only available for synchronous operations.

Custom File Delivery

The endpoint supports custom file-delivery destinations through the optional delivery parameter. You can provide an upload target, such as your own PUT endpoint or a pre-signed S3 URL, and Nitro will upload the resulting file there. This works for both synchronous and asynchronous processing.

Sync delivery
In synchronous calls, the delivery parameter lets you direct Nitro to upload the output file to a custom URL endpoint or a pre-signed URL (e.g S3), by providing an upload url in the uploadResultTo or uploadResultsTo properties.

Custom endpoint

If implementing the upload endpoint by yourself, make sure your code or middleware configuration accepts requests without content-type headers.

S3 delivery
If you are using S3 to manage delivery uploads, follow this AWS documentation to generate a pre-signed PUT URL.
If using the AWS provided Python script, omit the Content-Type in Params to get the pre-signed url. For example:
url = generate_presigned_url( s3_client, "put_object", { "Bucket": args.bucket, "Key": args.key, # Content-Type: "application/octet-stream" => Omit! }, 1000)
Async delivery
In asynchronous flows, you can also provide a custom URL or pre-signed S3 object via uploadResultTo or uploadResultsTo, to upload your file(s) once the Job is done processing.

Callback
For asynchronous processing, you can also include a callback URL within the delivery parameter. This callback is a POST endpoint that Nitro will call once the Job is created and running, providing details about the file-processing job. Example of Nitro’s callback request body:
{ "jobID": "babe2aa7-9b5d-4eb2-a679-5fc12cf0a490", "location": "https://api.gonitro.dev/jobs/babe2aa7-9b5d-4eb2-a679-5fc12cf0a490" }

Response behavior Matrix

This matrix shows the expected response behavior based on content type, sync/async mode, and custom file-delivery settings.

	JSON (`application/json`)	Binary (`application/octet-stream`)
Synchronous	Returns a JSON object with a file(s) URL(s).	Returns the processed file directly as binary.
Asynchronous (`respond-async`)	Returns a JSON object with a Job ID and status.	Async preference ignored, returns sync binary.
Synchronous delivery	File delivered to custom endpoint / Bucket, returns success confirmation.	N/A
Asynchronous delivery	Returns a JSON object with a Job ID and status. The file(s) will be uploaded to the provided PUT endpoint / S3 Bucket at the end of process. If `callback` url is provided, Nitro will notify the endpoint with a JOB ID and location.	N/A

Limits

The Platform API has the following limits:

File size: Maximum of 100 MB per request for direct uploads and synchronous requests; asynchronous requests with remote-file (URL) input allow up to 300 MB. This applies to single-file and multi-file requests (multi-file requests are limited by their combined size). Some operations allow more — Merge accepts up to 1.5 GB for asynchronous remote-file input.
Page count: Maximum of 500 pages per individual document, or 2500 pages for asynchronous requests with remote-file (URL) input. This applies to single-file and multi-file requests. Multiple documents may exceed the page limit in total.
Retention time: Inputs and outputs are deleted approximately 15 minutes after the operation completes.

Request

Authorizations

Authorization

string

header

required

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

Headers

enum<string>

default:*/*

Controls response format and behavior. See endpoint description above for detailed response combinations.

application/json: Returns JSON response with operation result
application/octet-stream: Returns binary file content
*/*: Defaults to JSON response

Available options:

application/json,

application/octet-stream,

*/*

Prefer

enum<string>

Controls synchronous vs asynchronous operation. See endpoint description above for behavior details.

respond-async: Makes request asynchronous, returns job status for polling
No value: Synchronous response

Available options:

respond-async

Body

multipart/form-data

method

enum<string>

default:fill-forms

required

The Generations' endpoint method: fill-forms

Available options:

fill-forms

params

Fill Forms · object

required

Show child attributes

file

The source PDF document when using inline field values via params.fields. Use this parameter when providing form field values directly instead of a data file.

files

file[]

The source PDF and data file when using a data file. files[0] is the source PDF document (application/pdf). files[1] is the data file containing form field values (CSV, JSON, XFDF, or FDF format).

delivery

object

This endpoint lets you supply your own URL to receive the single-file output. The URL may point to a custom API endpoint or a pre-signed S3 URL.

The HTTP method defaults to PUT, but you can change it based on your implementation needs via the verb parameter. You can also provide custom headers, such as authentication headers or any others required by your endpoint.

Show child attributes

Response

Returns either JSON or binary output depending on the Accept header (defaults to JSON). JSON responses include a file URL for synchronous tasks or a job status for asynchronous tasks.

Sync - Single File
Async - Job

file

object

Show child attributes

Fill Forms

curl --request POST \
  --url https://api.gonitro.dev/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form method=fill-forms \
  --form 'params={
  "strict": true,
  "fields": [
    {
      "field": "firstName",
      "value": "Jane"
    },
    {
      "field": "lastName",
      "value": "Doe"
    }
  ]
}' \
  --form file='@example-file' \
  --form files.items='@example-file'

import requests

url = "https://api.gonitro.dev/generations"

files = {
    "file": ("example-file", open("example-file", "rb")),
    "files.items": ("example-file", open("example-file", "rb"))
}
payload = {
    "method": "fill-forms",
    "params": "{
  \"strict\": true,
  \"fields\": [
    {
      \"field\": \"firstName\",
      \"value\": \"Jane\"
    },
    {
      \"field\": \"lastName\",
      \"value\": \"Doe\"
    }
  ]
}"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('method', 'fill-forms');
form.append('params', '{
  "strict": true,
  "fields": [
    {
      "field": "firstName",
      "value": "Jane"
    },
    {
      "field": "lastName",
      "value": "Doe"
    }
  ]
}');
form.append('file', '{
  "fileName": "example-file"
}');
form.append('files.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.gonitro.dev/generations', 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.gonitro.dev/generations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"method\"\r\n\r\nfill-forms\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"params\"\r\n\r\n{\r\n  \"strict\": true,\r\n  \"fields\": [\r\n    {\r\n      \"field\": \"firstName\",\r\n      \"value\": \"Jane\"\r\n    },\r\n    {\r\n      \"field\": \"lastName\",\r\n      \"value\": \"Doe\"\r\n    }\r\n  ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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.gonitro.dev/generations"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"method\"\r\n\r\nfill-forms\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"params\"\r\n\r\n{\r\n  \"strict\": true,\r\n  \"fields\": [\r\n    {\r\n      \"field\": \"firstName\",\r\n      \"value\": \"Jane\"\r\n    },\r\n    {\r\n      \"field\": \"lastName\",\r\n      \"value\": \"Doe\"\r\n    }\r\n  ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	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.gonitro.dev/generations")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"method\"\r\n\r\nfill-forms\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"params\"\r\n\r\n{\r\n  \"strict\": true,\r\n  \"fields\": [\r\n    {\r\n      \"field\": \"firstName\",\r\n      \"value\": \"Jane\"\r\n    },\r\n    {\r\n      \"field\": \"lastName\",\r\n      \"value\": \"Doe\"\r\n    }\r\n  ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gonitro.dev/generations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"method\"\r\n\r\nfill-forms\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"params\"\r\n\r\n{\r\n  \"strict\": true,\r\n  \"fields\": [\r\n    {\r\n      \"field\": \"firstName\",\r\n      \"value\": \"Jane\"\r\n    },\r\n    {\r\n      \"field\": \"lastName\",\r\n      \"value\": \"Doe\"\r\n    }\r\n  ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "file": {
    "URL": "<string>",
    "contentType": "application/json",
    "metadata": {
      "fileSizeBytes": 123,
      "pageCount": 123
    }
  }
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#400-bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Request validation failed",
  "instance": "/platform/generations"
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#401-unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Missing or invalid Authorization header",
  "instance": "/platform/generations"
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#404-not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "Resource not found",
  "instance": "/platform/generations"
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#413-content-too-large",
  "title": "Content too large",
  "status": 413,
  "detail": "Uploaded document exceeds the file size limit",
  "instance": "/platform/generations"
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#415-unsupported-media-type",
  "title": "Unsupported Media Type",
  "status": 415,
  "detail": "The provided media type is not supported",
  "instance": "/platform/generations"
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#422-unprocessable-entity",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "The request was well-formed but could not be processed",
  "instance": "/platform/generations"
}

{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#500-internal-server-error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected error occurred",
  "instance": "/platform/generations"
}

Authentication

PDF Services API

Nitro Sign API

Product updates

Parameters

Strict mode

File Upload

Inline form fields (using `params`):

Data file (using `files[0]` and `files[1]`):

Supported data file formats

Output File Format

Processing

Custom File Delivery

Sync delivery

Custom endpoint

S3 delivery

Async delivery

Callback

Response behavior Matrix

Limits

Request

Authorizations

Headers

Body

Response

​Parameters

​Strict mode

​File Upload

​Inline form fields (using params):

​Data file (using files[0] and files[1]):

​Supported data file formats

​Output File Format

​Processing

​Custom File Delivery

​Sync delivery

​Custom endpoint

​S3 delivery

​Async delivery

​Callback

​Response behavior Matrix

​Limits

​Request

Authorizations

Headers

Body

Response

Parameters

Strict mode

File Upload

Inline form fields (using `params`):

Data file (using `files[0]` and `files[1]`):

Supported data file formats

Output File Format

Processing

Custom File Delivery

Sync delivery

Custom endpoint

S3 delivery

Async delivery

Callback

Response behavior Matrix

Limits

Request