Skip to main content
POST
/
api
/
overlay-coordinate
/
create
Create Overlay Coordinate API Endpoint
curl --request POST \
  --url https://backend.clipvision.ai/api/overlay-coordinate/create/ \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "overlay_visualizer": "<string>",
  "x": "<string>",
  "y": "<string>",
  "x_offset": "<string>",
  "y_offset": "<string>"
}
'
{
  "coordinate_id": 1,
  "overlay_visualizer": "Bottom Right",
  "x": "main_w-overlay_w",
  "y": "main_h-overlay_h"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
overlay_visualizer
string
required
Minimum string length: 1
​
x
string
required
Minimum string length: 1
​
y
string
required
Minimum string length: 1
​
x_offset
string
Minimum string length: 1
​
y_offset
string
Minimum string length: 1

Response

Successfully created the overlay coordinate

Overlay Coordinate OpenAPI Schema

​
coordinate_id
integer
​
overlay_visualizer
string
​
x
string
​
y
string