Preparing search index...
The search index is not available
cvat-sdk
cvat-sdk
AnnotationGuideWriteRequest
Interface AnnotationGuideWriteRequest
Export
AnnotationGuideWriteRequest
Hierarchy
AnnotationGuideWriteRequest
Index
Properties
markdown?
project_
id?
task_
id?
Properties
Optional
markdown
markdown
?:
string
Memberof
AnnotationGuideWriteRequest
Optional
project_
id
project_
id
?:
null
|
number
Memberof
AnnotationGuideWriteRequest
Optional
task_
id
task_
id
?:
null
|
number
Memberof
AnnotationGuideWriteRequest
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
markdown
project_
id
task_
id
cvat-
sdk
Analytics
Report
Target
Enum
Annotation
Conflict
Type
Enum
Annotation
Id
Type
Enum
Chunk
Type
Credentials
Type
Enum
Default
View
Enum
Events
Enum
File
Info
Type
Enum
Frame
Selection
Method
Enum
Granularity
Enum
Input
Type
Enum
Job
Stage
Job
Status
Job
Type
Location
Enum
Null
Enum
Operation
Status
Operator
Enum
Provider
Type
Enum
Quality
Enum
Quality
Report
Target
Role
Enum
Rq
Status
State
Enum
Severity
Enum
Shape
Type
Sorting
Method
Storage
Method
Storage
Type
Webhook
Content
Type
Webhook
Type
Analytics
Api
Assets
Api
Auth
Api
Cloudstorages
Api
Comments
Api
Configuration
Events
Api
Guides
Api
Invitations
Api
Issues
Api
Jobs
Api
Labels
Api
Lambda
Api
Memberships
Api
Organizations
Api
Projects
Api
Quality
Api
Schema
Api
Server
Api
Tasks
Api
Users
Api
Webhooks
Api
About
Accept
Invitation
Read
Accept
Invitation
Write
Request
Analytics
Api
Analytics
Create
Report
Request
Analytics
Api
Analytics
Get
Reports
Request
Analytics
Report
Analytics
Report
Create
Request
Annotation
Conflict
Annotation
File
Request
Annotation
Guide
Read
Annotation
Guide
Write
Request
Annotation
Id
Asset
Read
Assets
Api
Assets
Create
Request
Assets
Api
Assets
Destroy
Request
Assets
Api
Assets
Retrieve
Public
Request
Assets
Api
Assets
Retrieve
Request
Attribute
Attribute
Request
Attribute
Val
Attribute
Val
Request
Auth
Api
Auth
Create
Login
Request
Auth
Api
Auth
Create
Password
Change
Request
Auth
Api
Auth
Create
Password
Reset
Confirm
Request
Auth
Api
Auth
Create
Password
Reset
Request
Auth
Api
Auth
Create
Register
Request
Auth
Api
Auth
Create
Signing
Request
Basic
User
Basic
User
Request
Binary
Operation
Client
Events
Client
Events
Request
Cloud
Storage
Content
Cloud
Storage
Read
Cloud
Storage
Write
Request
Cloudstorages
Api
Cloudstorages
Create
Request
Cloudstorages
Api
Cloudstorages
Destroy
Request
Cloudstorages
Api
Cloudstorages
List
Request
Cloudstorages
Api
Cloudstorages
Partial
Update
Request
Cloudstorages
Api
Cloudstorages
Retrieve
Actions
Request
Cloudstorages
Api
Cloudstorages
Retrieve
Content
V2
Request
Cloudstorages
Api
Cloudstorages
Retrieve
Preview
Request
Cloudstorages
Api
Cloudstorages
Retrieve
Request
Cloudstorages
Api
Cloudstorages
Retrieve
Status
Request
Comment
Read
Comment
Write
Request
Comments
Api
Comments
Create
Request
Comments
Api
Comments
Destroy
Request
Comments
Api
Comments
List
Request
Comments
Api
Comments
Partial
Update
Request
Comments
Api
Comments
Retrieve
Request
Comments
Summary
Configuration
Parameters
Data
Frame
Data
Meta
Read
Data
Request
Dataset
File
Request
Dataset
Format
Dataset
Formats
Event
Event
Request
Events
Events
Api
Events
Create
Request
Events
Api
Events
List
Request
File
Info
Frame
Meta
Function
Call
Function
Call
Params
Function
Call
Request
Guides
Api
Guides
Create
Request
Guides
Api
Guides
Destroy
Request
Guides
Api
Guides
Partial
Update
Request
Guides
Api
Guides
Retrieve
Request
Invitation
Read
Invitation
Write
Request
Invitations
Api
Invitations
Accept
Request
Invitations
Api
Invitations
Create
Request
Invitations
Api
Invitations
Destroy
Request
Invitations
Api
Invitations
List
Request
Invitations
Api
Invitations
Partial
Update
Request
Invitations
Api
Invitations
Resend
Request
Invitations
Api
Invitations
Retrieve
Request
Issue
Read
Issue
Write
Request
Issues
Api
Issues
Create
Request
Issues
Api
Issues
Destroy
Request
Issues
Api
Issues
List
Request
Issues
Api
Issues
Partial
Update
Request
Issues
Api
Issues
Retrieve
Request
Issues
Summary
Job
Read
Job
Write
Request
Jobs
Api
Jobs
Create
Annotations
Request
Jobs
Api
Jobs
Create
Request
Jobs
Api
Jobs
Destroy
Annotations
Request
Jobs
Api
Jobs
Destroy
Request
Jobs
Api
Jobs
List
Request
Jobs
Api
Jobs
Partial
Update
Annotations
Request
Jobs
Api
Jobs
Partial
Update
Request
Jobs
Api
Jobs
Retrieve
Annotations
Request
Jobs
Api
Jobs
Retrieve
Data
Meta
Request
Jobs
Api
Jobs
Retrieve
Data
Request
Jobs
Api
Jobs
Retrieve
Dataset
Request
Jobs
Api
Jobs
Retrieve
Preview
Request
Jobs
Api
Jobs
Retrieve
Request
Jobs
Api
Jobs
Update
Annotations
Request
Jobs
Summary
Label
Label
Mapping
Entry
Request
Labeled
Data
Labeled
Data
Request
Labeled
Image
Labeled
Image
Request
Labeled
Shape
Labeled
Shape
Request
Labeled
Track
Labeled
Track
Request
Labels
Api
Labels
Destroy
Request
Labels
Api
Labels
List
Request
Labels
Api
Labels
Partial
Update
Request
Labels
Api
Labels
Retrieve
Request
Labels
Summary
Lambda
Api
Lambda
Create
Functions
Request
Lambda
Api
Lambda
Create
Requests
Request
Lambda
Api
Lambda
Delete
Requests
Request
Lambda
Api
Lambda
Retrieve
Functions
Request
Lambda
Api
Lambda
Retrieve
Requests
Request
Login
Serializer
Ex
Request
Membership
Read
Memberships
Api
Memberships
Destroy
Request
Memberships
Api
Memberships
List
Request
Memberships
Api
Memberships
Partial
Update
Request
Memberships
Api
Memberships
Retrieve
Request
Meta
User
Metric
Online
Function
Call
Request
Organization
Read
Organization
Write
Request
Organizations
Api
Organizations
Create
Request
Organizations
Api
Organizations
Destroy
Request
Organizations
Api
Organizations
List
Request
Organizations
Api
Organizations
Partial
Update
Request
Organizations
Api
Organizations
Retrieve
Request
Paginated
Annotation
Conflict
List
Paginated
Cloud
Storage
Read
List
Paginated
Comment
Read
List
Paginated
Invitation
Read
List
Paginated
Issue
Read
List
Paginated
Job
Read
List
Paginated
Label
List
Paginated
Membership
Read
List
Paginated
Meta
User
List
Paginated
Organization
Read
List
Paginated
Project
Read
List
Paginated
Quality
Report
List
Paginated
Quality
Settings
List
Paginated
Task
Read
List
Paginated
Webhook
Delivery
Read
List
Paginated
Webhook
Read
List
Password
Change
Request
Password
Reset
Confirm
Request
Password
Reset
Serializer
Ex
Request
Patched
Annotation
Guide
Write
Request
Patched
Cloud
Storage
Write
Request
Patched
Comment
Write
Request
Patched
Data
Meta
Write
Request
Patched
Invitation
Write
Request
Patched
Issue
Write
Request
Patched
Job
Write
Request
Patched
Label
Request
Patched
Labeled
Data
Request
Patched
Membership
Write
Request
Patched
Organization
Write
Request
Patched
Project
Write
Request
Patched
Quality
Settings
Request
Patched
Task
Write
Request
Patched
User
Request
Patched
Webhook
Write
Request
Plugins
Project
File
Request
Project
Read
Project
Write
Request
Projects
Api
Projects
Create
Backup
Request
Projects
Api
Projects
Create
Dataset
Request
Projects
Api
Projects
Create
Request
Projects
Api
Projects
Destroy
Request
Projects
Api
Projects
List
Request
Projects
Api
Projects
Partial
Update
Request
Projects
Api
Projects
Retrieve
Annotations
Request
Projects
Api
Projects
Retrieve
Backup
Request
Projects
Api
Projects
Retrieve
Dataset
Request
Projects
Api
Projects
Retrieve
Preview
Request
Projects
Api
Projects
Retrieve
Request
Quality
Api
Quality
Create
Report
Request
Quality
Api
Quality
List
Conflicts
Request
Quality
Api
Quality
List
Reports
Request
Quality
Api
Quality
List
Settings
Request
Quality
Api
Quality
Partial
Update
Settings
Request
Quality
Api
Quality
Retrieve
Report
Data
Request
Quality
Api
Quality
Retrieve
Report
Request
Quality
Api
Quality
Retrieve
Settings
Request
Quality
Report
Quality
Report
Create
Request
Quality
Report
Summary
Quality
Settings
Register
Serializer
Ex
Register
Serializer
Ex
Request
Rest
Auth
Detail
Rq
Id
Rq
Status
Schema
Api
Schema
Retrieve
Request
Server
Api
Server
List
Share
Request
Signing
Request
Storage
Storage
Request
Sub
Labeled
Shape
Sub
Labeled
Shape
Request
Sub
Labeled
Track
Sub
Labeled
Track
Request
Sublabel
Sublabel
Mapping
Entry
Request
Sublabel
Request
Task
File
Request
Task
Read
Task
Write
Request
Tasks
Api
Jobs
Partial
Update
Data
Meta
Request
Tasks
Api
Tasks
Create
Annotations
Request
Tasks
Api
Tasks
Create
Backup
Request
Tasks
Api
Tasks
Create
Data
Request
Tasks
Api
Tasks
Create
Request
Tasks
Api
Tasks
Destroy
Annotations
Request
Tasks
Api
Tasks
Destroy
Request
Tasks
Api
Tasks
List
Request
Tasks
Api
Tasks
Partial
Update
Annotations
Request
Tasks
Api
Tasks
Partial
Update
Data
Meta
Request
Tasks
Api
Tasks
Partial
Update
Request
Tasks
Api
Tasks
Retrieve
Annotations
Request
Tasks
Api
Tasks
Retrieve
Backup
Request
Tasks
Api
Tasks
Retrieve
Data
Meta
Request
Tasks
Api
Tasks
Retrieve
Data
Request
Tasks
Api
Tasks
Retrieve
Dataset
Request
Tasks
Api
Tasks
Retrieve
Preview
Request
Tasks
Api
Tasks
Retrieve
Request
Tasks
Api
Tasks
Retrieve
Status
Request
Tasks
Api
Tasks
Update
Annotations
Request
Tasks
Summary
Token
Tracked
Shape
Tracked
Shape
Request
Transformation
User
Users
Api
Users
Destroy
Request
Users
Api
Users
List
Request
Users
Api
Users
Partial
Update
Request
Users
Api
Users
Retrieve
Request
Webhook
Delivery
Read
Webhook
Read
Webhook
Write
Request
Webhooks
Api
Webhooks
Create
Deliveries
Redelivery
Request
Webhooks
Api
Webhooks
Create
Ping
Request
Webhooks
Api
Webhooks
Create
Request
Webhooks
Api
Webhooks
Destroy
Request
Webhooks
Api
Webhooks
List
Deliveries
Request
Webhooks
Api
Webhooks
List
Request
Webhooks
Api
Webhooks
Partial
Update
Request
Webhooks
Api
Webhooks
Retrieve
Deliveries
Request
Webhooks
Api
Webhooks
Retrieve
Events
Request
Webhooks
Api
Webhooks
Retrieve
Request
Webhooks
Api
Webhooks
Update
Request
Annotations
Read
Backup
Write
Request
Cloudstorages
List
Credentials
Type
Enum
Cloudstorages
List
Provider
Type
Enum
Dataset
Write
Request
Events
List
Action
Enum
Job
Annotations
Update
Request
Jobs
Create
Annotations
Location
Enum
Jobs
List
Dimension
Enum
Jobs
List
Stage
Enum
Jobs
List
State
Enum
Jobs
List
Type
Enum
Jobs
Partial
Update
Annotations
Action
Enum
Jobs
Retrieve
Annotations
Action
Enum
Jobs
Retrieve
Annotations
Location
Enum
Jobs
Retrieve
Data
Quality
Enum
Jobs
Retrieve
Data
Type
Enum
Jobs
Retrieve
Dataset
Action
Enum
Jobs
Retrieve
Dataset
Location
Enum
Jobs
Update
Annotations
Location
Enum
Labels
List
Type
Enum
Memberships
List
Role
Enum
Projects
Create
Backup
Location
Enum
Projects
Create
Dataset
Location
Enum
Projects
List
Status
Enum
Projects
Retrieve
Annotations
Action
Enum
Projects
Retrieve
Annotations
Location
Enum
Projects
Retrieve
Backup
Action
Enum
Projects
Retrieve
Backup
Location
Enum
Projects
Retrieve
Dataset
Action
Enum
Projects
Retrieve
Dataset
Location
Enum
Quality
List
Conflicts
Severity
Enum
Quality
List
Conflicts
Type
Enum
Schema
Retrieve
Lang
Enum
Schema
Retrieve
Scheme
Enum
Task
Annotations
Update
Request
Task
Annotations
Write
Request
Tasks
Create
Annotations
Location
Enum
Tasks
Create
Backup
Location
Enum
Tasks
List
Dimension
Enum
Tasks
List
Status
Enum
Tasks
Partial
Update
Annotations
Action
Enum
Tasks
Retrieve
Annotations
Action
Enum
Tasks
Retrieve
Annotations
Location
Enum
Tasks
Retrieve
Backup
Action
Enum
Tasks
Retrieve
Backup
Location
Enum
Tasks
Retrieve
Data
Quality
Enum
Tasks
Retrieve
Data
Type
Enum
Tasks
Retrieve
Dataset
Action
Enum
Tasks
Retrieve
Dataset
Location
Enum
Webhooks
List
Type
Enum
Cloudstorages
List
Credentials
Type
Enum
Cloudstorages
List
Provider
Type
Enum
Events
List
Action
Enum
Jobs
Create
Annotations
Location
Enum
Jobs
List
Dimension
Enum
Jobs
List
Stage
Enum
Jobs
List
State
Enum
Jobs
List
Type
Enum
Jobs
Partial
Update
Annotations
Action
Enum
Jobs
Retrieve
Annotations
Action
Enum
Jobs
Retrieve
Annotations
Location
Enum
Jobs
Retrieve
Data
Quality
Enum
Jobs
Retrieve
Data
Type
Enum
Jobs
Retrieve
Dataset
Action
Enum
Jobs
Retrieve
Dataset
Location
Enum
Jobs
Update
Annotations
Location
Enum
Labels
List
Type
Enum
Memberships
List
Role
Enum
Projects
Create
Backup
Location
Enum
Projects
Create
Dataset
Location
Enum
Projects
List
Status
Enum
Projects
Retrieve
Annotations
Action
Enum
Projects
Retrieve
Annotations
Location
Enum
Projects
Retrieve
Backup
Action
Enum
Projects
Retrieve
Backup
Location
Enum
Projects
Retrieve
Dataset
Action
Enum
Projects
Retrieve
Dataset
Location
Enum
Quality
List
Conflicts
Severity
Enum
Quality
List
Conflicts
Type
Enum
Schema
Retrieve
Lang
Enum
Schema
Retrieve
Scheme
Enum
Tasks
Create
Annotations
Location
Enum
Tasks
Create
Backup
Location
Enum
Tasks
List
Dimension
Enum
Tasks
List
Status
Enum
Tasks
Partial
Update
Annotations
Action
Enum
Tasks
Retrieve
Annotations
Action
Enum
Tasks
Retrieve
Annotations
Location
Enum
Tasks
Retrieve
Backup
Action
Enum
Tasks
Retrieve
Backup
Location
Enum
Tasks
Retrieve
Data
Quality
Enum
Tasks
Retrieve
Data
Type
Enum
Tasks
Retrieve
Dataset
Action
Enum
Tasks
Retrieve
Dataset
Location
Enum
Webhooks
List
Type
Enum
Analytics
Api
Axios
Param
Creator
Analytics
Api
Factory
Analytics
Api
Fp
Assets
Api
Axios
Param
Creator
Assets
Api
Factory
Assets
Api
Fp
Auth
Api
Axios
Param
Creator
Auth
Api
Factory
Auth
Api
Fp
Cloudstorages
Api
Axios
Param
Creator
Cloudstorages
Api
Factory
Cloudstorages
Api
Fp
Comments
Api
Axios
Param
Creator
Comments
Api
Factory
Comments
Api
Fp
Events
Api
Axios
Param
Creator
Events
Api
Factory
Events
Api
Fp
Guides
Api
Axios
Param
Creator
Guides
Api
Factory
Guides
Api
Fp
Invitations
Api
Axios
Param
Creator
Invitations
Api
Factory
Invitations
Api
Fp
Issues
Api
Axios
Param
Creator
Issues
Api
Factory
Issues
Api
Fp
Jobs
Api
Axios
Param
Creator
Jobs
Api
Factory
Jobs
Api
Fp
Labels
Api
Axios
Param
Creator
Labels
Api
Factory
Labels
Api
Fp
Lambda
Api
Axios
Param
Creator
Lambda
Api
Factory
Lambda
Api
Fp
Memberships
Api
Axios
Param
Creator
Memberships
Api
Factory
Memberships
Api
Fp
Organizations
Api
Axios
Param
Creator
Organizations
Api
Factory
Organizations
Api
Fp
Projects
Api
Axios
Param
Creator
Projects
Api
Factory
Projects
Api
Fp
Quality
Api
Axios
Param
Creator
Quality
Api
Factory
Quality
Api
Fp
Schema
Api
Axios
Param
Creator
Schema
Api
Factory
Schema
Api
Fp
Server
Api
Axios
Param
Creator
Server
Api
Factory
Server
Api
Fp
Tasks
Api
Axios
Param
Creator
Tasks
Api
Factory
Tasks
Api
Fp
Users
Api
Axios
Param
Creator
Users
Api
Factory
Users
Api
Fp
Webhooks
Api
Axios
Param
Creator
Webhooks
Api
Factory
Webhooks
Api
Fp
Generated using
TypeDoc
Export
AnnotationGuideWriteRequest