Skip to main content
POST
/
cases
Create a new case
curl --request POST \
  --url https://api.{region}.neo.veridox.ai/cases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "reference_label": "<string>",
  "file_labels": [
    "<string>"
  ]
}
'
{
  "case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_locked": true,
  "stream_url": "<string>",
  "files": [
    {
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "sas_url": "<string>",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
label
string
Required string length: 1 - 255
reference_label
string
Required string length: 1 - 255
file_labels
string[]
Required string length: 1 - 255

Response

Case created successfully

case_id
string<uuid>
required
is_locked
boolean
required
stream_url
string
required

Base URL for progress updates. Append /stream for SSE or /poll for HTTP polling

files
object[]