Skip to main content
POST
/
jobs
/
analyze
Analyze job from text
curl --request POST \
  --url https://api-service.fribl.co/api/v1/jobs/analyze \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "inputs": [
    "<string>"
  ],
  "cache": true,
  "stream": true,
  "block": true
}
'
{
  "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

application/json

Request body for submitting text content for analysis.

​
inputs
string[]
required

Array of text strings to analyze. Each string represents a complete document.

​
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