package
0.0.0-20241219044027-ff915651a6c5
Repository: https://github.com/hsinhoyeh/go-labelstudio.git
Documentation: pkg.go.dev
# README
Go API client for swagger
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
Overview
This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.
- API version: v1.11.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.GoClientCodegen For more information, please visit https://labelstud.io
Installation
Put the package under your project folder and add the following in import:
import "./swagger"
Documentation for API Endpoints
All URIs are relative to http://api.labelstud.io
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AnnotationsApi | ApiAnnotationsDelete | Delete /api/annotations/{id}/ | Delete annotation |
| AnnotationsApi | ApiAnnotationsPartialUpdate | Patch /api/annotations/{id}/ | Update annotation |
| AnnotationsApi | ApiAnnotationsRead | Get /api/annotations/{id}/ | Get annotation by its ID |
| AnnotationsApi | ApiTasksAnnotationsCreate | Post /api/tasks/{id}/annotations/ | Create annotation |
| AnnotationsApi | ApiTasksAnnotationsList | Get /api/tasks/{id}/annotations/ | Get all task annotations |
| DataManagerApi | ApiDmActionsCreate | Post /api/dm/actions/ | Post actions |
| DataManagerApi | ApiDmActionsList | Get /api/dm/actions/ | Get actions |
| DataManagerApi | ApiDmColumnsList | Get /api/dm/columns/ | Get data manager columns |
| DataManagerApi | ApiDmProjectList | Get /api/dm/project/ | Get project state |
| DataManagerApi | ApiDmViewsCreate | Post /api/dm/views/ | Create view |
| DataManagerApi | ApiDmViewsDelete | Delete /api/dm/views/{id}/ | Delete view |
| DataManagerApi | ApiDmViewsList | Get /api/dm/views/ | List views |
| DataManagerApi | ApiDmViewsPartialUpdate | Patch /api/dm/views/{id}/ | Update view |
| DataManagerApi | ApiDmViewsRead | Get /api/dm/views/{id}/ | Get view details |
| DataManagerApi | ApiDmViewsReset | Delete /api/dm/views/reset/ | Reset project views |
| DataManagerApi | ApiDmViewsUpdate | Put /api/dm/views/{id}/ | Put view |
| ExportApi | ApiProjectsExportFormatsRead | Get /api/projects/{id}/export/formats | Get export formats |
| ExportApi | ApiProjectsExportRead | Get /api/projects/{id}/export | Easy export of tasks and annotations |
| ExportApi | ApiProjectsExportsConvertCreate | Post /api/projects/{id}/exports/{export_pk}/convert | Export conversion |
| ExportApi | ApiProjectsExportsCreate | Post /api/projects/{id}/exports/ | Create new export snapshot |
| ExportApi | ApiProjectsExportsDelete | Delete /api/projects/{id}/exports/{export_pk} | Delete export snapshot |
| ExportApi | ApiProjectsExportsDownloadRead | Get /api/projects/{id}/exports/{export_pk}/download | Download export snapshot as file in specified format |
| ExportApi | ApiProjectsExportsList | Get /api/projects/{id}/exports/ | List all export snapshots |
| ExportApi | ApiProjectsExportsRead | Get /api/projects/{id}/exports/{export_pk} | Get export snapshot by ID |
| ImportApi | ApiImportFileUploadDelete | Delete /api/import/file-upload/{id} | Delete file upload |
| ImportApi | ApiImportFileUploadPartialUpdate | Patch /api/import/file-upload/{id} | Update file upload |
| ImportApi | ApiImportFileUploadRead | Get /api/import/file-upload/{id} | Get file upload |
| ImportApi | ApiProjectsFileUploadsDelete | Delete /api/projects/{id}/file-uploads | Delete files |
| ImportApi | ApiProjectsFileUploadsList | Get /api/projects/{id}/file-uploads | Get files list |
| ImportApi | ApiProjectsImportCreate | Post /api/projects/{id}/import | Import tasks |
| InvitesApi | ApiInviteRead | Get /api/invite | Get organization invite link |
| InvitesApi | ApiInviteResetTokenCreate | Post /api/invite/reset-token | Reset organization token |
| LabelsApi | ApiLabelLinksCreate | Post /api/label_links/ | Create label links |
| LabelsApi | ApiLabelLinksDelete | Delete /api/label_links/{id}/ | Remove label link |
| LabelsApi | ApiLabelLinksList | Get /api/label_links/ | List label links |
| LabelsApi | ApiLabelLinksPartialUpdate | Patch /api/label_links/{id}/ | Update label link |
| LabelsApi | ApiLabelLinksRead | Get /api/label_links/{id}/ | Get label link |
| LabelsApi | ApiLabelsBulkCreate | Post /api/labels/bulk | Bulk update labels |
| LabelsApi | ApiLabelsCreate | Post /api/labels/ | Create labels |
| LabelsApi | ApiLabelsDelete | Delete /api/labels/{id}/ | Remove labels |
| LabelsApi | ApiLabelsList | Get /api/labels/ | List labels |
| LabelsApi | ApiLabelsPartialUpdate | Patch /api/labels/{id}/ | Update labels |
| LabelsApi | ApiLabelsRead | Get /api/labels/{id}/ | Get label |
| MachineLearningApi | ApiMlCreate | Post /api/ml/ | Add ML Backend |
| MachineLearningApi | ApiMlDelete | Delete /api/ml/{id} | Remove ML Backend |
| MachineLearningApi | ApiMlInteractiveAnnotatingCreate | Post /api/ml/{id}/interactive-annotating | Request Interactive Annotation |
| MachineLearningApi | ApiMlList | Get /api/ml/ | List ML backends |
| MachineLearningApi | ApiMlPartialUpdate | Patch /api/ml/{id} | Update ML Backend |
| MachineLearningApi | ApiMlRead | Get /api/ml/{id} | Get ML Backend |
| MachineLearningApi | ApiMlTrainCreate | Post /api/ml/{id}/train | Train |
| MachineLearningApi | ApiMlVersionsRead | Get /api/ml/{id}/versions | Get model versions |
| OrganizationsApi | ApiOrganizationsList | Get /api/organizations/ | List your organizations |
| OrganizationsApi | ApiOrganizationsMembershipsDelete | Delete /api/organizations/{id}/memberships/{user_pk}/ | Soft delete an organization member |
| OrganizationsApi | ApiOrganizationsMembershipsList | Get /api/organizations/{id}/memberships | Get organization members list |
| OrganizationsApi | ApiOrganizationsPartialUpdate | Patch /api/organizations/{id} | Update organization settings |
| OrganizationsApi | ApiOrganizationsRead | Get /api/organizations/{id} | Get organization settings |
| PredictionsApi | ApiPredictionsCreate | Post /api/predictions/ | Create prediction |
| PredictionsApi | ApiPredictionsDelete | Delete /api/predictions/{id}/ | Delete prediction |
| PredictionsApi | ApiPredictionsList | Get /api/predictions/ | List predictions |
| PredictionsApi | ApiPredictionsPartialUpdate | Patch /api/predictions/{id}/ | Update prediction |
| PredictionsApi | ApiPredictionsRead | Get /api/predictions/{id}/ | Get prediction details |
| PredictionsApi | ApiPredictionsUpdate | Put /api/predictions/{id}/ | Put prediction |
| ProjectsApi | ApiProjectsCreate | Post /api/projects/ | Create new project |
| ProjectsApi | ApiProjectsDelete | Delete /api/projects/{id}/ | Delete project |
| ProjectsApi | ApiProjectsImportsRead | Get /api/projects/{id}/imports/{import_pk}/ | Get project import info |
| ProjectsApi | ApiProjectsList | Get /api/projects/ | List your projects |
| ProjectsApi | ApiProjectsPartialUpdate | Patch /api/projects/{id}/ | Update project |
| ProjectsApi | ApiProjectsRead | Get /api/projects/{id}/ | Get project by ID |
| ProjectsApi | ApiProjectsReimportsRead | Get /api/projects/{id}/reimports/{reimport_pk}/ | Get project reimport info |
| ProjectsApi | ApiProjectsTasksDelete | Delete /api/projects/{id}/tasks/ | Delete all tasks |
| ProjectsApi | ApiProjectsTasksList | Get /api/projects/{id}/tasks/ | List project tasks |
| ProjectsApi | ApiProjectsValidateCreate | Post /api/projects/validate/ | Validate label config |
| ProjectsApi | ApiProjectsValidateCreate_0 | Post /api/projects/{id}/validate/ | Validate project label config |
| StorageApi | ApiStoragesExportList | Get /api/storages/export | List all export storages from the project |
| StorageApi | ApiStoragesExportTypesList | Get /api/storages/export/types | List all export storages types |
| StorageApi | ApiStoragesList | Get /api/storages/ | List all import storages from the project |
| StorageApi | ApiStoragesTypesList | Get /api/storages/types | List all import storages types |
| StorageAzureApi | ApiStoragesAzureCreate | Post /api/storages/azure/ | Create new storage |
| StorageAzureApi | ApiStoragesAzureDelete | Delete /api/storages/azure/{id} | Delete import storage |
| StorageAzureApi | ApiStoragesAzureList | Get /api/storages/azure/ | Get all import storage |
| StorageAzureApi | ApiStoragesAzurePartialUpdate | Patch /api/storages/azure/{id} | Update import storage |
| StorageAzureApi | ApiStoragesAzureRead | Get /api/storages/azure/{id} | Get import storage |
| StorageAzureApi | ApiStoragesAzureSyncCreate | Post /api/storages/azure/{id}/sync | Sync import storage |
| StorageAzureApi | ApiStoragesAzureValidateCreate | Post /api/storages/azure/validate | Validate import storage |
| StorageAzureApi | ApiStoragesExportAzureCreate | Post /api/storages/export/azure | Create export storage |
| StorageAzureApi | ApiStoragesExportAzureDelete | Delete /api/storages/export/azure/{id} | Delete export storage |
| StorageAzureApi | ApiStoragesExportAzureList | Get /api/storages/export/azure | Get all export storage |
| StorageAzureApi | ApiStoragesExportAzurePartialUpdate | Patch /api/storages/export/azure/{id} | Update export storage |
| StorageAzureApi | ApiStoragesExportAzureRead | Get /api/storages/export/azure/{id} | Get export storage |
| StorageAzureApi | ApiStoragesExportAzureSyncCreate | Post /api/storages/export/azure/{id}/sync | Sync export storage |
| StorageAzureApi | ApiStoragesExportAzureValidateCreate | Post /api/storages/export/azure/validate | Validate export storage |
| StorageGCSApi | ApiStoragesExportGcsCreate | Post /api/storages/export/gcs | Create export storage |
| StorageGCSApi | ApiStoragesExportGcsDelete | Delete /api/storages/export/gcs/{id} | Delete export storage |
| StorageGCSApi | ApiStoragesExportGcsList | Get /api/storages/export/gcs | Get all export storage |
| StorageGCSApi | ApiStoragesExportGcsPartialUpdate | Patch /api/storages/export/gcs/{id} | Update export storage |
| StorageGCSApi | ApiStoragesExportGcsRead | Get /api/storages/export/gcs/{id} | Get export storage |
| StorageGCSApi | ApiStoragesExportGcsSyncCreate | Post /api/storages/export/gcs/{id}/sync | Sync export storage |
| StorageGCSApi | ApiStoragesExportGcsValidateCreate | Post /api/storages/export/gcs/validate | Validate export storage |
| StorageGCSApi | ApiStoragesGcsCreate | Post /api/storages/gcs/ | Create import storage |
| StorageGCSApi | ApiStoragesGcsDelete | Delete /api/storages/gcs/{id} | Delete import storage |
| StorageGCSApi | ApiStoragesGcsList | Get /api/storages/gcs/ | Get all import storage |
| StorageGCSApi | ApiStoragesGcsPartialUpdate | Patch /api/storages/gcs/{id} | Update import storage |
| StorageGCSApi | ApiStoragesGcsRead | Get /api/storages/gcs/{id} | Get import storage |
| StorageGCSApi | ApiStoragesGcsSyncCreate | Post /api/storages/gcs/{id}/sync | Sync import storage |
| StorageGCSApi | ApiStoragesGcsValidateCreate | Post /api/storages/gcs/validate | Validate import storage |
| StorageLocalApi | ApiStoragesExportLocalfilesCreate | Post /api/storages/export/localfiles | Create export storage |
| StorageLocalApi | ApiStoragesExportLocalfilesDelete | Delete /api/storages/export/localfiles/{id} | Delete export storage |
| StorageLocalApi | ApiStoragesExportLocalfilesList | Get /api/storages/export/localfiles | Get all export storage |
| StorageLocalApi | ApiStoragesExportLocalfilesPartialUpdate | Patch /api/storages/export/localfiles/{id} | Update export storage |
| StorageLocalApi | ApiStoragesExportLocalfilesRead | Get /api/storages/export/localfiles/{id} | Get export storage |
| StorageLocalApi | ApiStoragesExportLocalfilesSyncCreate | Post /api/storages/export/localfiles/{id}/sync | Sync export storage |
| StorageLocalApi | ApiStoragesExportLocalfilesValidateCreate | Post /api/storages/export/localfiles/validate | Validate export storage |
| StorageLocalApi | ApiStoragesLocalfilesCreate | Post /api/storages/localfiles/ | Create import storage |
| StorageLocalApi | ApiStoragesLocalfilesDelete | Delete /api/storages/localfiles/{id} | Delete import storage |
| StorageLocalApi | ApiStoragesLocalfilesList | Get /api/storages/localfiles/ | Get all import storage |
| StorageLocalApi | ApiStoragesLocalfilesPartialUpdate | Patch /api/storages/localfiles/{id} | Update import storage |
| StorageLocalApi | ApiStoragesLocalfilesRead | Get /api/storages/localfiles/{id} | Get import storage |
| StorageLocalApi | ApiStoragesLocalfilesSyncCreate | Post /api/storages/localfiles/{id}/sync | Sync import storage |
| StorageLocalApi | ApiStoragesLocalfilesValidateCreate | Post /api/storages/localfiles/validate | Validate import storage |
| StorageRedisApi | ApiStoragesExportRedisCreate | Post /api/storages/export/redis | Create export storage |
| StorageRedisApi | ApiStoragesExportRedisDelete | Delete /api/storages/export/redis/{id} | Delete export storage |
| StorageRedisApi | ApiStoragesExportRedisList | Get /api/storages/export/redis | Get all export storage |
| StorageRedisApi | ApiStoragesExportRedisPartialUpdate | Patch /api/storages/export/redis/{id} | Update export storage |
| StorageRedisApi | ApiStoragesExportRedisRead | Get /api/storages/export/redis/{id} | Get export storage |
| StorageRedisApi | ApiStoragesExportRedisSyncCreate | Post /api/storages/export/redis/{id}/sync | Sync export storage |
| StorageRedisApi | ApiStoragesExportRedisValidateCreate | Post /api/storages/export/redis/validate | Validate export storage |
| StorageRedisApi | ApiStoragesRedisCreate | Post /api/storages/redis/ | Create import storage |
| StorageRedisApi | ApiStoragesRedisDelete | Delete /api/storages/redis/{id} | Delete import storage |
| StorageRedisApi | ApiStoragesRedisList | Get /api/storages/redis/ | Get all import storage |
| StorageRedisApi | ApiStoragesRedisPartialUpdate | Patch /api/storages/redis/{id} | Update import storage |
| StorageRedisApi | ApiStoragesRedisRead | Get /api/storages/redis/{id} | Get import storage |
| StorageRedisApi | ApiStoragesRedisSyncCreate | Post /api/storages/redis/{id}/sync | Sync import storage |
| StorageRedisApi | ApiStoragesRedisValidateCreate | Post /api/storages/redis/validate | Validate import storage |
| StorageS3Api | ApiStoragesExportS3Create | Post /api/storages/export/s3 | Create export storage |
| StorageS3Api | ApiStoragesExportS3Delete | Delete /api/storages/export/s3/{id} | Delete export storage |
| StorageS3Api | ApiStoragesExportS3List | Get /api/storages/export/s3 | Get all export storage |
| StorageS3Api | ApiStoragesExportS3PartialUpdate | Patch /api/storages/export/s3/{id} | Update export storage |
| StorageS3Api | ApiStoragesExportS3Read | Get /api/storages/export/s3/{id} | Get export storage |
| StorageS3Api | ApiStoragesExportS3SyncCreate | Post /api/storages/export/s3/{id}/sync | Sync export storage |
| StorageS3Api | ApiStoragesExportS3ValidateCreate | Post /api/storages/export/s3/validate | Validate export storage |
| StorageS3Api | ApiStoragesS3Create | Post /api/storages/s3/ | Create new storage |
| StorageS3Api | ApiStoragesS3Delete | Delete /api/storages/s3/{id} | Delete import storage |
| StorageS3Api | ApiStoragesS3List | Get /api/storages/s3/ | Get import storage |
| StorageS3Api | ApiStoragesS3PartialUpdate | Patch /api/storages/s3/{id} | Update import storage |
| StorageS3Api | ApiStoragesS3Read | Get /api/storages/s3/{id} | Get import storage |
| StorageS3Api | ApiStoragesS3SyncCreate | Post /api/storages/s3/{id}/sync | Sync import storage |
| StorageS3Api | ApiStoragesS3ValidateCreate | Post /api/storages/s3/validate | Validate import storage |
| TasksApi | ApiTasksCreate | Post /api/tasks/ | Create task |
| TasksApi | ApiTasksDelete | Delete /api/tasks/{id}/ | Delete task |
| TasksApi | ApiTasksList | Get /api/tasks/ | Get tasks list |
| TasksApi | ApiTasksPartialUpdate | Patch /api/tasks/{id}/ | Update task |
| TasksApi | ApiTasksRead | Get /api/tasks/{id}/ | Get task |
| UsersApi | ApiCurrentUserResetTokenCreate | Post /api/current-user/reset-token/ | Reset user token |
| UsersApi | ApiCurrentUserTokenList | Get /api/current-user/token | Get user token |
| UsersApi | ApiCurrentUserWhoamiRead | Get /api/current-user/whoami | Retrieve my user |
| UsersApi | ApiUsersCreate | Post /api/users/ | Create new user |
| UsersApi | ApiUsersDelete | Delete /api/users/{id}/ | Delete user |
| UsersApi | ApiUsersList | Get /api/users/ | List users |
| UsersApi | ApiUsersPartialUpdate | Patch /api/users/{id}/ | Update user details |
| UsersApi | ApiUsersRead | Get /api/users/{id}/ | Get user info |
| WebhooksApi | ApiWebhooksCreate | Post /api/webhooks/ | Create a webhook |
| WebhooksApi | ApiWebhooksDelete | Delete /api/webhooks/{id}/ | Delete webhook info |
| WebhooksApi | ApiWebhooksInfoList | Get /api/webhooks/info/ | Get all webhook actions |
| WebhooksApi | ApiWebhooksList | Get /api/webhooks/ | List all webhooks |
| WebhooksApi | ApiWebhooksPartialUpdate | Patch /api/webhooks/{id}/ | Update webhook info |
| WebhooksApi | ApiWebhooksRead | Get /api/webhooks/{id}/ | Get webhook info |
| WebhooksApi | ApiWebhooksUpdate | Put /api/webhooks/{id}/ | Save webhook info |
Documentation For Models
- Annotation
- AnnotationFilterOptions
- AzureBlobExportStorage
- AzureBlobImportStorage
- BaseTask
- BaseUser
- ConvertedFormat
- Data
- Data1
- DataManagerTaskSerializer
- Export
- ExportConvert
- ExportCreate
- FileUpload
- Filter
- FilterGroup
- GcsExportStorage
- GcsImportStorage
- ImportApi
- InlineResponse200
- InlineResponse2001
- InlineResponse2002
- InlineResponse2003
- InlineResponse201
- Label
- LabelCreate
- LabelLink
- LocalFilesExportStorage
- LocalFilesImportStorage
- MlBackend
- MlInteractiveAnnotatingRequest
- Organization
- OrganizationId
- OrganizationInvite
- OrganizationMemberUser
- Prediction
- Project
- ProjectImport
- ProjectLabelConfig
- ProjectReimport
- RedisExportStorage
- RedisImportStorage
- S3ExportStorage
- S3ImportStorage
- SerializationOption
- SerializationOptions
- TaskCreationResponse
- TaskFilterOptions
- TaskSimple
- UserSerializerWithProjects
- UserSimple
- View
- ViewReset
- Webhook
- WebhookSerializerForUpdate
Documentation For Authorization
Token
- Type: API key
Example
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)