Jump to Content
Nucleus
GuidesRecipesREST API ReferenceChangelogPython API Reference
Create an AccountConnect with SalesNucleus
REST API Reference
Create an AccountConnect with Sales
GuidesRecipesREST API ReferenceChangelogPython API Reference

Nucleus API

  • Introduction to Nucleus

Datasets

  • Create Datasetpost
  • Create Dataset From Projectpost
  • Get Dataset Infoget
  • List Datasetsget
  • Delete Datasetdelete
  • Get Dataset Scale Task Infoget

2D Data

  • Add Imagespost
  • Get Dataset Item
    • Get Dataset Item by Reference IDget
    • Get Dataset Item by Scale Item IDget
    • Get Dataset Item by Absolute Indexget
  • List Dataset Itemsget
  • Export Datasetget
  • Delete Dataset Item
    • Delete Dataset Item by Reference IDdelete
    • Delete Dataset Item by Scale Item IDdelete
    • Delete Dataset Item by Absolute Indexdelete

Video and 3D Data

  • Add Scenespost
  • Get Sceneget

Ground Truth Annotations

  • Add Annotationspost
  • Add Segmentation Annotationspost
  • Get Annotationget
  • Delete Annotationsget

Model Predictions

  • Add Modelpost
  • List Modelsget
  • Upload Model Predictionspost
  • Calculate Model Metricspost
  • Get Model Predictions
    • Export All Model Predictionsget
    • Get All Model Predictions of Item by Reference IDget
    • Get Model Prediction by Annotation IDget
    • Get Model Prediction by Absolute Indexget
  • Delete Modeldelete

Slices

  • Create Slicepost
  • Add to Slicepost
  • Get Slice Infoget
  • Delete Slicedelete
  • Export Slicepost
    • Export Slice (Legacy)get
  • Get Slice Scale Task Infoget

Send to Labeling

  • Send to Labelingpost

Indexing

  • Set Continuous Indexingpost
  • Create Image Indexpost
  • Create Object Indexpost
  • Upload Custom Indexpost
  • Check Custom Index Job Statusget
  • Delete Custom Indexdelete
  • Export Dataset Embeddingsget
  • Async Export Dataset Embeddingspost
    • Monitor Export Dataset Embeddingsget
  • Export Slice Embeddingsget
  • Async Export Slice Embeddingspost
    • Monitor Export Slice Embeddingsget

Autotag

  • List Autotagsget
  • Export Autotag Itemsget
  • Export Autotag Training Itemsget
  • Delete Autotagdelete

Async Jobs

  • List Async Jobspost
  • Check Async Job Statusget

Categorization Annotations

TODO:

  • add_taxonomy endpoint + payload schema
  • annotation schema

https://nucleus.scale.com/docs/adding-category-annotations-and-predictions