# Common objects

## Input object

The input object describes the data to send as input to the network. You must specify exactly one key among the possible input types. Currently only the image inputs are supported.

| Parameter | Type                                                                | Default | Description     |
| --------- | ------------------------------------------------------------------- | ------- | --------------- |
| image     | [object](/deepomatic-api-v0.7/common-objects.md#image-input-object) |         | An image input. |
| video     | [object](/deepomatic-api-v0.7/common-objects.md#video-input-object) |         | A video input.  |

## **Image input object**

| Attribute | Type          | Description                                                                                                                                                                                                                                                                                                                                                                                                                         |
| --------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| source    | string        | <p>May have various forms:</p><ul><li>The URL of the image</li><li>The base64 encoded content of the image prefixed by <code>data:image/{:format};base64,</code>.</li><li>The binary content of the image prefixed by <code>data:image/{:format};binary,</code></li></ul><p>In the two last cases, <code>{:format}</code> is the image format (jpeg, png, etc...). If you don't know about the format just use <code>\*</code>.</p> |
| bbox      | object        | A bounding box object to crop the image.                                                                                                                                                                                                                                                                                                                                                                                            |
| polygon   | array(object) | An array of point objects of size at least 3 to crop the image.                                                                                                                                                                                                                                                                                                                                                                     |

## **Video input object**

| Attribute    | Type   | Description                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| source       | string | <p>May have various forms:</p><ul><li>The URL of the image</li><li>The base64 encoded content of the image prefixed by <code>data:image/{:format};base64,</code>.</li><li>The binary content of the image prefixed by <code>data:image/{:format};binary,</code></li></ul><p>In the two last cases, <code>{:format}</code> is the image format (jpeg, png, etc...). If you don't know about the format just use <code>\*</code>.</p> |
| process\_fps | float  | The number of inference per second requested. Defaults to 1. Use a float number lower than one if you want to process less than one frame per second (e.g. passing 0.5 will result in a inference every 2 seconds).                                                                                                                                                                                                                 |

## Point object

A point is usually used to define a polygon in order to delimitate a non rectangle sub-part of the image. Coordinates are normalised to the image width and height. Origin is at the top-left corner.

| Attribute | Type  | Description               |
| --------- | ----- | ------------------------- |
| x         | float | x-coordinate of the point |
| y         | float | y-coordinate of the point |

{% code title="JSON" %}

```javascript
{
    "x" : 0.1,
    "y" : 0.1
}
```

{% endcode %}

## Bounding box object

A bounding box is a rectangle used to delimitate a sub-part of an image. Coordinates are normalised to the image width and height. Origin is at the top-left corner.

| Attribute | Type  | Description                                    |
| --------- | ----- | ---------------------------------------------- |
| xmin      | float | x-coordinate of the top of the bounding box    |
| ymin      | float | y-coordinate of the left of the bounding box   |
| xmax      | float | x-coordinate of the bottom of the bounding box |
| ymax      | float | y-coordinate of the right of the bounding box  |

{% code title="JSON" %}

```javascript
{
    "xmin": 0.1,
    "ymin" : 0.2,
    "xmax" : 0.8,
    "ymax": 0.9
}
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.deepomatic.com/deepomatic-api-v0.7/common-objects.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
