Skip to content

Retrieve a project by id

Request

Retrieve a project by id

Security
OAuth2(Required scopes: projects.read)
Path
idstring(ProjectId)required

Project id

Example:63e6663823b4c1f5287398bb
curl -i -X GET \
  https://api.cloud.hypatos.ai/v2/projects/63e6663823b4c1f5287398bb \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Project by id

Bodyapplication/json
idstring(ProjectId)required

Project ID

Example:"63e6663823b4c1f5287398bb"
projectTypestring(ProjectType)required

Project processing type. Set on creation and immutable afterwards.

  • documentProcessing - classic extraction project backed by an extraction model
  • preProcessing - pre-processing project backed by the company's Cases processing mode
  • execution - execution project backed by the company's Cases processing mode
Default:"documentProcessing"
Enum:"documentProcessing""preProcessing""execution"
Example:"documentProcessing"
createdAtstring, (date-time)required
Example:"1990-12-31T15:46:19.384990Z"
createdBystring(ProjectMemberId)required

Project member id

Example:"63e6663823b4c1f5287398bb"
updatedAtstring, (date-time)required
Example:"1990-12-31T15:46:19.384990Z"
updatedBystring(ProjectMemberId)required

Project member id

Example:"63e6663823b4c1f5287398bb"
namestring, [ 1 .. 60 ] characters(ProjectName)required

Project name

Example:"My Project"
notestring, [ 1 .. 1000 ] characters(ProjectNote)

Project note

Example:"My project description note"
extractionModelIdstring(ProjectExtractionModelId)required

Extraction Model id

Example:"63e6663823b4c1f5287398bb"
ocrany(ProjectOCRResponse)required
completionstring(ProjectCompletion)required

ProjectCompletion type

  • automatic - Mark documents as completed after succesfull validation
  • manual - Mark documents to review after succesfull validation
Default:"manual"
Enum:"automatic""manual"
Example:"manual"
duplicatesstring(ProjectDuplicates)required

How duplicates documents show be handle

  • allow - Allow documents duplicates to be processed
  • fail - Mark documents duplicates as failed
Default:"fail"
Enum:"allow""fail"
Example:"allow"
membersanyrequired
retentionDaysinteger, [ 1 .. 3650 ](ProjectRetentionDays)

Project document retention in days

Example:180
isLiveboolean(ProjectIsLive)required

Indicates if a project is live or not

Default:false
generateWordRegionsOnReviewboolean(ProjectGenerateWordRegionsOnReview)required

Generate word bounding boxes for documents that require human review.

When enabled, documents that stop for review (extracted or reviewRequired) get an additional OCR pass that produces word regions, unless the project's OCR engine already provided them. Useful for the internal OCR engine, which does not place words.

Default:false
Example:true
Response
{
  "id": "63e6663823b4c1f5287398bb",
  "projectType": "documentProcessing",
  "createdAt": "1990-12-31T15:46:19.384990Z",
  "createdBy": "63e6663823b4c1f5287398bb",
  "updatedAt": "1990-12-31T15:46:19.384990Z",
  "updatedBy": "63e6663823b4c1f5287398bb",
  "name": "My Project",
  "note": "My project description note",
  "extractionModelId": "63e6663823b4c1f5287398bb",
  "ocr": {
    "engine": "abbyy",
    "features": [ … ],
    "languages": [ … ]
  },
  "completion": "manual",
  "duplicates": "allow",
  "members": {
    "allow": "all"
  },
  "retentionDays": 180,
  "isLive": false,
  "generateWordRegionsOnReview": true
}