sdcalmes/speciesnet | API reference

Public

13 runs

Run sdcalmes/speciesnet with an API

Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.

Input schema

The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.

Field	Type	Default value	Description
image	string		Input camera trap image
confidence_threshold	number	0.1 Max: 1	Minimum confidence threshold for detections
iou_threshold	number	0.5 Max: 1	IoU threshold for non-maximum suppression
country_code	string		ISO 3166-1 alpha-3 country code for geographic filtering (e.g., 'USA', 'CAN', 'GBR')
admin1_region	string		First-level administrative division (US state codes like 'CA', 'TX')
model_version	None	v4.0.1a	SpeciesNet model version to use
run_mode	None	full_ensemble	Which components to run
return_top_k	integer	5 Min: 1 Max: 10	Number of top classifications to return

{
  "type": "object",
  "title": "Input",
  "required": [
    "image"
  ],
  "properties": {
    "image": {
      "type": "string",
      "title": "Image",
      "format": "uri",
      "x-order": 0,
      "description": "Input camera trap image"
    },
    "run_mode": {
      "enum": [
        "full_ensemble",
        "detector_only",
        "classifier_only"
      ],
      "type": "string",
      "title": "run_mode",
      "description": "Which components to run",
      "default": "full_ensemble",
      "x-order": 6
    },
    "country_code": {
      "type": "string",
      "title": "Country Code",
      "x-order": 3,
      "nullable": true,
      "description": "ISO 3166-1 alpha-3 country code for geographic filtering (e.g., 'USA', 'CAN', 'GBR')"
    },
    "return_top_k": {
      "type": "integer",
      "title": "Return Top K",
      "default": 5,
      "maximum": 10,
      "minimum": 1,
      "x-order": 7,
      "description": "Number of top classifications to return"
    },
    "admin1_region": {
      "type": "string",
      "title": "Admin1 Region",
      "x-order": 4,
      "nullable": true,
      "description": "First-level administrative division (US state codes like 'CA', 'TX')"
    },
    "iou_threshold": {
      "type": "number",
      "title": "Iou Threshold",
      "default": 0.5,
      "maximum": 1,
      "minimum": 0,
      "x-order": 2,
      "description": "IoU threshold for non-maximum suppression"
    },
    "model_version": {
      "enum": [
        "v4.0.1a",
        "v4.0.1b"
      ],
      "type": "string",
      "title": "model_version",
      "description": "SpeciesNet model version to use",
      "default": "v4.0.1a",
      "x-order": 5
    },
    "confidence_threshold": {
      "type": "number",
      "title": "Confidence Threshold",
      "default": 0.1,
      "maximum": 1,
      "minimum": 0,
      "x-order": 1,
      "description": "Minimum confidence threshold for detections"
    }
  }
}

Output schema

The shape of the response you’ll get when you run this model with an API.

Schema

{
  "type": "object",
  "title": "Output",
  "additionalProperties": true
}