Skip to main content
GET
/
predictions
/
{predictionId}
cURL
curl --request GET \
  --url https://api.cradl.ai/{basePath}/predictions/{predictionId} \
  --header 'Authorization: Bearer <token>'
{
  "updatedTime": "<string>",
  "metadata": {},
  "updatedBy": "<string>",
  "modelId": "<string>",
  "description": "<string>",
  "predictions": [
    {
      "confidence": 0.5,
      "label": "<string>",
      "value": "<string>",
      "validators": "<array>",
      "warnings": [
        "<string>"
      ],
      "rotation": 123,
      "formatters": "<array>",
      "rawValue": "<string>",
      "attentionMap": [
        [
          123
        ]
      ],
      "location": [
        0.5
      ],
      "page": 123,
      "errors": [
        "<string>"
      ]
    }
  ],
  "createdBy": "<string>",
  "name": "<string>",
  "createdTime": "<string>",
  "documentId": "<string>",
  "predictionId": "<string>",
  "trainingId": "<string>",
  "nextPage": 123,
  "postprocessConfig": {},
  "warnings": [
    "<string>"
  ],
  "inferenceTime": 1,
  "error": "<string>",
  "agentRunId": "<string>",
  "preprocessConfig": {
    "trimMargins": true,
    "useGhostScript": true,
    "startPage": 123,
    "pages": [
      123
    ],
    "usePoppler": true,
    "padToFit": true,
    "useTextDetection": true,
    "maxPages": 50,
    "deskewImage": true,
    "autoRotate": true
  },
  "fileUrl": "<string>",
  "errors": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
predictionId
string
required

Response

200 response

​
updatedTime
string | null
required
Pattern: ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
​
metadata
object
required
​
updatedBy
string | null
required
Maximum string length: 4096
​
modelId
string
required
Pattern: ^(|(cradl|las):organization:[a-z0-9-_]+/)(cradl|las):model:[a-z0-9-_]+$
​
description
string | null
required
Maximum string length: 4096
​
predictions
required
​
createdBy
string
required
Maximum string length: 4096
​
name
string | null
required
Maximum string length: 4096
​
createdTime
string
required
Pattern: ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
​
documentId
string
required
Pattern: ^(cradl|las):document:[a-f0-9]{32}$
​
predictionId
string
required
Pattern: ^(cradl|las):prediction:[a-f0-9]{32}$
​
trainingId
string | null
Pattern: ^las:model-training:[a-z0-9-_]+$
​
nextPage
integer | null
​
postprocessConfig
object
​
warnings
string[] | null
​
inferenceTime
number | null
Required range: x >= 0
​
error
string | null
Maximum string length: 4096
​
agentRunId
string | null
Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:agent:[a-z0-9-_]+/cradl:run:[a-z0-9-_]+$
​
preprocessConfig
object
​
fileUrl
string | null
Pattern: ^http://localhost.*|^https://.*
​
errors
string[] | null
​
status
enum<string>
Available options:
pending,
succeeded,
failed