API docs by Redocly

CASTL: ImmoMOM Image API Service (0.1)

Download OpenAPI specification:Download

CASTL AG: contact@mom-ai.mom

REST-API Service für ImmoMOM von CASTL zur Bearbeitung und Klassifizierung von Bildmaterial.

Service APIs

BentoML Service API endpoints for inference.

room_recognition(Image → JSON)

Accepts Image and returns a label for that Image in a JSON.

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "label": "string",
  • "score": 0,
  • "order": 0,
  • "run_time": 0
}

retouch_with_3mods(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and JSON with 3 strength modifiers and returns an enhanced Image based on those 3 Strength Modifiers.

Request Body schema: multipart/form-data
required
image
string <binary>
object (StrengthModifierNeurop)

Responses

Request samples

Content type
multipart/form-data
{
  "image": null,
  "mod_strength": {
    "contrast": 1,
    "brightness": 1,
    "cold": 1
  }
}

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

retouch_with_1mod(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and JSON with 1 strength modifier and returns an enhanced Image based on this Strength Modifier.

Request Body schema: multipart/form-data
required
image
string <binary>
mod_strength
object

Responses

Request samples

Content type
multipart/form-data
{
  "image": null,
  "mod_strength": null
}

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

upscale(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and returns an upscaled Image.

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

upscale_x2(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and returns an upscaled (x2 resolution) Image.

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

upscale_x4(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and returns an upscaled (x4 resolution) Image.

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

retouch(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and returns an retouched Image.

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

retouch_and_upscale(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and returns an retouched and upscaled Image.

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

retouch_and_upscale_x2(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and returns an retouched and upscaled (x2) Image.

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

retouch_and_upscale_x4(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and returns an retouched and upscaled (x4) Image.

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

enhance_dark(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and returns a brighter Image.

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

enhance_dark_and_upscale(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and returns a brighter and upscaled Image.

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

enhance_dark_and_upscale_x2(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and returns a brighter and upscaled (x2) Image.

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

enhance_dark_and_upscale_x4(Multipart(image=Image,mod_strength=JSON) → Image)

Accepts Image and returns a brighter and upscaled (x4) Image.

Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "string",
  • "type": "string"
}

Infrastructure

Common infrastructure endpoints for observability.

Health check endpoint. Expecting an empty response

Health check endpoint. Expecting an empty response with status code 200 when the service is in health state. The /healthz endpoint is deprecated. (since Kubernetes v1.16)

Responses

Health check endpoint for Kubernetes. Healthy endp

Health check endpoint for Kubernetes. Healthy endpoint responses with a 200 OK status.

Responses

A <code>200</code> OK status from <code>/readyz</c

A 200 OK status from /readyz endpoint indicated the service is ready to accept traffic. From that point and onward, Kubernetes will use /livez endpoint to perform periodic health checks.

Responses

Prometheus metrics endpoint. The <code>/metrics</c

Prometheus metrics endpoint. The /metrics responses with a 200. The output can then be used by a Prometheus sidecar to scrape the metrics of the service.

Responses