Skip to main content
POST
/
jobs
/
status
Check job processing status
curl --request POST \
  --url https://api-service.fribl.co/api/v1/jobs/status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
import requests

url = "https://api-service.fribl.co/api/v1/jobs/status"

payload = { "ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']})
};

fetch('https://api-service.fribl.co/api/v1/jobs/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api-service.fribl.co/api/v1/jobs/status"

payload := strings.NewReader("{\n \"ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")

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

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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-service.fribl.co/api/v1/jobs/status")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();
{
  "message": "<string>",
  "length": 123,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "original_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
{
"error": "<string>"
}
{
"error": "<string>"
}

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 checking processing status. The ids array must contain at least one identifier — empty arrays are rejected with 400.

ids
string<uuid>[]
required

List of document identifiers to check status for. Must be non-empty.

Minimum array length: 1

Response

Status of the requested jobs.

message
string
required
length
integer
required

Number of status items returned.

data
object[]
required