ROrossum
Annotation

Edit pages in place

Changed on

Edits pages of an annotation in place by reordering, rotating, or removing pages without creating new annotations.

Unlike the edit_pages endpoint which creates new child annotations, this endpoint modifies the existing annotation directly.

Can be called on an annotation in importing, to_review, reviewing or confirmed status.

This endpoint can be used for the embedded mode.

post/api/v1/annotations/{annotationID}/edit_pages/in_place

Request

Path parameters

annotationIDinteger required

Annotation ID

Request body

target_queuestring uri

Target queue URL. When not provided, the annotation stays in its current queue.

Example request

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

Response

Pages edited successfully

Example response

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

Changes