Authenticatie, invoer en resultaat

IMG

POST https://api.altum.ai/labelling/img

Met dit eindpunt kunt u een afbeelding uploaden om te labelen.

Headers

Name	Type	Description
x-api-key*	string	Unieke API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)
Content-Type	string	multipath/form-data

Request Body

Name	Type	Description
image*	object	De afbeelding die in de aanvraag moet worden verzonden, moet als multipath/form-data-type worden geüpload.

422: Unprocessable Entity Verkeerd invoerformaat

{
	"detail": [
		{
			"loc": [
				"body",
				"image"
			],
			"msg": "field required",
			"type": "value_error.missing"
		}
	]
}

401: Unauthorized Geen toegang

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}

500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar

{
	"message": "Internal server error"
}

403: Forbidden Verboden

{
	"message": "Missing Authentication Token"
}

200: OK Succesvolle reactie

{
	"Output": {
		"Image_Class": "outdoor",
		"ConfidencePercent_Image_Class": "99.99",
		"Scene_Class1": "facade",
		"ConfidencePercent_Scene_Class1": "93.89"
	}
}

OR

{
	"Output": {
		"Image_Class": "outdoor",
		"ConfidencePercent_Image_Class": "100.0",
		"Scene_Class1": "balcony-garden",
		"ConfidencePercent_Scene_Class1": "36.92",
		"Scene_Class2": "facade",
		"ConfidencePercent_Scene_Class2": "59.15"
	}
}

OR

{
	"Output": {
		"Image_Class": "indoor",
		"ConfidencePercent_Image_Class": "100.0",
		"Room_Class": "bedroom",
		"ConfidencePercent_Room_Class": "99.22"
	}
}

OR

{
	"Output": {
		"Image_Class": "indoor",
		"ConfidencePercent_Image_Class": "99.9",
		"Room_Class": "other_room",
		"ConfidencePercent_Room_Class": "96.18",
		"Room_Subclass": "hall_corridor",
		"ConfidencePercent_Room_Subclass": "87.85"
	}
}

400: Bad Request Mislukte reactie

{
  "detail": "Please upload an image with one of the following formats: .jpg, .jpeg or .png"
}

URL

POST https://api.altum.ai/labelling/url

In plaats van het afbeeldingsbestand te uploaden, kunt u met dit eindpunt in plaats daarvan de openbare URL verzenden van de afbeelding die u wilt labelen.

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)

Request Body

Name	Type	Description
url*	string	De openbare URL van de afbeelding die u in het verzoek wilt verzenden

422: Unprocessable Entity Verkeerd invoerformaat

{
	"detail": [
		{
			"loc": [
				"body",
				"image"
			],
			"msg": "field required",
			"type": "value_error.missing"
		}
	]
}

500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar

{
	"message": "Internal server error"
}

403: Forbidden Verboden

{
	"message": "Missing Authentication Token"
}

401: Unauthorized Geen toegang

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}

200: OK Succesvolle reactie

{
	"Output": {
		"Image_Class": "outdoor",
		"ConfidencePercent_Image_Class": "99.99",
		"Scene_Class1": "facade",
		"ConfidencePercent_Scene_Class1": "93.89"
	}
}

OR

{
	"Output": {
		"Image_Class": "outdoor",
		"ConfidencePercent_Image_Class": "100.0",
		"Scene_Class1": "balcony-garden",
		"ConfidencePercent_Scene_Class1": "36.92",
		"Scene_Class2": "facade",
		"ConfidencePercent_Scene_Class2": "59.15"
	}
}

OR

{
	"Output": {
		"Image_Class": "indoor",
		"ConfidencePercent_Image_Class": "100.0",
		"Room_Class": "bedroom",
		"ConfidencePercent_Room_Class": "99.22"
	}
}

OR

{
	"Output": {
		"Image_Class": "indoor",
		"ConfidencePercent_Image_Class": "99.9",
		"Room_Class": "other_room",
		"ConfidencePercent_Room_Class": "96.18",
		"Room_Subclass": "hall_corridor",
		"ConfidencePercent_Room_Subclass": "87.85"
	}
}

400: Bad Request Mislukte reactie

{
  "detail": "The URL is not valid"
}

Request body

Voorbeeld verzoek

{"url":"https://cloud.funda.nl/valentina_media/149/998/977_1440x960.jpg"}