Load a Model & Detect an Object | Amniscient Documentation

Initializes a model for inference and detects an object within an uploaded image file within a single API call. This eliminates the need to load a model before running detection.

Path parameters

model_idstringRequired

The model ID of an active and trained AI model within your organization.

Request

This endpoint expects a multipart form containing a file.

organization_idstringRequiredformat: "uuid"

Your organization's unique identifier.

filefileRequired

An image file you'd like to run detection on.

Response

200 - Detection successful

xywhlist of objectsOptional

An array of information related to the object detected. If an object was not detected, this array will be empty.

detection_foundbooleanOptional

A boolean value denoting whether an object was successfully detected in the image file provided.

inference_idstringOptionalformat: "uuid"

A unique identifier for the results of a successful inference call.

Errors

400

Bad Request Error

404

Not Found Error

1	import requests
2
3	url = "https://api.amniscient.com/inference/detect-with-model/model_id"
4
5	files = { "file": "open('string', 'rb')" }
6	payload = { "organization_id": "string" }
7	headers = {"x-api-key": "x-api-key"}
8
9	response = requests.post(url, data=payload, files=files, headers=headers)
10
11	print(response.json())

1	{
2	"xywh": [
3	{
4	"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
5	"confidence": 0.95,
6	"x": 0.5,
7	"y": 0.7,
8	"width": 0.4,
9	"height": 0.5,
10	"tag": {
11	"tag_key": "tag_value"
12	}
13	}
14	],
15	"detection_found": true,
16	"inference_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
17	}

Path parameters

Headers

Request

Response

Errors