Page Comparison

...

Process

You need to have ‘Process’ enabled in the left panel to process the image.

Request

The sending address consists of IP address, port, and type. The method must be of ‘POST’ type, and the content of ‘application/octet-stream’ type. See

Find a practical API demonstration of working with API in the Python language on our githubPython at https://github.com/pekat-vision/examples/tree/master/image_analyze_api/python

.

IP Address

If the project runs on a local computer, the address is 127.0.0.1. If a remote computer is accessed, then you need to use the IP address of the remote computer.

Port

This is selected when starting the project.

API Key

If the project is running with the api key, each request in the parameter query must contain API key.

Data

You can add extra information to the request. This string will be add to the context (key is data). It is available only in the Code module (context variable).

'http://127.0.0.1:8000/analyze_image?width=1920&height=1024&data=SomeInfo'

Types

analyze_raw_Image

Used for sending the image as raw data. For example, the numpy array in Python is converted to binary format. You need to send the image dimensions in a query parameter.

...

'http://127.0.0.1:8000/analyze_raw_image?width=1920&height=1024&bayer'

analyze_image

For sending an image in ‘jpg’ or ‘png’ formats.

...

'http://127.0.0.1:8000/analyze_image?api_key=SUPER_SECRET'

Response

Query parameter ‘response_type’ determines the response type.

...