Authentication, input and response

IMG

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

This endpoint allows you to upload an image for labeling.

Headers

Name	Type	Description
x-api-key*	string	Unique API Key from Altum. Create one via Mopsus (https://mopsus.altum.ai)
Content-Type	string	multipath/form-data

Request Body

Name	Type	Description
image*	object	The image to be sent in the request must be uploaded as a multipath/form-data type.

422: Unprocessable Entity Wrong input format

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

401: Unauthorized No access

500: Internal Server Error Service is not available and/or down

403: Forbidden Forbidden

200: OK Successful response

400: Bad Request Unsuccessful response

URL

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

Instead of uploading the image file, this endpoint allows you to rather send the public URL of the image you want labelled.

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)

Request Body

Name	Type	Description
url*	string	The public URL of the image you wish to send int he request

422: Unprocessable Entity Wrong input format

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

500: Internal Server Error Service is not available and/or down

403: Forbidden Forbidden

401: Unauthorized No access

200: OK Succesfull response

400: Bad Request Unsuccesfull response

Request body

Example request

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