Upload and Retrieve Data with Viam's Data Client API

async function connect(): Promise<VIAM.ViamClient> {
  // Replace "<API-KEY-ID>" (including brackets) with your machine's
  const API_KEY_ID = "<API-KEY-ID>";
  // Replace "<API-KEY>" (including brackets) with your machine's API key
  const API_KEY = "<API-KEY>";
  const opts: VIAM.ViamClientOptions = {
    serviceHost: "https://app.viam.com:443",
    credentials: {
      type: "api-key",
      authEntity: API_KEY_ID,
      payload: API_KEY,
    },
  };

  const client = await VIAM.createViamClient(opts);
  return client;
}

const appClient = await connect();
const dataClient = appClient.dataClient;

Parameters:

• binaryData List<int> (required)
• partId String (required)
• fileExtension String (required)
• componentType String? (optional)
• componentName String? (optional)
• methodName String? (optional)
• methodParameters Map<String, Any>? (optional)
• dataRequestTimes (DateTime, DateTime)? (optional)
• tags Iterable<String> (optional)

Returns:

• Future<String>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 try {
   final imageBytes = getPNGasBytes(); // Replace with your image bytes getter

   (DateTime, DateTime) dataRequestTimes = (
     DateTime(2025, 1, 15, 10, 30), // Start time
     DateTime(2025, 1, 15, 14, 45)  // End time
   );

   final fileId = await dataClient.binaryDataCaptureUpload(
     imageBytes,
     "<YOUR-PART-ID>",
     ".png",
     componentType: "rdk:component:camera",
     componentName: "camera-1",
     methodName: "ReadImage",
     dataRequestTimes: dataRequestTimes);

   print('Successfully uploaded binary data with fileId: $fileId');
 } catch (e) {
   print('Error uploading binary data: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• tabularData List<Map<String, dynamic>> (required)
• partId String (required)
• componentType String? (optional)
• componentName String? (optional)
• methodName String? (optional)
• methodParameters Map<String, Any>? (optional)
• dataRequestTimes List<(DateTime, DateTime)>? (optional)
• tags Iterable<String> (optional)

Returns:

• Future<String>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );

 try {
   // Define tabular data
   final List<Map<String, dynamic>> tabularData;
   tabularData = [{
     'readings': {
       "altitude_m": 50.2,
       "coordinate": {
         "latitude": 40.5,
         "longitude": -72.98
      }
     }
   }];

  // Define date request times
  final List<(DateTime, DateTime)> timeSpan = [(DateTime(2025, 1, 23, 11), DateTime(2025, 1, 23, 11, 0, 3))];

  // Upload captured tabular data
  final fileId = await dataClient.tabularDataCaptureUpload(
    tabularData,
    "<YOUR-PART-ID>",
    componentType: "rdk:component:movement_sensor",
    componentName: "movement_sensor-1",
    methodName: "Position",
    dataRequestTimes: timeSpan,
    tags: ["tag_1", "tag_2"]
  );
   print('Successfully uploaded captured tabular data: $fileId');
 } catch (e) {
   print('Error uploading captured tabular data: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• path String (required)
• partId String (required)
• fileName String? (optional)
• componentType String? (optional)
• componentName String? (optional)
• methodName String? (optional)
• methodParameters Map<String, Any>? (optional)
• tags Iterable<String> (optional)

Returns:

• Future<String>

Example:

import 'package:file_picker/file_picker.dart';
import 'package:cross_file/cross_file.dart';

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
);
final dataClient = _viam.dataClient;

// File picker function
Future<XFile?> pickTextFile() async {
  FilePickerResult? result = await FilePicker.platform.pickFiles(
    type: FileType.custom,
    allowedExtensions: ['txt', 'md', 'json', 'csv'],  // Add any other text file extensions you want to support
  );
 if (result != null) {
   return XFile(result.files.single.path!);
 }
   return null;
 }

// Upload text file function. Call this in onPressed in a button in your application.
Future<void> uploadTextFile() async {
  final file = await pickTextFile();
  if (file == null) return;

  try {
    // Get file name
    final fileName = file.name;

    // Upload the file
    final result = await _viam.dataClient.uploadFile(
      file.path,
      fileName: fileName,
      "<YOUR-PART-ID>",
      tags: ["text_file", "document"]
    );
    print('Upload success: $result');
  } catch (e) {
    print('Upload error: $e');
  }
 }

For more information, see the Flutter SDK Docs.

Parameters:

• bytes List<int> (required)
• partId String (required)
• fileExtension String (required)
• componentType String? (optional)
• componentName String? (optional)
• methodName String? (optional)
• methodParameters Map<String, Any>? (optional)
• dataRequestTimes (DateTime, DateTime)? (optional)
• tags Iterable<String> (optional)

Returns:

• Future<String>

Example:

import 'package:file_picker/file_picker.dart';
import 'dart:typed_data';

Future<Uint8List> pickVideoAsBytes() async {
  try {
    // Open file picker
    FilePickerResult? result = await FilePicker.platform.pickFiles(
      type: FileType.video,
      allowMultiple: false,
    );

    if (result == null || result.files.isEmpty) {
      throw Exception('No file selected');
    }

    // For mobile, we get the file path and read it
    final String? filePath = result.files.first.path;
    if (filePath == null) {
      throw Exception('Invalid file path');
    }

    // Read the file as bytes
    final File file = File(filePath);
    final Uint8List bytes = await file.readAsBytes();

    if (bytes.isEmpty) {
      throw Exception('File is empty');
    }

    print('Successfully read file: ${bytes.length} bytes');

    return bytes;
  } catch (e, stackTrace) {
    print('Error picking video: $e');
    print('Stack trace: $stackTrace');
    rethrow;
  }
}

void _uploadData() async {
  _viam = await Viam.withApiKey(
       dotenv.env['API_KEY_ID'] ?? '',
       dotenv.env['API_KEY'] ?? ''
   );
   final dataClient = _viam.dataClient;

   try {
     Uint8List video = await pickVideoAsBytes();

     (DateTime, DateTime) dataRequestTimes = (
       DateTime(2025, 1, 15, 10, 30), // Start time
       DateTime(2025, 1, 15, 14, 45)  // End time
     );

     final fileId = await dataClient.streamingDataCaptureUpload(
       video,
       "<YOUR-PART-ID>",
       ".mp4", // Replace with your desired file format
       componentType: "rdk:component:camera",
       componentName: "camera-1",
       dataRequestTimes: dataRequestTimes);

     print('Successfully uploaded streaming binary data with fileId: $fileId');
   } catch (e) {
     print('Error uploading streaming binary data: $e');
   }
}

For more information, see the Flutter SDK Docs.

Parameters:

• partId (string) (required): The ID of the part that owns the data.
• resourceName (string) (required): The name of the requested resource that captured the data. Ex: “my-sensor”.
• resourceSubtype (string) (required): The subtype of the requested resource that captured the data. Ex: “rdk:component:sensor”.
• methodName (string) (required): The data capture method name. Ex: “Readings”.

Returns:

• (Promise<null | [Date, Date, Record<string, JsonValue>]>): A tuple containing [timeCaptured, timeSynced, payload] or null if no data has been synced for the specified resource OR the most recently captured data was over a year ago.

For more information, see the TypeScript SDK Docs.

Parameters:

• partId String (required)
• resourceName String (required)
• resourceSubtype String (required)
• methodName String (required)

Returns:

• Future<({Map<String, dynamic> payload, DateTime timeCaptured, DateTime timeSynced})?>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 try {
   // Get latest tabular data
   final response = await dataClient.getLatestTabularData(
     "<YOUR-PART-ID>",
     "movement_sensor-1",
     "rdk:component:movement_sensor",
     "Position"
   );
   print('Successfully retrieved latest tabular data: $response');
 } catch (e) {
   print('Error retrieving latest tabular data: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• partId (string) (required): The ID of the part that owns the data.
• resourceName (string) (required): The name of the requested resource that captured the data.
• resourceSubtype (string) (required): The subtype of the requested resource that captured the data.
• methodName (string) (required): The data capture method name.
• startTime (Date) (optional): Optional start time (Date object) for requesting a specific range of data.
• endTime (Date) (optional): Optional end time (Date object) for requesting a specific range of data.

Returns:

• (Promise<TabularDataPoint[]>): An array of unified tabular data and metadata.

For more information, see the TypeScript SDK Docs.

Parameters:

• partId String (required)
• resourceName String (required)
• resourceSubtype String (required)
• methodName String (required)
• startTime DateTime? (required)
• endTime DateTime? (required)

Returns:

• Future<List<TabularDataPoint>>

Example:

 _viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 try {
  // Define date request times
  final startTime = DateTime(2025, 1, 23, 11);
  final endTime = DateTime(2025, 1, 23, 11, 0, 3);

  final tabularData = await dataClient.exportTabularData(
    "<YOUR-PART-ID>",
    "movement_sensor-1",
    "rdk:component:movement_sensor",
    "Position",
    startTime,
    endTime
  );

  for (var dataPoint in tabularData) {
    print(dataPoint.partId);
    print(dataPoint.resourceName);
    print(dataPoint.methodName);
    print(dataPoint.payload);
  }

  print('Successfully exported tabular data');
 } catch (e) {
  print('Error exporting tabular data: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• filter (Filter) (optional): Optional pb.Filter specifying tabular data to retrieve. No filter implies all tabular data.
• limit (number) (optional): The maximum number of entries to include in a page. Defaults to 50 if unspecfied.
• sortOrder (Order) (optional): The desired sort order of the data.
• last (string) (optional): Optional string indicating the ID of the last-returned data. If provided, the server will return the next data entries after the last ID.
• countOnly (boolean) (optional): Whether to return only the total count of entries.
• includeInternalData (boolean) (optional): Whether to retun internal data. Internal data is used for Viam-specific data ingestion, like cloud SLAM. Defaults to false.

Returns:

• (Promise<{ count: bigint; data: TabularData[]; last: string }>): An array of data objects, the count (number of entries), and the last-returned page ID.

For more information, see the TypeScript SDK Docs.

Parameters:

• filter Filter? (optional)
• limit int? (optional)
• sortOrder Order? (optional)
• last String? (optional)
• countOnly dynamic (optional)

Returns:

• Future<TabularDataByFilterResponse>

Example:

_viam = await Viam.withApiKey(
    dotenv.env['API_KEY_ID'] ?? '',
    dotenv.env['API_KEY'] ?? ''
);
final dataClient = _viam.dataClient;

try {
 // Create a filter to target specific tabular data
 final filter = Filter(
  componentName: "arm-1",
 );

 final response = await dataClient.tabularDataByFilter(
   filter: filter,
   limit: 10
 );
 print('Number of items: ${response.count.toInt()}');
 print('Total size: ${response.totalSizeBytes.toInt()}');
 for (var metadata in response.metadata) {
   print(metadata);
 }
 for (var data in response.data) {
   print(data);
 }

 print('Successfully retrieved tabular data by filter');
} catch (e) {
 print('Error retrieving tabular data by filter: $e');
}

For more information, see the Flutter SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization that owns the data.
• query (string) (required): The SQL query to run.

Returns:

• (Promise<(Object | any[])[]>): An array of data objects.

For more information, see the TypeScript SDK Docs.

Parameters:

• organizationId String (required)
• query String (required)

Returns:

• Future<List<Map<String, dynamic>>>

Example:

// List<Map<String, dynamic>>? _responseData;

 _viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 // Example SQL query
 final sqlQuery = "SELECT * FROM readings LIMIT 5";

 _responseData = await dataClient.tabularDataBySql(
   "<YOUR-ORG-ID>",
   sqlQuery
 );

For more information, see the Flutter SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization that owns the data.
• query (Uint8Array) (required): The MQL query to run as a list of BSON documents.
• useRecentData (boolean) (optional): Whether to query blob storage or your recent data store. Defaults to false.

Returns:

• (Promise<(Object | any[])[]>): An array of data objects.

For more information, see the TypeScript SDK Docs.

Parameters:

• organizationId String (required)
• query dynamic (required)
• useRecentData bool (optional)

Returns:

• Future<List<Map<String, dynamic>>>

Example:

// import 'package:bson/bson.dart';

// List<Map<String, dynamic>>? _responseData;

 _viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 final query = BsonCodec.serialize({
  "\$match": {
     "location_id": "<YOUR-LOCATION-ID>",
  }
 });

 final sort = BsonCodec.serialize({
   "\$sort": {"time_requested": -1}
   sqlQuery
 });

 final limit = BsonCodec.serialize({"\$limit": 1});

 final pipeline = [query.byteList, sort.byteList, limit.byteList];
 _responseData = await dataClient.tabularDataByMql(
  "<YOUR-ORG-ID>",
  pipeline
 );

For more information, see the Flutter SDK Docs.

Parameters:

• filter (Filter) (optional): Optional pb.Filter specifying binary data to retrieve. No filter implies all binary data.
• limit (number) (optional): The maximum number of entries to include in a page. Defaults to 50 if unspecfied.
• sortOrder (Order) (optional): The desired sort order of the data.
• last (string) (optional): Optional string indicating the ID of the last-returned data. If provided, the server will return the next data entries after the last ID.
• includeBinary (boolean) (optional): Whether to include binary file data with each retrieved file.
• countOnly (boolean) (optional): Whether to return only the total count of entries.
• includeInternalData (boolean) (optional): Whether to retun internal data. Internal data is used for Viam-specific data ingestion, like cloud SLAM. Defaults to false.

Returns:

• (Promise<{ count: bigint; data: BinaryData[]; last: string }>): An array of data objects, the count (number of entries), and the last-returned page ID.

For more information, see the TypeScript SDK Docs.

Parameters:

• filter Filter? (optional)
• limit int? (optional)
• sortOrder Order? (optional)
• last String? (optional)
• countOnly bool (optional)
• includeBinary bool (optional)

Returns:

• Future<BinaryDataByFilterResponse>

Example:

_viam = await Viam.withApiKey(
    dotenv.env['API_KEY_ID'] ?? '',
    dotenv.env['API_KEY'] ?? ''
);
final dataClient = _viam.dataClient;

try {
 // Create a filter to target specific binary data
 final filter = Filter(
  componentName: "camera-1",
 );

 final response = await dataClient.binaryDataByFilter(filter: filter, limit: 1);

 print('Number of items: ${response.count.toInt()}');
 print('Total size: ${response.totalSizeBytes.toInt()} bytes');
 for (var dataPoint in response.data) {
   print(dataPoint.binary);
   print(dataPoint.metadata);
 }

 print('Successfully retrieved binary data by filter');
} catch (e) {
 print('Error retrieving binary data by filter: $e');
}

For more information, see the Flutter SDK Docs.

Parameters:

• ids (BinaryID) (required): The IDs of the requested binary data.

Returns:

• (Promise<BinaryData[]>): An array of data objects.

For more information, see the TypeScript SDK Docs.

Parameters:

• binaryIds List<BinaryID> (required)
• includeBinary bool (optional)

Returns:

• Future<BinaryDataByIDsResponse>

Example:

 _viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 try {
  final binaryIDs = [
   BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>'),
   BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>')
  ];

  final response = await dataClient.binaryDataByIds(
    binaryIDs,
    includeBinary: true
  );

  for (var dataPoint in response.data) {
    print(dataPoint.binary);
    print(dataPoint.metadata);
  }

  print('Successfully retrieved binary data by IDs');
 } catch (e) {
  print('Error retrieving binary data by IDs: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• organizationId (string) (required): The ID of organization to delete data from.
• deleteOlderThanDays (number) (required): Delete data that was captured more than this many days ago. For example if deleteOlderThanDays is 10, this deletes any data that was captured more than 10 days ago. If it is 0, all existing data is deleted.

Returns:

• (Promise): The number of items deleted.

For more information, see the TypeScript SDK Docs.

Parameters:

• organizationId String (required)
• olderThanDays int (required)

Returns:

• Future<int>

Example:

_viam = await Viam.withApiKey(
    dotenv.env['API_KEY_ID'] ?? '',
    dotenv.env['API_KEY'] ?? ''
);
final dataClient = _viam.dataClient;

try {
  dataClient.deleteTabularData("<YOUR-ORG-ID>", 5);

 print('Successfully deleted tabular data');
} catch (e) {
 print('Error deleting tabular data: $e');
}

For more information, see the Flutter SDK Docs.

Parameters:

• filter (Filter) (optional): Optional pb.Filter specifying binary data to delete. No filter implies all binary data.
• includeInternalData (boolean) (optional): Whether or not to delete internal data. Default is true.

Returns:

• (Promise): The number of items deleted.

For more information, see the TypeScript SDK Docs.

Parameters:

• filter Filter? (required)
• includeInternalData bool (optional)

Returns:

• Future<int>

Example:

 _viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 try {
  // Create a filter to target specific binary data. Must include at least one org ID.
  final filter = Filter(
   componentName: "camera-1",
   organizationIds: ["<YOUR-ORG-ID>"]
  );

  final deletedCount = await dataClient.deleteBinaryDataByFilter(filter);

  print('Successfully deleted binary data by filter: count $deletedCount');
 } catch (e) {
  print('Error deleting binary data by filter: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• ids (BinaryID) (required): The IDs of the data to be deleted. Must be non-empty.

Returns:

• (Promise): The number of items deleted.

For more information, see the TypeScript SDK Docs.

Parameters:

• binaryIds List<BinaryID> (required)

Returns:

• Future<int>

Example:

 _viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 try {
  final binaryIDs = [
   BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>'),
   BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>')
  ];

  // Call the function to delete binary data
  await dataClient.deleteBinaryDataByIds(binaryIDs);

  print('Successfully deleted binary data');
 } catch (e) {
  print('Error deleting binary data: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• tags (string) (required): The list of tags to add to specified binary data. Must be non-empty.
• ids (BinaryID) (required): The IDs of the data to be tagged. Must be non-empty.

Returns:

• (Promise)

For more information, see the TypeScript SDK Docs.

Parameters:

• tags List<String> (required)
• binaryIds List<BinaryID> (required)

Returns:

• Future<void>

Example:

 _viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 try {
  // List of tags to add
  final List<String> tags = ['tag_1', 'tag_2'];

  final binaryIDs = [
   BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>'),
   BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>')
  ];

  // Call the function with both tags and IDs
  await dataClient.addTagsToBinaryDataByIds(tags, binaryIDs);

  print('Successfully added tags to binary IDs');
 } catch (e) {
  print('Error adding tags: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• tags (string) (required): The tags to add to the data.
• filter (Filter) (optional): Optional pb.Filter specifying binary data to add tags to. No filter implies all binary data.

Returns:

• (Promise)

For more information, see the TypeScript SDK Docs.

Parameters:

• tags List<String> (required)
• filter Filter? (required)

Returns:

• Future<void>

Example:

 _viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 try {
  // List of tags to add
  final List<String> tags = ['tag_1', 'tag_2'];

  // Create a filter to target specific binary data
  final filter = Filter(
   componentName: "camera-1",
  );

  await dataClient.addTagsToBinaryDataByFilter(tags, filter);

  print('Successfully added tags to binary data by filter');
 } catch (e) {
  print('Error adding tags to binary data by filter: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• tags (string) (required): List of tags to remove from specified binary data. Must be non-empty.
• ids (BinaryID) (required): The IDs of the data to be edited. Must be non-empty.

Returns:

• (Promise): The number of items deleted.

For more information, see the TypeScript SDK Docs.

Parameters:

• tags List<String> (required)
• binaryIds List<BinaryID> (required)

Returns:

• Future<int>

Example:

 _viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 try {
  // List of tags to remove
  final List<String> tags = ['tag_1', 'tag_2'];

  final binaryIDs = [
   BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>'),
   BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>')
  ];

  // Call the function with both tags and IDs
  await dataClient.removeTagsFromBinaryDataByIds(tags, binaryIDs);

  print('Successfully removed tags from binary IDs');
 } catch (e) {
  print('Error removing tags: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• tags (string) (required): List of tags to remove from specified binary data. Must be non-empty.
• filter (Filter) (optional): Optional pb.Filter specifying binary data to add tags to. No filter implies all binary data.

Returns:

• (Promise): The number of items deleted.

For more information, see the TypeScript SDK Docs.

Parameters:

• tags List<String> (required)
• filter Filter? (required)

Returns:

• Future<int>

Example:

_viam = await Viam.withApiKey(
    dotenv.env['API_KEY_ID'] ?? '',
    dotenv.env['API_KEY'] ?? ''
);
final dataClient = _viam.dataClient;

try {
 // List of tags to remove
 final List<String> tags = ['tag_1', 'tag_2'];

 // Create a filter to target specific binary data
 final filter = Filter(
  componentName: "camera-1",
 );

 await dataClient.removeTagsFromBinaryDataByFilter(tags, filter);

 print('Successfully removed tags from binary data by filter');
} catch (e) {
 print('Error removing tags from binary data by filter: $e');
}

For more information, see the Flutter SDK Docs.

Parameters:

• filter (Filter) (optional): Optional pb.Filter specifying what data to get tags from. No filter implies all data.

Returns:

• (Promise<string[]>): The list of tags.

For more information, see the TypeScript SDK Docs.

Parameters:

• filter Filter? (required)

Returns:

• Future<List<String>>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
);
final dataClient = _viam.dataClient;

try {
 // Create a filter to target specific binary data
 final filter = Filter(
   componentName: "camera-1",
 );

 // Call the function to get tags by filter
 final tags = await dataClient.tagsByFilter(filter);

 print('Successfully got tags: $tags');
} catch (e) {
 print('Error getting tags: $e');
}

For more information, see the Flutter SDK Docs.

Parameters:

• id (BinaryID) (required)
• label (string) (required): A label for the bounding box.
• xMinNormalized (number) (required): The min X value of the bounding box normalized from 0 to 1.
• yMinNormalized (number) (required): The min Y value of the bounding box normalized from 0 to 1.
• xMaxNormalized (number) (required): The max X value of the bounding box normalized from 0 to 1.
• yMaxNormalized (number) (required): The max Y value of the bounding box normalized from 0 to 1.

Returns:

• (Promise): The bounding box ID.

For more information, see the TypeScript SDK Docs.

Parameters:

• label String (required)
• binaryId BinaryID (required)
• xMinNormalized double (required)
• yMinNormalized double (required)
• xMaxNormalized double (required)
• yMaxNormalized double (required)

Returns:

• Future<String>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

// Example binary ID to add a bounding box to
final binaryId = BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>');

try {
  await dataClient.addBoundingBoxToImageById(
    "label",
    binaryId,
    0,
   .1,
   .2,
   .3
  );
  print('Successfully added bounding box');
} catch (e) {
  print('Error adding bounding box: $e');
}

For more information, see the Flutter SDK Docs.

Parameters:

• binId (BinaryID) (required): The ID of the image to remove the bounding box from.
• bboxId (string) (required): The ID of the bounding box to remove.

Returns:

• (Promise)

For more information, see the TypeScript SDK Docs.

Parameters:

• bboxId String (required)
• binaryId BinaryID (required)

Returns:

• Future<void>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

// Example binary ID to remove a bounding box from
final binaryId = BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>');

// Example bbox ID (label)
final bboxId = "label";
try {
  await dataClient.removeBoundingBoxFromImageById(
    bboxId,
    binaryId,
  );

  print('Successfully removed bounding box');
} catch (e) {
  print('Error removing bounding box: $e');
}

For more information, see the Flutter SDK Docs.

Parameters:

• filter (Filter) (optional): Optional pb.Filter specifying what data to get tags from. No filter implies all labels.

Returns:

• (Promise<string[]>): The list of bounding box labels.

For more information, see the TypeScript SDK Docs.

Parameters:

• filter Filter? (required)

Returns:

• Future<List<String>>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
);
final dataClient = _viam.dataClient;

try {
 // Create a filter to target specific binary data
 final filter = Filter(
   componentName: "camera-1",
 );

 // Call the function to get bounding box labels by filter
 final labels = await dataClient.boundingBoxLabelsByFilter(filter);

 print('Successfully got bounding box labels: $labels');
} catch (e) {
 print('Error getting bounding box labels: $e');
}

For more information, see the Flutter SDK Docs.

Parameters:

• organizationId (string) (required): Organization to retrieve connection for.

Returns:

• (Promise): Hostname of the federated database.

For more information, see the TypeScript SDK Docs.

Parameters:

• organizationId String (required)

Returns:

• Future<DatabaseConnection>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
);
final dataClient = _viam.dataClient;

try {
 final String organizationId = "<YOUR-ORG-ID>";
 // Get the database connection
 final connection = await dataClient.getDatabaseConnection(organizationId);

 final hostname = connection.hostname;
 final mongodbUri = connection.mongodbUri;

 print('Successfully got database connection: with hostname $hostname and mongodbUri $mongodbUri');
} catch (e) {
 print('Error getting database connection: $e');
}

For more information, see the Flutter SDK Docs.

Parameters:

• organizationId (string) (required): The ID of the organization.
• password (string) (required): The password of the user.

Returns:

• (Promise)

For more information, see the TypeScript SDK Docs.

Parameters:

• organizationId String (required)
• password String (required)

Returns:

• Future<void>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
);
final dataClient = _viam.dataClient;

try {
 await dataClient.configureDatabaseUser(
   "<YOUR-ORG-ID>",
   "PasswordLikeThis1234",
 );

 print('Successfully configured database user for this organization');
} catch (e) {
 print('Error configuring database user: $e');
}

For more information, see the Flutter SDK Docs.

Parameters:

• ids (BinaryID) (required): The IDs of binary data to add to dataset.
• datasetId (string) (required): The ID of the dataset to be added to.

Returns:

• (Promise)

For more information, see the TypeScript SDK Docs.

Parameters:

• binaryIds List<BinaryID> (required)
• datasetId String (required)

Returns:

• Future<void>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

// Example binary IDs to add to the dataset
 final binaryIds = [
   BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>'),
   BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>')
 ];

 // Dataset ID where the binary data will be added
 const datasetId = '<YOUR-DATASET-ID>';

 try {
   // Add the binary data to the dataset
   await dataClient.addBinaryDataToDatasetByIds(
     binaryIds,
     datasetId
 );
   print('Successfully added binary data to dataset');
 } catch (e) {
   print('Error adding binary data to dataset: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• ids (BinaryID) (required): The IDs of the binary data to remove from dataset.
• datasetId (string) (required): The ID of the dataset to be removed from.

Returns:

• (Promise)

For more information, see the TypeScript SDK Docs.

Parameters:

• binaryIds List<BinaryID> (required)
• datasetId String (required)

Returns:

• Future<void>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

// Example binary IDs to remove from the dataset
 final binaryIds = [
   BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>'),
   BinaryID(fileId: '<YOUR-FILE-ID>', organizationId: '<YOUR-ORG-ID>', locationId: '<YOUR-LOCATION-ID>')
 ];

 // Dataset ID where the binary data will be removed
 const datasetId = '<YOUR-DATASET-ID>';

 try {
   // Remove the binary data from the dataset
   await dataClient.removeBinaryDataFromDatasetByIds(
     binaryIds,
     datasetId
 );
   print('Successfully removed binary data from dataset');
 } catch (e) {
   print('Error removing binary data from dataset: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• orgId String (required)
• name String (required)

Returns:

• Future<String>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 // Org ID to create dataset in
 const orgId = '<YOUR-ORG-ID>';

 try {
   // Create the dataset
   final datasetId = await dataClient.createDataset(orgId, "example-dataset");
   print('Successfully created dataset');
 } catch (e) {
   print('Error creating dataset: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• id String (required)

Returns:

• Future<void>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 // Dataset ID to delete
 const datasetId = '<YOUR-DATASET-ID>';

 try {
   // Delete the dataset
   await dataClient.deleteDataset(datasetId);
   print('Successfully deleted dataset');
 } catch (e) {
   print('Error deleting dataset: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• id String (required)
• name String (required)

Returns:

• Future<void>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 // Dataset ID to rename
 const datasetId = '<YOUR-DATASET-ID>';

 try {
   // Rename the dataset
   await dataClient.renameDataset(datasetId, "new-name");
   print('Successfully renamed dataset');
 } catch (e) {
   print('Error renaming dataset: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• orgId String (required)

Returns:

• Future<List<Dataset>>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 // Org ID to list datasets from
 const orgId = '<YOUR-ORG-ID>';

 try {
   // List datasets from org
   final datasets = await dataClient.listDatasetsByOrganizationID(orgId);
   print('Successfully retrieved list of datasets: $datasets');
 } catch (e) {
   print('Error retrieving list of datasets: $e');
 }

For more information, see the Flutter SDK Docs.

Parameters:

• ids List<String> (required)

Returns:

• Future<List<Dataset>>

Example:

_viam = await Viam.withApiKey(
     dotenv.env['API_KEY_ID'] ?? '',
     dotenv.env['API_KEY'] ?? ''
 );
 final dataClient = _viam.dataClient;

 const datasetIds = ["<YOUR-DATASET-ID>", "<YOUR-DATASET-ID-2>"];

 try {
   // List datasets by ids
   final datasets = await dataClient.listDatasetsByIDs(datasetIds);
   print('Successfully listed datasets by ids: $datasets');
 } catch (e) {
   print('Error retrieving datasets by ids: $e');
 }

For more information, see the Flutter SDK Docs.