Mark a segment as annotated

Mark a segment as annotated

Path Parameters

• project_id integer required

  ID of the project

• annotation_id integer required

  ID of the labeling session

• document_id integer required

  ID of the document

• segment_id integer required

  ID of the segment

application/json

Request Body required

• name string required

  Possible values: [ANNOTATED]

Responses

• 200
• 400
• 401
• 403
• 404
• 500

---

The segment has been annotated.

application/json

• Schema
• Example (from schema)

---

Schema

• name string

  Possible values: [ANNOTATED]

  The status.

• created date-time
• document_id integer

  The ID of the document.

• segment_id integer

  The ID of the segment.

• annotation_id integer

  The ID of the labeling session.

{
  "name": "ANNOTATED",
  "created": "2023-11-02",
  "document_id": 187,
  "segment_id": 3010,
  "annotation_id": 1
}

The body sent is invalid. Check the error message for more details

User is not authenticated. This means token is either not present or invalid

User is read-only or does not have the minimal required project role ANNOTATOR

The labeling session, the document, the segment or the project was not found

Something is wrong with the API.

Loading...