Create Annotation

POST 
/preview/annotations/

Create Annotation

Request

application/json

Body

required

annotationobjectrequired
kind AnnotationKind (string)
Possible values: [custom, human, auto]
Default value: custom
source AnnotationSource (string)
Possible values: [web, sdk, api]
Default value: api
dataobjectrequired
property name*FullJson-Input
anyOf
MOD1
string
MOD2
integer
MOD3
number
MOD4
boolean
MOD6
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
]
metadataobject
anyOf
referencesobjectrequired
evaluatorobjectrequired
idobject
anyOf
MOD1
string
slugobject
anyOf
MOD1
string
versionobject
anyOf
MOD1
string
attributesobject
property name* any
testsetobject
anyOf
AnnotationReference
idobject
anyOf
MOD1
string
slugobject
anyOf
MOD1
string
versionobject
anyOf
MOD1
string
attributesobject
property name* any
testcaseobject
anyOf
AnnotationReference
idobject
anyOf
MOD1
string
slugobject
anyOf
MOD1
string
versionobject
anyOf
MOD1
string
attributesobject
property name* any
linksobjectrequired
property name*AnnotationLink
span_id Span Id (string)required
trace_id Trace Id (string)required
attributesobject
property name* any

Responses

200

Successful Response

application/json

Schema

Schema

annotationobject
anyOf
Annotation
created_atobject
anyOf
MOD1
string
updated_atobject
anyOf
MOD1
string
deleted_atobject
anyOf
MOD1
string
created_by_idobject
anyOf
MOD1
string
updated_by_idobject
anyOf
MOD1
string
deleted_by_idobject
anyOf
MOD1
string
span_id Span Id (string)required
trace_id Trace Id (string)required
kind AnnotationKind (string)
Possible values: [custom, human, auto]
Default value: custom
source AnnotationSource (string)
Possible values: [web, sdk, api]
Default value: api
dataobjectrequired
property name*FullJson-Output
anyOf
MOD1
string
MOD2
integer
MOD3
number
MOD4
boolean
MOD6
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
]
metadataobject
anyOf
referencesobjectrequired
evaluatorobjectrequired
idobject
anyOf
MOD1
string
slugobject
anyOf
MOD1
string
versionobject
anyOf
MOD1
string
testsetobject
anyOf
AnnotationReference
id
object
anyOf
MOD1
string
slug
object
anyOf
MOD1
string
version
object
anyOf
MOD1
string
testcaseobject
anyOf
AnnotationReference
id
object
anyOf
MOD1
string
slug
object
anyOf
MOD1
string
version
object
anyOf
MOD1
string
linksobjectrequired
property name*AnnotationLink
span_id Span Id (string)required
trace_id Trace Id (string)required

Example (from schema)

{
  "annotation": {}
}

422

Validation Error

application/json

Schema

Schema

detailobject[]

Array [

locobject[]required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...