const data = {
pageNumber: 7,
textRegion: { xMin: 0, xMax: 0.1, yMin: 0, yMax: 0.2 },
extractedText: 'i am your father',
};
const annotation = {
annotatedResourceType: 'file' as const,
annotatedResourceId: 1,
annotationType: 'documents.ExtractedText',
creatingApp: 'integration-tests',
creatingAppVersion: '0.0.1',
creatingUser: 'integration-tests',
status: 'suggested' as const,
data,
};
const created = await client.annotations.create([annotation]);{
"items": [
{
"id": 4096,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"annotatedResourceType": "file",
"annotatedResourceId": 1337,
"annotationType": "pointcloud.BoundingVolume",
"creatingApp": "cognite-vision",
"creatingAppVersion": "1.2.1",
"creatingUser": "john.doe@cognite.com",
"data": {
"assetRef": {
"externalId": "abc"
},
"symbolRegion": {
"xMin": 0.1,
"xMax": 0.2,
"yMin": 0.1,
"yMax": 0.2
},
"textRegion": {
"xMin": 0.2,
"xMax": 0.3,
"yMin": 0.2,
"yMax": 0.3
},
"pageNumber": 43
},
"status": "approved"
}
]
}Required capabilities:
annotationsAcl:WRITE
Creates the given annotations.
An annotation must reference an annotated resource.
The reference can be made by providing the internal ID of the annotated resource.
The annotation must have the status field set to either “suggested”, “rejected”, or “approved”
The caller must have read-access on all the annotated resources, otherwise the call will fail.
The annotation type property must be set to one of the globally available annotation types.
See the documentation of the annotationType and data attributes for details.
The annotation data must conform to the schema provided by the annotation type.
The creating application and its version must be provided. The creating user must be provided, but if the
annotation is being created by a service, this can be set to null.
const data = {
pageNumber: 7,
textRegion: { xMin: 0, xMax: 0.1, yMin: 0, yMax: 0.2 },
extractedText: 'i am your father',
};
const annotation = {
annotatedResourceType: 'file' as const,
annotatedResourceId: 1,
annotationType: 'documents.ExtractedText',
creatingApp: 'integration-tests',
creatingAppVersion: '0.0.1',
creatingUser: 'integration-tests',
status: 'suggested' as const,
data,
};
const created = await client.annotations.create([annotation]);{
"items": [
{
"id": 4096,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"annotatedResourceType": "file",
"annotatedResourceId": 1337,
"annotationType": "pointcloud.BoundingVolume",
"creatingApp": "cognite-vision",
"creatingAppVersion": "1.2.1",
"creatingUser": "john.doe@cognite.com",
"data": {
"assetRef": {
"externalId": "abc"
},
"symbolRegion": {
"xMin": 0.1,
"xMax": 0.2,
"yMin": 0.1,
"yMax": 0.2
},
"textRegion": {
"xMin": 0.2,
"xMax": 0.3,
"yMin": 0.2,
"yMax": 0.3
},
"pageNumber": 43
},
"status": "approved"
}
]
}Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
A request for creating annotations
A list of annotations to create
Show child attributes
Successful creation
A list of annotations
Show child attributes
Was this page helpful?