npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

matroid-node-client

v1.0.1

Published

The Matroid API allows you to easily manipulate and use detectors. You can browse through our fine-tuned detectors, customize detectors with your own images and videos, and even import your own tensorflow models as detectors. Public detectors are availabl

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

matroid-engmatroid-eng

Keywords

Readme

matroid_public_api

MatroidPublicApi - JavaScript client for matroid_public_api The Matroid API allows you to easily manipulate and use detectors. You can browse through our fine-tuned detectors, customize detectors with your own images and videos, and even import your own tensorflow models as detectors. Public detectors are available for all of our users, and you can quickly train custom detectors when needed. You can further polish your detectors through our simple web GUI, where you can create composite detectors or topic detectors, give your detectors feedback, and automatically annotate training data.

Once you are happy with your detector, you can use it to classify images, locate objects in videos, and perform real-time detections in live video streams. Create a stream of your camera feed, and you can use our API to get real-time detections from your detector by creating Monitorings. You can also use our API to get the latest detections from your detector, and you can even get the latest detections from a specific time in the past. Feel free to use this documentation page to learn and test out your API requests. But be careful! Any changes performed may be permanent.

Getting Started

To get started with the Matroid API, you will need to create an account and obtain an API key. You can do this by signing up on our website. Once you have your API key, you can start using the API to create and manage detectors.

Authentication

The Matroid API uses bearer token authentication. You will need to include your API key in the Authorization header of your requests. For example:

Authorization: Bearer YOUR_API_KEY

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.14.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install matroid_public_api --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your matroid_public_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var MatroidPublicApi = require('matroid_public_api');

var defaultClient = MatroidPublicApi.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new MatroidPublicApi.AccountsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiV1AccountGet(callback);

Documentation for API Endpoints

All URIs are relative to https://app.matroid.com

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- MatroidPublicApi.AccountsApi | apiV1AccountGet | GET /api/v1/account | Get account information MatroidPublicApi.AccountsApi | apiV1OauthTokenPost | POST /api/v1/oauth/token | Refresh OAuth token MatroidPublicApi.BucketTasksApi | apiV1BucketTasksPost | POST /api/v1/bucket-tasks | Create S3 bucket CSV task MatroidPublicApi.BucketTasksApi | apiV1BucketTasksTaskIdDownloadResultsGet | GET /api/v1/bucket-tasks/{taskId}/download_results | Download bucket search CSV MatroidPublicApi.DatasetApi | apiV1DatasetDatasetIdMediaImMediaIdGet | GET /api/v1/dataset/{datasetId}/media/im/{mediaId} | Get media from dataset MatroidPublicApi.DatasetApi | apiV1DetectorsDetectorIdAddDataPost | POST /api/v1/detectors/{detectorId}/add-data | Add images to a detector's dataset (New Studio) MatroidPublicApi.DetectorsApi | apiV1DetectorsDetectorIdDelete | DELETE /api/v1/detectors/{detectorId} | Delete a detector MatroidPublicApi.DetectorsApi | apiV1DetectorsDetectorIdFeedbackFeedbackIdDelete | DELETE /api/v1/detectors/{detectorId}/feedback/{feedbackId} | Delete detector feedback MatroidPublicApi.DetectorsApi | apiV1DetectorsDetectorIdFeedbackGet | GET /api/v1/detectors/{detectorId}/feedback | Get detector feedback MatroidPublicApi.DetectorsApi | apiV1DetectorsDetectorIdFeedbackImagePost | POST /api/v1/detectors/{detectorId}/feedback_image | Add image feedback to a detector MatroidPublicApi.DetectorsApi | apiV1DetectorsDetectorIdFeedbackPost | POST /api/v1/detectors/{detectorId}/feedback | Add feedback to a detector MatroidPublicApi.DetectorsApi | apiV1DetectorsDetectorIdFinalizePost | POST /api/v1/detectors/{detectorId}/finalize | Train detector MatroidPublicApi.DetectorsApi | apiV1DetectorsDetectorIdGet | GET /api/v1/detectors/{detectorId} | Get detector info MatroidPublicApi.DetectorsApi | apiV1DetectorsDetectorIdMigrateDownPut | PUT /api/v1/detectors/{detectorId}/migrate-down | Migrate a detector back to the legacy studio MatroidPublicApi.DetectorsApi | apiV1DetectorsDetectorIdMigratePut | PUT /api/v1/detectors/{detectorId}/migrate | Migrate detector to new studio MatroidPublicApi.DetectorsApi | apiV1DetectorsDetectorIdRedoPost | POST /api/v1/detectors/{detectorId}/redo | Redo detector MatroidPublicApi.DetectorsApi | apiV1DetectorsGet | GET /api/v1/detectors | List detectors (Deprecated) MatroidPublicApi.DetectorsApi | apiV1DetectorsSearchGet | GET /api/v1/detectors/search | Search detectors MatroidPublicApi.DetectorsApi | apiV1DetectorsUploadPost | POST /api/v1/detectors/upload | Import a detector MatroidPublicApi.DetectorsApi | createDetector | POST /api/v1/detectors | Create detector MatroidPublicApi.ImagesApi | apiV1DetectorsDetectorIdClassifyImagePost | POST /api/v1/detectors/{detectorId}/classify_image | Classify image MatroidPublicApi.ImagesApi | apiV1DetectorsDetectorIdGetSaliencyMapPost | POST /api/v1/detectors/{detectorId}/get_saliency_map | Get saliency map MatroidPublicApi.ImagesApi | apiV1LocalizePost | POST /api/v1/localize | Localize objects in images MatroidPublicApi.LabelsApi | apiV1DetectorsDetectorIdLabelsLabelIdDelete | DELETE /api/v1/detectors/{detectorId}/labels/{labelId} | Delete label MatroidPublicApi.LabelsApi | apiV1DetectorsDetectorIdLabelsLabelIdGet | GET /api/v1/detectors/{detectorId}/labels/{labelId} | Get label images MatroidPublicApi.LabelsApi | apiV1DetectorsDetectorIdLabelsLabelIdPatch | PATCH /api/v1/detectors/{detectorId}/labels/{labelId} | Update annotations MatroidPublicApi.LabelsApi | apiV1DetectorsDetectorIdLabelsPost | POST /api/v1/detectors/{detectorId}/labels | Create label with images MatroidPublicApi.LabelsApi | apiV1ImagesAnnotationsGet | GET /api/v1/images/annotations | Get annotations MatroidPublicApi.LicensesApi | apiV1LicensePost | POST /api/v1/license | Create onprem license MatroidPublicApi.MonitoringsApi | apiV1MonitoringsBatchPut | PUT /api/v1/monitorings/batch | Bulk update monitorings MatroidPublicApi.MonitoringsApi | apiV1MonitoringsGet | GET /api/v1/monitorings | Search monitorings MatroidPublicApi.MonitoringsApi | apiV1MonitoringsMonitoringIdDelete | DELETE /api/v1/monitorings/{monitoringId} | Delete a monitoring MatroidPublicApi.MonitoringsApi | apiV1MonitoringsMonitoringIdGet | GET /api/v1/monitorings/{monitoringId} | Get monitoring results MatroidPublicApi.MonitoringsApi | apiV1MonitoringsMonitoringIdKillPost | POST /api/v1/monitorings/{monitoringId}/kill | Kill a monitoring MatroidPublicApi.MonitoringsApi | apiV1MonitoringsMonitoringIdPut | PUT /api/v1/monitorings/{monitoringId} | Update a monitoring MatroidPublicApi.MonitoringsApi | apiV1MonitoringsMonitoringIdWatchGet | GET /api/v1/monitorings/{monitoringId}/watch | Watch for new detections MatroidPublicApi.MonitoringsApi | apiV1StreamsStreamIdMonitorDetectorIdPost | POST /api/v1/streams/{streamId}/monitor/{detectorId} | Create a monitoring on a stream MatroidPublicApi.OnPremApi | apiV1SystemStatusGet | GET /api/v1/system_status | Get system status MatroidPublicApi.SimilaritySearchApi | apiV1CollectionTasksTaskIdDelete | DELETE /api/v1/collection-tasks/{taskId} | Delete collection index MatroidPublicApi.SimilaritySearchApi | apiV1CollectionTasksTaskIdGet | GET /api/v1/collection-tasks/{taskId} | Get collection index MatroidPublicApi.SimilaritySearchApi | apiV1CollectionTasksTaskIdImageQueryPost | POST /api/v1/collection-tasks/{taskId}/image-query | Query collection index by image MatroidPublicApi.SimilaritySearchApi | apiV1CollectionTasksTaskIdKillPost | POST /api/v1/collection-tasks/{taskId}/kill | Kill collection index MatroidPublicApi.SimilaritySearchApi | apiV1CollectionTasksTaskIdPut | PUT /api/v1/collection-tasks/{taskId} | Update collection index MatroidPublicApi.SimilaritySearchApi | apiV1CollectionTasksTaskIdScoresQueryPost | POST /api/v1/collection-tasks/{taskId}/scores-query | Query collection index by detector scores MatroidPublicApi.SimilaritySearchApi | apiV1CollectionTasksTaskIdTextQueryPost | POST /api/v1/collection-tasks/{taskId}/text-query | Query collection index by text MatroidPublicApi.SimilaritySearchApi | apiV1CollectionsCollectionIdCollectionTasksPost | POST /api/v1/collections/{collectionId}/collection-tasks | Create collection index MatroidPublicApi.SimilaritySearchApi | apiV1CollectionsCollectionIdDelete | DELETE /api/v1/collections/{collectionId} | Delete collection MatroidPublicApi.SimilaritySearchApi | apiV1CollectionsCollectionIdGet | GET /api/v1/collections/{collectionId} | Get collection MatroidPublicApi.SimilaritySearchApi | apiV1CollectionsPost | POST /api/v1/collections | Create collection MatroidPublicApi.StreamsApi | apiV1FrameRecordingsTaskIdDownloadGet | GET /api/v1/frame-recordings/{taskId}/download | Download frame recording MatroidPublicApi.StreamsApi | apiV1StreamsBatchPost | POST /api/v1/streams/batch | Batch create streams MatroidPublicApi.StreamsApi | apiV1StreamsGet | GET /api/v1/streams | Search streams MatroidPublicApi.StreamsApi | apiV1StreamsPost | POST /api/v1/streams | Create stream MatroidPublicApi.StreamsApi | apiV1StreamsStreamIdClipsDateClipIdGet | GET /api/v1/streams/{streamId}/clips/{date}/{clipId} | Get recording clip MatroidPublicApi.StreamsApi | apiV1StreamsStreamIdClipsGet | GET /api/v1/streams/{streamId}/clips | Find recording clips MatroidPublicApi.StreamsApi | apiV1StreamsStreamIdDelete | DELETE /api/v1/streams/{streamId} | Delete a stream MatroidPublicApi.StreamsApi | apiV1StreamsStreamIdPushImagePost | POST /api/v1/streams/{streamId}/push_image | Push image to stream MatroidPublicApi.StreamsApi | apiV1StreamsStreamIdPushVideoPost | POST /api/v1/streams/{streamId}/push_video | Push video file to stream MatroidPublicApi.StreamsApi | apiV1StreamsStreamIdPut | PUT /api/v1/streams/{streamId} | Update a stream MatroidPublicApi.TemporalTaskApi | apiV1MonitoringsMonitoringIdProcessClipsPost | POST /api/v1/monitorings/{monitoringId}/process-clips | Process existing stream clips with monitoring MatroidPublicApi.TemporalTaskApi | apiV1StreamsStreamIdSampleStreamPost | POST /api/v1/streams/{streamId}/sample-stream | Sample frames from stream MatroidPublicApi.TemporalTaskApi | apiV1StreamsStreamIdTemporalTaskPost | POST /api/v1/streams/{streamId}/temporal-task | Run temporal task inference on a stream MatroidPublicApi.TemporalTaskApi | apiV1StreamsStreamIdTemporalTasksGet | GET /api/v1/streams/{streamId}/temporal-tasks | Get stream temporal tasks MatroidPublicApi.TemporalTaskApi | apiV1TemporalTaskPost | POST /api/v1/temporal-task | Create temporal task MatroidPublicApi.TemporalTaskApi | apiV1TemporalTasksGet | GET /api/v1/temporal-tasks | Get existing temporal tasks MatroidPublicApi.TemporalTaskApi | apiV1TemporalTasksTaskIdDelete | DELETE /api/v1/temporal-tasks/{taskId} | Delete temporal task MatroidPublicApi.TemporalTaskApi | apiV1TemporalTasksTaskIdGet | GET /api/v1/temporal-tasks/{taskId} | Get temporal task details MatroidPublicApi.TemporalTaskApi | apiV1TemporalTasksTaskIdKillPut | PUT /api/v1/temporal-tasks/{taskId}/kill | Kill temporal task MatroidPublicApi.TemporalTaskApi | apiV1TemporalTasksTaskIdPredsJsonGet | GET /api/v1/temporal-tasks/{taskId}/preds.json | Get temporal task prediction results MatroidPublicApi.UsersApi | apiV1TestUsersPost | POST /api/v1/test_users | Create test user MatroidPublicApi.UsersApi | apiV1TestUsersUserIdDelete | DELETE /api/v1/test_users/{userId} | Delete test user MatroidPublicApi.VideoSummaryApi | apiV1StreamsStreamIdSummariesGet | GET /api/v1/streams/{streamId}/summaries | Get stream summaries MatroidPublicApi.VideoSummaryApi | apiV1StreamsStreamIdSummarizePost | POST /api/v1/streams/{streamId}/summarize | Create stream summary MatroidPublicApi.VideoSummaryApi | apiV1SummariesGet | GET /api/v1/summaries | Get existing summaries MatroidPublicApi.VideoSummaryApi | apiV1SummariesSummaryIdDelete | DELETE /api/v1/summaries/{summaryId} | Delete video summary MatroidPublicApi.VideoSummaryApi | apiV1SummariesSummaryIdGet | GET /api/v1/summaries/{summaryId} | Get video summary MatroidPublicApi.VideoSummaryApi | apiV1SummariesSummaryIdTracksCsvGet | GET /api/v1/summaries/{summaryId}/tracks.csv | Get video summary tracks CSV MatroidPublicApi.VideoSummaryApi | apiV1SummariesSummaryIdVideoMp4Get | GET /api/v1/summaries/{summaryId}/video.mp4 | Get video summary mp4 file MatroidPublicApi.VideosApi | apiV1DetectorsDetectorIdClassifyVideoPost | POST /api/v1/detectors/{detectorId}/classify_video | Classify video MatroidPublicApi.VideosApi | apiV1VideosVideoIdGet | GET /api/v1/videos/{videoId} | Get video results

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)