anatools.anaclient.api.api module

API Module

class api(url, status_url, headers, verbose=False)

Bases: object

addMember(organizationId, email, role)

cancelDataset(workspaceId, datasetId)

close()

createAPIKey(name, scope='user', organizationId=None, workspaceId=None, expires=None)

createAnalytics(workspaceId, datasetId, type, tags=None)

createAnnotation(workspaceId, datasetId, format, mapId=None, tags=None)

createAnnotationMap(organizationId, name, description=None, tags=None)

createChannel(organizationId, name, description=None, volumes=None, instance=None, timeout=None, interfaceVersion=None)

createDataset(workspaceId, graphId, name, description=None, runs=1, seed=0, priority=1, tags=[])

createGANDataset(workspaceId, datasetId, modelId, name, description='', tags=[])

createInpaint(volumeId, location, files=[], destination=None, dilation=5, inputType='MASK', outputType='SATRGB_BACKGROUND')

createLLMPrompt(prompt, baseChannel, nodeType, nodeName)

createMLInference(workspaceId, datasetId, modelId, mapId=None, tags=[])

createMLModel(workspaceId, datasetId, architectureId, name, description=None, parameters=None, tags=[])

createMixedDataset(workspaceId, name, parameters, description='', seed=0, tags=[])

createPreview(workspaceId, graphId)

createRemoteDevelopment(channelId=None, channelVersion=None, instanceType=None, fields=None)

createSSHKey(name, key)

createUMAP(workspaceId, name, datasetIds, samples, description=None, seed=None, tags=None)

createVolume(organizationId, name, description=None, permission=None, tags=None)

createWorkspace(organizationId, name, description='', channelIds=[], volumeIds=[], code=None, tags=[])

datasetUpload(workspaceId, filename, filesize, description, tags=[])

datasetUploadFinalizer(workspaceId, uploadId, key, parts)

deleteAPIKey(name)

deleteAnalytics(workspaceId, analyticsId)

deleteAnnotation(workspaceId, annotationId)

deleteAnnotationMap(mapId)

deleteChannel(channelId, organizationId=None)

deleteDataset(workspaceId, datasetId)

deleteGANDataset(datasetId, workspaceId)

deleteGANModel(modelId)

deleteGraph(workspaceId, graphId)

deleteInpaint(volumeId, inpaintId)

deleteLLMPrompt(promptId)

deleteMLInference(workspaceId, inferenceId)

deleteMLModel(workspaceId, modelId)

deleteRemoteDevelopment(editorSessionId, fields=None)

deleteSSHKey(name)

deleteUMAP(umapId, workspaceId)

deleteVolume(volumeId, organizationId=None)

deleteVolumeData(volumeId, keys=[])

deleteWorkspace(workspaceId)

deployChannel(channelId, alias=None)

downloadAnnotation(workspaceId, annotationId)

downloadAnnotationMap(mapId)

downloadDataset(workspaceId, datasetId)

downloadGANModel(modelId)

downloadGraph(workspaceId, graphId)

downloadMLInference(workspaceId, inferenceId)

downloadMLModel(workspaceId, modelId, checkpoint=None)

editAnalytics(workspaceId, analyticsId, tags=None)

editAnnotation(workspaceId, annotationId, tags=None)

editAnnotationMap(mapId, name=None, description=None, tags=None)

editChannel(channelId, name=None, description=None, volumes=None, instance=None, timeout=None, status=None, interfaceVersion=None, preview=None)

editDataset(workspaceId, datasetId, name=None, description=None, pause=None, priority=None, tags=None)

editGANModel(modelId, name=None, description=None, flags=None)

editGraph(workspaceId, graphId, name=None, description=None, graph=None, tags=None)

editMLInference(workspaceId, inferenceId, tags=None)

editMLModel(workspaceId, modelId, name=None, description=None, tags=None)

editMember(organizationId, email, role)

editOrganization(organizationId, name)

editVolume(volumeId, name=None, description=None, permission=None, tags=[])

editWorkspace(workspaceId, name=None, description=None, channelIds=None, volumeIds=None, ganIds=None, mapIds=None, tags=[])

errorhandler(response, call)

getAPIKeyContext(apiKey)

getAPIKeys(apiKey=None, name=None)

getAnalytics(workspaceId, analyticsId=None, datasetId=None, cursor=None, limit=100, filters={}, fields=None)

getAnalyticsTypes()

getAnnotationFormats()

getAnnotationMaps(organizationId, workspaceId, mapId, cursor=None, limit=100, filters={}, fields=None)

getAnnotations(workspaceId, datasetId, annotationId, cursor=None, limit=100, filters={}, fields=None)

getChannelDeployment(deploymentId)

getChannelDocumentation(channelId)

getChannelSchema(channelId)

getChannels(organizationId=None, workspaceId=None, channelId=None, limit=100, cursor=None, filters={}, fields=None)

getCurrentUserContext()

Fetches the current user’s context using the Bearer token in session headers.

getDatasetFiles(workspaceId, datasetId, path, limit=100, cursor=None)

getDatasetJobs(organizationId, workspaceId, datasetId=None, cursor=None, limit=100, filters={}, fields=None)

getDatasetLog(workspaceId, datasetId, runId, fields=None)

getDatasetRuns(workspaceId, datasetId, state=None, fields=None)

getDatasets(workspaceId, datasetId=None, cursor=None, limit=100, filters={}, fields=None)

getDefaultGraph(channelId)

getGANDatasets(datasetId, workspaceId, gandatasetId, limit=100, cursor=None, fields=None)

getGANModels(organizationId, workspaceId, modelId, limit=100, cursor=None, filters={}, fields=None)

getGraphs(workspaceId, graphId=None, name=None, email=None, staged=True, limit=100, cursor=None, filters={}, fields=None)

getImageAnnotation(workspaceId, datasetId, filename, fields=None)

getImageMask(workspaceId, datasetId, filename, fields=None)

getImageMetadata(workspaceId, datasetId, filename, fields=None)

getInpaintLog(volumeId, inpaintId, fields=None)

getInpaints(volumeId, inpaintId=None, limit=100, cursor=None, fields=None)

getInvitations(organizationId=None, limit=100, cursor=None)

getLLMBaseChannels()

getLLMChannelNodeTypes()

getLLMResponse(promptId, fields=None)

getMLArchitectures(fields=None)

getMLInferenceMetrics(workspaceId, inferenceId)

getMLInferences(workspaceId, inferenceId=None, datasetId=None, modelId=None, cursor=None, limit=100, filters={}, fields=None)

getMLModels(workspaceId, datasetId=None, modelId=None, cursor=None, limit=100, filters={}, fields=None)

getMembers(organizationId=None, limit=100, cursor=None)

getNodeDocumentation(channelId, node, fields=None)

getOrganizations(organizationId=None, limit=100, cursor=None, fields=None)

getPreview(workspaceId, previewId, fields=None)

getSDKCompatibility()

getSSHKeys(fields=None)

getSystemNotifications()

getSystemStatus(serviceId=None)

getTypeFields(typeName)

Get all fields available for a specific GraphQL type.

Parameters

typeName (str) – The name of the GraphQL type to introspect

Returns

List of field names available on the specified type

getTypes()

Get the data types from the GraphQL schema.

Returns

A dictionary of data types from the GraphQL schema

getUMAPs(umapId, datasetId, workspaceId, limit=100, cursor=None, filters={}, fields=None)

getVolumeData(volumeId, keys=[], dir=None, recursive=False, cursor=None, limit=100)

getVolumes(organizationId=None, workspaceId=None, volumeId=None, cursor=None, limit=100, filters={}, fields=None)

getWorkspaces(organizationId=None, workspaceId=None, cursor=None, limit=100, filters={}, fields=None)

inviteRemoteDevelopment(editorSessionId, email)

listRemoteDevelopment(organizationId=None, fields=None)

login(email, password)

mountVolumes(volumes)

mountWorkspaces(workspaces)

removeMember(organizationId, email)

setDefaultGraph(channelId, workspaceId, graphId)

startRemoteDevelopment(editorSessionId, fields=None)

stopRemoteDevelopment(editorSessionId, fields=None)

uploadChannelDocumentation(channelId, keys=[])

uploadGANModel(organizationId, name, size, description, flags='', tags=[])

uploadGANModelFinalizer(organizationId, uploadId, key, parts)

uploadGraph(workspaceId, channelId, graph, name, description='', staged=False, tags=[])

uploadMLModel(workspaceId, architectureId, name, size, description=None, tags=[])

uploadMLModelFinalizer(workspaceId, key, uploadId, parts)

uploadVolumeData(volumeId, key, size)

uploadVolumeDataFinalizer(volumeId, uploadId, key, parts)