ROrossum
Annotation

Create embedded URL

Similar to start embedded annotation endpoint but can be called for annotations with all statuses and does not switch status.

Embedded annotation cannot be started by users with admin or organization group admin roles. We strongly recommend creating embedded URLs by users with annotator_embedded user role and permissions for the given queue only to limit the scope of actions that user is able to perform to required minimum.

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

Request

Path parameters

annotationIDinteger required

Annotation ID

Request body

return_urlstring uri

URL to redirect to after annotation is confirmed

cancel_urlstring uri

URL to redirect to when annotation is cancelled

delete_urlstring uri

URL to redirect to when annotation is deleted

postpone_urlstring uri

URL to redirect to when annotation is postponed

max_token_lifetime_snumber float

Duration (in seconds) for which the token will be valid. The default is the queue's session_timeout).

Example request

{
  "return_url": "https://service.com/return",
  "cancel_url": "https://service.com/cancel",
  "delete_url": "https://service.com/delete",
  "postpone_url": "https://service.com/postpone",
  "max_token_lifetime_s": 3600
}

Response

Embedded URL created successfully

urlstring uri

URL to be used in the browser iframe/popup window. URL includes a token that is valid for this document only for a limited period of time.

statusstring

Status of annotation, see annotation lifecycle.

Example response

{
  "url": "https://example.rossum.app/embedded/document/12345#authToken=db313f24f5738c8e04635e036ec8a45cdd6d6b03",
  "status": "to_review"
}

Changes

No recorded changes to this operation across all 14 revisions of this API.