Skip to main content
POST
/
jobs
/
analyze
/
files
Analyze job from file upload
curl --request POST \
  --url https://api-service.fribl.co/api/v1/jobs/analyze/files \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-KEY: <api-key>' \
  --form 'files=<string>' \
  --form cache=true \
  --form stream=true \
  --form block=true \
  --form files.items='@example-file'
{
  "message": "Analyze Jobs request received!",
  "data": {
    "ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "status": "PENDING"
  }
}

Authorizations

​
X-API-KEY
string
header
required

API key in UUID format. Include this header with every authenticated request.

Body

multipart/form-data

Request body for submitting file uploads for analysis.

​
files
file[]
required

One or more PDF files to analyze.

​
cache
boolean

Whether to cache the analysis results.

​
stream
boolean

Whether to stream the analysis progress.

​
block
boolean

Whether to block until analysis is complete before returning.

Response

Analysis request accepted. Use the returned IDs to poll for status.

​
message
string
required
Example:

"Analyze Jobs request received!"

​
data
object
required