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

ClassMethodHTTP requestDescription
AnnotationsApiApiAnnotationsDeleteDelete /api/annotations/{id}/Delete annotation
AnnotationsApiApiAnnotationsPartialUpdatePatch /api/annotations/{id}/Update annotation
AnnotationsApiApiAnnotationsReadGet /api/annotations/{id}/Get annotation by its ID
AnnotationsApiApiTasksAnnotationsCreatePost /api/tasks/{id}/annotations/Create annotation
AnnotationsApiApiTasksAnnotationsListGet /api/tasks/{id}/annotations/Get all task annotations
DataManagerApiApiDmActionsCreatePost /api/dm/actions/Post actions
DataManagerApiApiDmActionsListGet /api/dm/actions/Get actions
DataManagerApiApiDmColumnsListGet /api/dm/columns/Get data manager columns
DataManagerApiApiDmProjectListGet /api/dm/project/Get project state
DataManagerApiApiDmViewsCreatePost /api/dm/views/Create view
DataManagerApiApiDmViewsDeleteDelete /api/dm/views/{id}/Delete view
DataManagerApiApiDmViewsListGet /api/dm/views/List views
DataManagerApiApiDmViewsPartialUpdatePatch /api/dm/views/{id}/Update view
DataManagerApiApiDmViewsReadGet /api/dm/views/{id}/Get view details
DataManagerApiApiDmViewsResetDelete /api/dm/views/reset/Reset project views
DataManagerApiApiDmViewsUpdatePut /api/dm/views/{id}/Put view
ExportApiApiProjectsExportFormatsReadGet /api/projects/{id}/export/formatsGet export formats
ExportApiApiProjectsExportReadGet /api/projects/{id}/exportEasy export of tasks and annotations
ExportApiApiProjectsExportsConvertCreatePost /api/projects/{id}/exports/{export_pk}/convertExport conversion
ExportApiApiProjectsExportsCreatePost /api/projects/{id}/exports/Create new export snapshot
ExportApiApiProjectsExportsDeleteDelete /api/projects/{id}/exports/{export_pk}Delete export snapshot
ExportApiApiProjectsExportsDownloadReadGet /api/projects/{id}/exports/{export_pk}/downloadDownload export snapshot as file in specified format
ExportApiApiProjectsExportsListGet /api/projects/{id}/exports/List all export snapshots
ExportApiApiProjectsExportsReadGet /api/projects/{id}/exports/{export_pk}Get export snapshot by ID
ImportApiApiImportFileUploadDeleteDelete /api/import/file-upload/{id}Delete file upload
ImportApiApiImportFileUploadPartialUpdatePatch /api/import/file-upload/{id}Update file upload
ImportApiApiImportFileUploadReadGet /api/import/file-upload/{id}Get file upload
ImportApiApiProjectsFileUploadsDeleteDelete /api/projects/{id}/file-uploadsDelete files
ImportApiApiProjectsFileUploadsListGet /api/projects/{id}/file-uploadsGet files list
ImportApiApiProjectsImportCreatePost /api/projects/{id}/importImport tasks
InvitesApiApiInviteReadGet /api/inviteGet organization invite link
InvitesApiApiInviteResetTokenCreatePost /api/invite/reset-tokenReset organization token
LabelsApiApiLabelLinksCreatePost /api/label_links/Create label links
LabelsApiApiLabelLinksDeleteDelete /api/label_links/{id}/Remove label link
LabelsApiApiLabelLinksListGet /api/label_links/List label links
LabelsApiApiLabelLinksPartialUpdatePatch /api/label_links/{id}/Update label link
LabelsApiApiLabelLinksReadGet /api/label_links/{id}/Get label link
LabelsApiApiLabelsBulkCreatePost /api/labels/bulkBulk update labels
LabelsApiApiLabelsCreatePost /api/labels/Create labels
LabelsApiApiLabelsDeleteDelete /api/labels/{id}/Remove labels
LabelsApiApiLabelsListGet /api/labels/List labels
LabelsApiApiLabelsPartialUpdatePatch /api/labels/{id}/Update labels
LabelsApiApiLabelsReadGet /api/labels/{id}/Get label
MachineLearningApiApiMlCreatePost /api/ml/Add ML Backend
MachineLearningApiApiMlDeleteDelete /api/ml/{id}Remove ML Backend
MachineLearningApiApiMlInteractiveAnnotatingCreatePost /api/ml/{id}/interactive-annotatingRequest Interactive Annotation
MachineLearningApiApiMlListGet /api/ml/List ML backends
MachineLearningApiApiMlPartialUpdatePatch /api/ml/{id}Update ML Backend
MachineLearningApiApiMlReadGet /api/ml/{id}Get ML Backend
MachineLearningApiApiMlTrainCreatePost /api/ml/{id}/trainTrain
MachineLearningApiApiMlVersionsReadGet /api/ml/{id}/versionsGet model versions
OrganizationsApiApiOrganizationsListGet /api/organizations/List your organizations
OrganizationsApiApiOrganizationsMembershipsDeleteDelete /api/organizations/{id}/memberships/{user_pk}/Soft delete an organization member
OrganizationsApiApiOrganizationsMembershipsListGet /api/organizations/{id}/membershipsGet organization members list
OrganizationsApiApiOrganizationsPartialUpdatePatch /api/organizations/{id}Update organization settings
OrganizationsApiApiOrganizationsReadGet /api/organizations/{id}Get organization settings
PredictionsApiApiPredictionsCreatePost /api/predictions/Create prediction
PredictionsApiApiPredictionsDeleteDelete /api/predictions/{id}/Delete prediction
PredictionsApiApiPredictionsListGet /api/predictions/List predictions
PredictionsApiApiPredictionsPartialUpdatePatch /api/predictions/{id}/Update prediction
PredictionsApiApiPredictionsReadGet /api/predictions/{id}/Get prediction details
PredictionsApiApiPredictionsUpdatePut /api/predictions/{id}/Put prediction
ProjectsApiApiProjectsCreatePost /api/projects/Create new project
ProjectsApiApiProjectsDeleteDelete /api/projects/{id}/Delete project
ProjectsApiApiProjectsImportsReadGet /api/projects/{id}/imports/{import_pk}/Get project import info
ProjectsApiApiProjectsListGet /api/projects/List your projects
ProjectsApiApiProjectsPartialUpdatePatch /api/projects/{id}/Update project
ProjectsApiApiProjectsReadGet /api/projects/{id}/Get project by ID
ProjectsApiApiProjectsReimportsReadGet /api/projects/{id}/reimports/{reimport_pk}/Get project reimport info
ProjectsApiApiProjectsTasksDeleteDelete /api/projects/{id}/tasks/Delete all tasks
ProjectsApiApiProjectsTasksListGet /api/projects/{id}/tasks/List project tasks
ProjectsApiApiProjectsValidateCreatePost /api/projects/validate/Validate label config
ProjectsApiApiProjectsValidateCreate_0Post /api/projects/{id}/validate/Validate project label config
StorageApiApiStoragesExportListGet /api/storages/exportList all export storages from the project
StorageApiApiStoragesExportTypesListGet /api/storages/export/typesList all export storages types
StorageApiApiStoragesListGet /api/storages/List all import storages from the project
StorageApiApiStoragesTypesListGet /api/storages/typesList all import storages types
StorageAzureApiApiStoragesAzureCreatePost /api/storages/azure/Create new storage
StorageAzureApiApiStoragesAzureDeleteDelete /api/storages/azure/{id}Delete import storage
StorageAzureApiApiStoragesAzureListGet /api/storages/azure/Get all import storage
StorageAzureApiApiStoragesAzurePartialUpdatePatch /api/storages/azure/{id}Update import storage
StorageAzureApiApiStoragesAzureReadGet /api/storages/azure/{id}Get import storage
StorageAzureApiApiStoragesAzureSyncCreatePost /api/storages/azure/{id}/syncSync import storage
StorageAzureApiApiStoragesAzureValidateCreatePost /api/storages/azure/validateValidate import storage
StorageAzureApiApiStoragesExportAzureCreatePost /api/storages/export/azureCreate export storage
StorageAzureApiApiStoragesExportAzureDeleteDelete /api/storages/export/azure/{id}Delete export storage
StorageAzureApiApiStoragesExportAzureListGet /api/storages/export/azureGet all export storage
StorageAzureApiApiStoragesExportAzurePartialUpdatePatch /api/storages/export/azure/{id}Update export storage
StorageAzureApiApiStoragesExportAzureReadGet /api/storages/export/azure/{id}Get export storage
StorageAzureApiApiStoragesExportAzureSyncCreatePost /api/storages/export/azure/{id}/syncSync export storage
StorageAzureApiApiStoragesExportAzureValidateCreatePost /api/storages/export/azure/validateValidate export storage
StorageGCSApiApiStoragesExportGcsCreatePost /api/storages/export/gcsCreate export storage
StorageGCSApiApiStoragesExportGcsDeleteDelete /api/storages/export/gcs/{id}Delete export storage
StorageGCSApiApiStoragesExportGcsListGet /api/storages/export/gcsGet all export storage
StorageGCSApiApiStoragesExportGcsPartialUpdatePatch /api/storages/export/gcs/{id}Update export storage
StorageGCSApiApiStoragesExportGcsReadGet /api/storages/export/gcs/{id}Get export storage
StorageGCSApiApiStoragesExportGcsSyncCreatePost /api/storages/export/gcs/{id}/syncSync export storage
StorageGCSApiApiStoragesExportGcsValidateCreatePost /api/storages/export/gcs/validateValidate export storage
StorageGCSApiApiStoragesGcsCreatePost /api/storages/gcs/Create import storage
StorageGCSApiApiStoragesGcsDeleteDelete /api/storages/gcs/{id}Delete import storage
StorageGCSApiApiStoragesGcsListGet /api/storages/gcs/Get all import storage
StorageGCSApiApiStoragesGcsPartialUpdatePatch /api/storages/gcs/{id}Update import storage
StorageGCSApiApiStoragesGcsReadGet /api/storages/gcs/{id}Get import storage
StorageGCSApiApiStoragesGcsSyncCreatePost /api/storages/gcs/{id}/syncSync import storage
StorageGCSApiApiStoragesGcsValidateCreatePost /api/storages/gcs/validateValidate import storage
StorageLocalApiApiStoragesExportLocalfilesCreatePost /api/storages/export/localfilesCreate export storage
StorageLocalApiApiStoragesExportLocalfilesDeleteDelete /api/storages/export/localfiles/{id}Delete export storage
StorageLocalApiApiStoragesExportLocalfilesListGet /api/storages/export/localfilesGet all export storage
StorageLocalApiApiStoragesExportLocalfilesPartialUpdatePatch /api/storages/export/localfiles/{id}Update export storage
StorageLocalApiApiStoragesExportLocalfilesReadGet /api/storages/export/localfiles/{id}Get export storage
StorageLocalApiApiStoragesExportLocalfilesSyncCreatePost /api/storages/export/localfiles/{id}/syncSync export storage
StorageLocalApiApiStoragesExportLocalfilesValidateCreatePost /api/storages/export/localfiles/validateValidate export storage
StorageLocalApiApiStoragesLocalfilesCreatePost /api/storages/localfiles/Create import storage
StorageLocalApiApiStoragesLocalfilesDeleteDelete /api/storages/localfiles/{id}Delete import storage
StorageLocalApiApiStoragesLocalfilesListGet /api/storages/localfiles/Get all import storage
StorageLocalApiApiStoragesLocalfilesPartialUpdatePatch /api/storages/localfiles/{id}Update import storage
StorageLocalApiApiStoragesLocalfilesReadGet /api/storages/localfiles/{id}Get import storage
StorageLocalApiApiStoragesLocalfilesSyncCreatePost /api/storages/localfiles/{id}/syncSync import storage
StorageLocalApiApiStoragesLocalfilesValidateCreatePost /api/storages/localfiles/validateValidate import storage
StorageRedisApiApiStoragesExportRedisCreatePost /api/storages/export/redisCreate export storage
StorageRedisApiApiStoragesExportRedisDeleteDelete /api/storages/export/redis/{id}Delete export storage
StorageRedisApiApiStoragesExportRedisListGet /api/storages/export/redisGet all export storage
StorageRedisApiApiStoragesExportRedisPartialUpdatePatch /api/storages/export/redis/{id}Update export storage
StorageRedisApiApiStoragesExportRedisReadGet /api/storages/export/redis/{id}Get export storage
StorageRedisApiApiStoragesExportRedisSyncCreatePost /api/storages/export/redis/{id}/syncSync export storage
StorageRedisApiApiStoragesExportRedisValidateCreatePost /api/storages/export/redis/validateValidate export storage
StorageRedisApiApiStoragesRedisCreatePost /api/storages/redis/Create import storage
StorageRedisApiApiStoragesRedisDeleteDelete /api/storages/redis/{id}Delete import storage
StorageRedisApiApiStoragesRedisListGet /api/storages/redis/Get all import storage
StorageRedisApiApiStoragesRedisPartialUpdatePatch /api/storages/redis/{id}Update import storage
StorageRedisApiApiStoragesRedisReadGet /api/storages/redis/{id}Get import storage
StorageRedisApiApiStoragesRedisSyncCreatePost /api/storages/redis/{id}/syncSync import storage
StorageRedisApiApiStoragesRedisValidateCreatePost /api/storages/redis/validateValidate import storage
StorageS3ApiApiStoragesExportS3CreatePost /api/storages/export/s3Create export storage
StorageS3ApiApiStoragesExportS3DeleteDelete /api/storages/export/s3/{id}Delete export storage
StorageS3ApiApiStoragesExportS3ListGet /api/storages/export/s3Get all export storage
StorageS3ApiApiStoragesExportS3PartialUpdatePatch /api/storages/export/s3/{id}Update export storage
StorageS3ApiApiStoragesExportS3ReadGet /api/storages/export/s3/{id}Get export storage
StorageS3ApiApiStoragesExportS3SyncCreatePost /api/storages/export/s3/{id}/syncSync export storage
StorageS3ApiApiStoragesExportS3ValidateCreatePost /api/storages/export/s3/validateValidate export storage
StorageS3ApiApiStoragesS3CreatePost /api/storages/s3/Create new storage
StorageS3ApiApiStoragesS3DeleteDelete /api/storages/s3/{id}Delete import storage
StorageS3ApiApiStoragesS3ListGet /api/storages/s3/Get import storage
StorageS3ApiApiStoragesS3PartialUpdatePatch /api/storages/s3/{id}Update import storage
StorageS3ApiApiStoragesS3ReadGet /api/storages/s3/{id}Get import storage
StorageS3ApiApiStoragesS3SyncCreatePost /api/storages/s3/{id}/syncSync import storage
StorageS3ApiApiStoragesS3ValidateCreatePost /api/storages/s3/validateValidate import storage
TasksApiApiTasksCreatePost /api/tasks/Create task
TasksApiApiTasksDeleteDelete /api/tasks/{id}/Delete task
TasksApiApiTasksListGet /api/tasks/Get tasks list
TasksApiApiTasksPartialUpdatePatch /api/tasks/{id}/Update task
TasksApiApiTasksReadGet /api/tasks/{id}/Get task
UsersApiApiCurrentUserResetTokenCreatePost /api/current-user/reset-token/Reset user token
UsersApiApiCurrentUserTokenListGet /api/current-user/tokenGet user token
UsersApiApiCurrentUserWhoamiReadGet /api/current-user/whoamiRetrieve my user
UsersApiApiUsersCreatePost /api/users/Create new user
UsersApiApiUsersDeleteDelete /api/users/{id}/Delete user
UsersApiApiUsersListGet /api/users/List users
UsersApiApiUsersPartialUpdatePatch /api/users/{id}/Update user details
UsersApiApiUsersReadGet /api/users/{id}/Get user info
WebhooksApiApiWebhooksCreatePost /api/webhooks/Create a webhook
WebhooksApiApiWebhooksDeleteDelete /api/webhooks/{id}/Delete webhook info
WebhooksApiApiWebhooksInfoListGet /api/webhooks/info/Get all webhook actions
WebhooksApiApiWebhooksListGet /api/webhooks/List all webhooks
WebhooksApiApiWebhooksPartialUpdatePatch /api/webhooks/{id}/Update webhook info
WebhooksApiApiWebhooksReadGet /api/webhooks/{id}/Get webhook info
WebhooksApiApiWebhooksUpdatePut /api/webhooks/{id}/Save webhook info

Documentation For Models

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)

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.

# Structs

No description provided by the author
No description provided by the author
APIClient manages communication with the Label Studio API API vv1.11.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GenericSwaggerError Provides access to the body, error and model on returned errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
User token.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
JSON dict with parameters.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Task creation response.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Project owner.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author