novalad

Process Document

POST

/api/v1/process

Last modified:2025-03-20 07:00:34

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Content-Type

string

optional

Example:

application/json

Body Params application/json

file_url

string

required

Provide the URL/URI for the file, it accepts web url file, AWS S3, Azure Blob, GCP Cloud Storage. Make sure to pass public url

skip_images

boolean

required

If you want to skip non important images

skip_insights

boolean

required

If you want to skip Chart/Table LLM call to Generate Insights like caption,summary

skip_header_footer

boolean

required

If you want to skip Header and Footer Extraction

Example

{
    "file_url": "string",
    "skip_images": true,
    "skip_insights": true,
    "skip_header_footer": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/process' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "file_url": "string",
    "skip_images": true,
    "skip_insights": true,
    "skip_header_footer": true
}'

Responses

🟢200Success

application/json

Body

run_id

string

required

Unique ID given to the job

run_name

string

required

Name of the Job

filename

string

required

Name of the file in process

created_at

required

Timestamp of Job created

pages_processed

integer

required

Total Number of Pages Processed by Novalad

insights_processed

integer

required

Total LLM calls made to generate insights from charts/tables

status

string

required

status of job

notes

string

required

any messages from the job

credit_used

integer

required

Total Novalad Credits used to process the document

Example

{
    "run_id": "9004571f-093d-40cc-8e9f-07f8bec8653e",
    "run_name": "novalad_jobs_2025-03-17-03-42-41",
    "filename": "91320_en.pdf",
    "created_at": "2025-03-20T06:46:18.811553Z",
    "pages_processed": 0,
    "insights_processed": 0,
    "status": "progress",
    "notes": "creating job.. this usually takes between 2-3 min",
    "credit_used": 0
}

Modified at 2025-03-20 07:00:34

Job Status