Ingest

This endpoint allows you to submit image data and associated metadata to our platform for processing. It accepts image URLs along with capture information, location data, and detection-related data

Endpoint

Request Headers

  • accept: application/json

  • Content-Type: application/json

  • x-api-key: your-api-key-here

  • Authorization: Bearer your-access-token-here

Request Body Parameters

  • source (string, required): Sensor identifier we use for our partners

  • image_url (string, URL, required): Image's URL to process

  • time_captured (string, ISO 8601, required): Timestamp when image was captured

  • detection_bounding_box (Object, required): Coordinates of detection box

    • xmin (float, required): Left coordinate

    • ymin (float, required): Top coordinate

    • xmax (float, required): Right coordinate

    • ymax (float, required): Bottom coordinate

  • source_location_info (Object, required): Location information

    • latitude (float, required): Location latitude

    • longitude (float, required): Location longitude

    • city (string, required): City name

    • state (string, required): State name

    • route (string, required): Route identifier

    • traffic_direction (string, required): Traffic direction

  • detection_metadata (Object, required): Detection metadata

    • alpr_confidence (float, required): Confidence score of ALPR detection

    • alpr_state (string, required): License plate's state

    • plate_number (string, optional): Detected plate number

Error Response

  • 200 OK: A json object containing the Image received message.

  • 401 Unauthorized: If the authentication credentials (api-key or access-token) are missing or incorrect.

  • 403 Forbidden: If the access-token has expired or if the user don't have the required roles.

  • 422 Unprocessable Entity: If there are missing required fields, invalid field formats or empty values in required fields

  • 500 Internal Server Errors: If here are errors downloading the image, uploading the image to our DB, deleting the image from our servers or posting to our internal servers

Request Example

curl -X 'POST' \
  'https://api.genlogs.io/image' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: your-api-key-here' \
  -H 'Authorization: Bearer your-access-token-here' \
  -d '{
  "source": "sensor_identifier",
  "image_url": "https://example.com/image.jpg",
  "time_captured": "2025-02-11T22:50:25.459Z",
  "detection_bounding_box": {
    "xmin": 200,
    "ymin": 200,
    "xmax": 400,
    "ymax": 400
  },
  "source_location_info": {
    "latitude": 34.2,
    "longitude": -118.5,
    "city": "Los Angeles",
    "state": "CA",
    "route": "US-101",
    "traffic_direction": "north"
  },
  "detection_metadata": {
    "alpr_confidence": 0.9,
    "alpr_state": "CA",
    "plate_number": "8XYZ012"
  }
}'

Ingest image with it's related metadata

post

This endpoint allows you to submit image data and associated metadata to our platform for processing. It accepts image URLs along with capture information, location data, and detection-related data.

Header parameters
acceptstringRequired

application/json

Example: application/json
Content-TypestringRequired

application/json

Example: application/json
x-api-keystringRequired

X api key for authentication

Example: your-api-key-here
AuthorizationstringRequired

Authorization token

Example: Bearer your-access-token-here
Body
sourcestringRequiredExample: sensor_identifier
image_urlstring · uriRequiredExample: https://example.com/image.jpg
time_capturedstring · date-timeRequiredExample: 2025-02-11T22:50:25.459Z
post
/image
POST /image HTTP/1.1
Host: api.genlogs.io
accept: application/json
Content-Type: application/json
x-api-key: your-api-key-here
Authorization: Bearer your-access-token-here
Accept: */*
Content-Length: 412

{
  "source": "sensor_identifier",
  "image_url": "https://example.com/image.jpg",
  "time_captured": "2025-02-11T22:50:25.459Z",
  "detection_bounding_box": {
    "xmin": 0.1,
    "ymin": 0.2,
    "xmax": 0.3,
    "ymax": 0.4
  },
  "source_location_info": {
    "latitude": 34.2,
    "longitude": -118.5,
    "city": "Los Angeles",
    "state": "CA",
    "route": "US-101",
    "traffic_direction": "north"
  },
  "detection_data": {
    "alpr_confidence": 0.95,
    "alpr_state": "CA",
    "plate_number": "ABC1234"
  }
}
PreviousCreate access token

Last updated