--- title: Image processing app v0.1.0 language_tabs: - javascript: Javascript - python: Python toc_footers: [] includes: [] search: true highlight_theme: darkula headingLevel: 2 ---

Image processing app v0.1.0

> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu. Base URLs: * /image

Default

## desc__get > Code samples ```javascript const headers = { 'Accept':'application/json' }; fetch('/image/', { method: 'GET', headers: headers }) .then(function(res) { return res.json(); }).then(function(body) { console.log(body); }); ``` ```python import requests headers = { 'Accept': 'application/json' } r = requests.get('/image/', headers = headers) print(r.json()) ``` `GET /` *Desc* Get application description. Returns a simple response containing the description of the application. Returns: - **ApiResponse**: A response containing the application description. Example Response: ``` { "data": { "app": "image" } } ``` > Example responses > 200 Response ```json { "error": "string", "data": null } ```

Responses

|Status|Meaning|Description|Schema| |---|---|---|---| |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful Response|[ApiResponse](#schemaapiresponse)| ## classify_classify_post > Code samples ```javascript const inputBody = '{ "payload": "string" }'; const headers = { 'Content-Type':'multipart/form-data', 'Accept':'application/json' }; fetch('/image/classify', { method: 'POST', body: inputBody, headers: headers }) .then(function(res) { return res.json(); }).then(function(body) { console.log(body); }); ``` ```python import requests headers = { 'Content-Type': 'multipart/form-data', 'Accept': 'application/json' } r = requests.post('/image/classify', headers = headers) print(r.json()) ``` `POST /classify` *Classify* Image classification. Classify an uploaded image using an image classification model. Parameters: - **payload**: The uploaded image file. Returns: - **ClassifyResponse**: A response containing classification results for the uploaded image. Example Response: ``` { "data": [ {"score": 0.85, "label": "cat"}, {"score": 0.73, "label": "dog"} ] } ``` > Body parameter ```yaml payload: string ```

Parameters

|Name|In|Type|Required|Description| |---|---|---|---|---| |body|body|[Body_classify_classify_post](#schemabody_classify_classify_post)|true|none| > Example responses > 200 Response ```json { "error": "string", "data": [ { "score": 0, "label": "string" } ] } ```

Responses

|Status|Meaning|Description|Schema| |---|---|---|---| |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful Response|[ClassifyResponse](#schemaclassifyresponse)| |422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|Validation Error|[HTTPValidationError](#schemahttpvalidationerror)| ## detect_object_detect_object_post > Code samples ```javascript const inputBody = '{ "payload": "string" }'; const headers = { 'Content-Type':'multipart/form-data', 'Accept':'application/json' }; fetch('/image/detect-object', { method: 'POST', body: inputBody, headers: headers }) .then(function(res) { return res.json(); }).then(function(body) { console.log(body); }); ``` ```python import requests headers = { 'Content-Type': 'multipart/form-data', 'Accept': 'application/json' } r = requests.post('/image/detect-object', headers = headers) print(r.json()) ``` `POST /detect-object` *Detect Object* Object detection. Detect objects in an uploaded image. Parameters: - **payload**: The uploaded image file. Returns: - **DetectObjectResponse**: A response containing object detection results for the uploaded image. Example Response: ``` { "data": [ {"score": 0.85, "label": "cat", "box": {"xmin": 0.1, "ymin": 0.2, "xmax": 0.9, "ymax": 0.8}}, {"score": 0.73, "label": "dog", "box": {"xmin": 0.2, "ymin": 0.3, "xmax": 0.8, "ymax": 0.7}} ] } ``` > Body parameter ```yaml payload: string ```

Parameters

|Name|In|Type|Required|Description| |---|---|---|---|---| |body|body|[Body_detect_object_detect_object_post](#schemabody_detect_object_detect_object_post)|true|none| > Example responses > 200 Response ```json { "error": "string", "data": [ { "score": 0, "label": "string", "box": { "xmin": 0, "ymin": 0, "xmax": 0, "ymax": 0 } } ] } ```

Responses

|Status|Meaning|Description|Schema| |---|---|---|---| |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful Response|[DetectObjectResponse](#schemadetectobjectresponse)| |422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|Validation Error|[HTTPValidationError](#schemahttpvalidationerror)| ## segment_segment_post > Code samples ```javascript const inputBody = '{ "payload": "string" }'; const headers = { 'Content-Type':'multipart/form-data', 'Accept':'application/json' }; fetch('/image/segment', { method: 'POST', body: inputBody, headers: headers }) .then(function(res) { return res.json(); }).then(function(body) { console.log(body); }); ``` ```python import requests headers = { 'Content-Type': 'multipart/form-data', 'Accept': 'application/json' } r = requests.post('/image/segment', headers = headers) print(r.json()) ``` `POST /segment` *Segment* Image segmentation. Segment an uploaded image into different regions. Parameters: - **payload**: The uploaded image file. Returns: - **SegmentResponse**: A response containing image segmentation results for the uploaded image. Example Response: ``` { "data": [ {"label": "sky", "image": "base64_encoded_image"}, {"label": "tree", "image": "base64_encoded_image"} ] } ``` > Body parameter ```yaml payload: string ```

Parameters

|Name|In|Type|Required|Description| |---|---|---|---|---| |body|body|[Body_segment_segment_post](#schemabody_segment_segment_post)|true|none| > Example responses > 200 Response ```json { "error": "string", "data": [ { "label": "string", "image": "string" } ] } ```

Responses

|Status|Meaning|Description|Schema| |---|---|---|---| |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful Response|[SegmentResponse](#schemasegmentresponse)| |422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|Validation Error|[HTTPValidationError](#schemahttpvalidationerror)| # Schemas

ApiResponse

```json { "error": "string", "data": null } ``` ApiResponse ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |error|string|false|none|none| |data|any|false|none|none|

Body_classify_classify_post

```json { "payload": "string" } ``` Body_classify_classify_post ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |payload|string(binary)|true|none|none|

Body_detect_object_detect_object_post

```json { "payload": "string" } ``` Body_detect_object_detect_object_post ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |payload|string(binary)|true|none|none|

Body_segment_segment_post

```json { "payload": "string" } ``` Body_segment_segment_post ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |payload|string(binary)|true|none|none|

Box

```json { "xmin": 0, "ymin": 0, "xmax": 0, "ymax": 0 } ``` Box ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |xmin|number|true|none|none| |ymin|number|true|none|none| |xmax|number|true|none|none| |ymax|number|true|none|none|

ClassifierOutput

```json { "score": 0, "label": "string" } ``` ClassifierOutput ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |score|number|true|none|none| |label|string|true|none|none|

ClassifyResponse

```json { "error": "string", "data": [ { "score": 0, "label": "string" } ] } ``` ClassifyResponse ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |error|string|false|none|none| |data|[[ClassifierOutput](#schemaclassifieroutput)]|true|none|none|

DetectObjectResponse

```json { "error": "string", "data": [ { "score": 0, "label": "string", "box": { "xmin": 0, "ymin": 0, "xmax": 0, "ymax": 0 } } ] } ``` DetectObjectResponse ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |error|string|false|none|none| |data|[[ObjectDectionOutput](#schemaobjectdectionoutput)]|true|none|none|

HTTPValidationError

```json { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } ``` HTTPValidationError ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |detail|[[ValidationError](#schemavalidationerror)]|false|none|none|

ObjectDectionOutput

```json { "score": 0, "label": "string", "box": { "xmin": 0, "ymin": 0, "xmax": 0, "ymax": 0 } } ``` ObjectDectionOutput ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |score|number|true|none|none| |label|string|true|none|none| |box|[Box](#schemabox)|true|none|none|

SegmentOutput

```json { "label": "string", "image": "string" } ``` SegmentOutput ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |label|string|true|none|none| |image|string(binary)|true|none|none|

SegmentResponse

```json { "error": "string", "data": [ { "label": "string", "image": "string" } ] } ``` SegmentResponse ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |error|string|false|none|none| |data|[[SegmentOutput](#schemasegmentoutput)]|true|none|none|

ValidationError

```json { "loc": [ "string" ], "msg": "string", "type": "string" } ``` ValidationError ### Properties |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |loc|[anyOf]|true|none|none| anyOf |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |» *anonymous*|string|false|none|none| or |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |» *anonymous*|integer|false|none|none| continued |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |msg|string|true|none|none| |type|string|true|none|none|