Annotation

Edit annotation (legacy split)

Legacy endpoint for splitting annotations. Creates new annotations from the original annotation's pages.

<Callout type="info"> This is a legacy endpoint. For new implementations, use the [split](/api/annotation#split-annotation) endpoint instead, which provides the same functionality with a clearer name. </Callout>

If used on an annotation in a way that after the editing only one document remains, the original annotation will be edited. If multiple documents are to be created after the call, status of the original annotation is switched to split, status of the newly created annotations is importing and the extraction phase begins over again.

post/api/v1/annotations/{annotationID}/edit

Path parameters

annotationIDinteger required

Annotation ID

Request body

Example request

{
  "documents": [
    {
      "pages": [
        {
          "page": "https://example.rossum.app/api/v1/pages/12345",
          "rotation_deg": 90
        }
      ],
      "metadata": {
        "annotation": {
          "some_key": "some value"
        }
      }
    }
  ]
}

Response

Annotation edited successfully

Example response

{
  "results": [
    {
      "annotation": "https://example.rossum.app/api/v1/annotations/67890",
      "document": "https://example.rossum.app/api/v1/documents/456700"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.