v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB

Documents

Update a document

Update file name, expiry time, or move to another collection, etc.

patch/v3/documents/{identifier}

Path parameters

identifierstring required

Unique identifier for the document

Document's identifier

Query parameters

compactboolean

If "true", the response is compacted to annotations' parsed data. Annotations' meta data are excluded. Default is "false".

snake_caseboolean

Whether to return the response in snake_case instead of camelCase. Default is false.

Request body

collectionstring

Uniquely identify a collection.

workspacestring

Uniquely identify a workspace.

documentTypestring nullable

The document type's identifier. Provide if you already know the document type.

fileNamestring nullable

Optional filename of the file

expiryTimestring date-time nullable

The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.

isConfirmedboolean

isRejectedboolean

isArchivedboolean

skipParseboolean

languagestring nullable

Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.

identifierstring

Deprecated in favor of customIdentifier.

customIdentifierstring

Specify a custom identifier for the document if you need one, not required to be unique.

llmHintstring nullable

Optional hint inserted into the LLM prompt when processing this document.

Example request

{
  "collection": "mEFayXdO",
  "workspace": "mEFayXdO",
  "fileName": "Document.pdf",
  "language": "en",
  "warningMessages": [
    {
      "warningCode": "too_many_pages",
      "warningDetail": "File exceeds maximum number of pages allowed, parsing the first 10 pages only."
    }
  ]
}

Response

Successfully updated document data.

dataobject

extractorstring required

Example response

{
  "meta": {
    "customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834",
    "fileName": "Document.pdf",
    "ready": true,
    "readyDt": "2020-12-10T01:43:32.276724Z",
    "language": "en",
    "pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
    "parentDocument": {
      "customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834"
    },
    "childDocuments": [
      {
        "customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834"
      }
    ],
    "pages": [
      {
        "image": "https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
        "imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
        "height": 700,
        "width": 500,
        "rotation": 90
      }
    ],
    "collection": {
      "identifier": "mEFayXdO",
      "extractor": {
        "identifier": "resume"
      },
      "validationRules": [
        {
          "slug": "supplier_name_is_alphanumeric"
        }
      ]
    },
    "workspace": {
      "identifier": "mEFayXdO"
    },
    "confirmedBy": {
      "id": 1,
      "name": "Carl Johnson",
      "username": "carljohnson",
      "email": "carljohnson@grove.street",
      "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
    },
    "rejectedBy": {
      "id": 1,
      "name": "Carl Johnson",
      "username": "carljohnson",
      "email": "carljohnson@grove.street",
      "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
    },
    "archivedBy": {
      "id": 1,
      "name": "Carl Johnson",
      "username": "carljohnson",
      "email": "carljohnson@grove.street",
      "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
    },
    "errorCode": "document_conversion_failed",
    "errorDetail": "Unable to convert word document",
    "tags": [
      {
        "id": 1,
        "workspace": "mEFayXdO"
      }
    ],
    "createdBy": {
      "id": 1,
      "name": "Carl Johnson",
      "username": "carljohnson",
      "email": "carljohnson@grove.street",
      "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
    },
    "regionBias": {
      "strict": true
    }
  },
  "error": {
    "errorCode": "document_conversion_failed",
    "errorDetail": "Unable to convert word document"
  },
  "warnings": [
    {
      "warningCode": "too_many_pages",
      "warningDetail": "File exceeds maximum number of pages allowed, parsing the first 10 pages only."
    }
  ]
}