DataPark APIGateway console

DataParkAPIgw

DataPark APIs

A focused, self-hosted gateway for healthy DataPark services.

OpenAPI 3.1 Client and administrator sign in

API reference

Available endpoints

Try authenticated endpoints

The API key stays only in this page's memory. It is never placed in a URL or browser storage.

Requests omit your portal cookies and can target only the documented route shown on each card.

Service

Random Number

1 endpoint
/random/numberRandom Number

Random number

random?length=x

GETPublic0 points
Request examples

curl

curl -X GET https://api.datapark.cloud/random/number

Python

requests.request("GET", "https://api.datapark.cloud/random/number")

JavaScript

fetch("https://api.datapark.cloud/random/number", { method: "GET" })
Try API 
Ready.

Service

snapshotai

6 endpoints
/snapshotai/api/v1/infersnapshotai

Inference — JSON

Run inference from a URL or Base64 image

POSTAPI key1 points
Accepted request dataapplication/json
Optional
{
  "properties": {
    "agnostic_nms": {
      "default": false,
      "type": "boolean"
    },
    "augment": {
      "default": false,
      "type": "boolean"
    },
    "classes": {
      "anyOf": [
        {
          "items": {
            "type": "integer"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional class IDs to retain, for example [0, 2, 5]."
    },
    "confidence": {
      "default": 0.25,
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "half": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "FP16 inference. Normally enabled only for the NVIDIA backend."
    },
    "image_base64": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Raw Base64 or a data:image/...;base64,... URI."
    },
    "image_size": {
      "default": 640,
      "maximum": 4096,
      "minimum": 32,
      "type": "integer"
    },
    "image_url": {
      "anyOf": [
        {
          "format": "uri",
          "maxLength": 2083,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "HTTP(S) URL of the image. URL fetching can be disabled by the server administrator."
    },
    "iou": {
      "default": 0.7,
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "max_detections": {
      "default": 300,
      "maximum": 10000,
      "minimum": 1,
      "type": "integer"
    },
    "model": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Model alias from the server registry. Direct filenames are disabled by default."
    },
    "retina_masks": {
      "default": false,
      "type": "boolean"
    },
    "task": {
      "default": "detect",
      "enum": [
        "detect",
        "segment",
        "pose",
        "classify",
        "obb"
      ],
      "type": "string"
    }
  },
  "title": "InferenceRequest",
  "type": "object"
}
Request examples

curl

curl -X POST https://api.datapark.cloud/snapshotai/api/v1/infer -H "X-API-Key: $DATAPARK_API_KEY" -H "Content-Type: application/json"

Python

requests.request("POST", "https://api.datapark.cloud/snapshotai/api/v1/infer", headers={"X-API-Key": os.environ["DATAPARK_API_KEY"], "Content-Type": "application/json"})

JavaScript

fetch("https://api.datapark.cloud/snapshotai/api/v1/infer", { method: "POST", headers: { "X-API-Key": apiKey, "Content-Type": "application/json" } })
Try API 
Ready.
/snapshotai/api/v1/infer-rendersnapshotai

Inference + Rendering

Return structured inference plus an annotated image as Base64

POSTAPI key1 points
Accepted request dataapplication/json
Required
{
  "properties": {
    "agnostic_nms": {
      "default": false,
      "type": "boolean"
    },
    "augment": {
      "default": false,
      "type": "boolean"
    },
    "boxes": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "High-level annotation toggle. true draws bounding boxes, labels, and confidence; false returns a clean image while structured JSON detections remain available."
    },
    "classes": {
      "anyOf": [
        {
          "items": {
            "type": "integer"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional class IDs to retain, for example [0, 2, 5]."
    },
    "confidence": {
      "default": 0.25,
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "font_size": {
      "anyOf": [
        {
          "maximum": 200,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "half": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "FP16 inference. Normally enabled only for the NVIDIA backend."
    },
    "image_base64": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Raw Base64 or a data:image/...;base64,... URI."
    },
    "image_format": {
      "default": "jpeg",
      "enum": [
        "jpeg",
        "png",
        "webp"
      ],
      "type": "string"
    },
    "image_size": {
      "default": 640,
      "maximum": 4096,
      "minimum": 32,
      "type": "integer"
    },
    "image_url": {
      "anyOf": [
        {
          "format": "uri",
          "maxLength": 2083,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "HTTP(S) URL of the image. URL fetching can be disabled by the server administrator."
    },
    "iou": {
      "default": 0.7,
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "keypoint_lines": {
      "default": true,
      "type": "boolean"
    },
    "keypoint_radius": {
      "default": 5,
      "maximum": 50,
      "minimum": 1,
      "type": "integer"
    },
    "line_width": {
      "anyOf": [
        {
          "maximum": 50,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "max_detections": {
      "default": 300,
      "maximum": 10000,
      "minimum": 1,
      "type": "integer"
    },
    "model": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Model alias from the server registry. Direct filenames are disabled by default."
    },
    "quality": {
      "default": 90,
      "maximum": 100,
      "minimum": 1,
      "type": "integer"
    },
    "retina_masks": {
      "default": false,
      "type": "boolean"
    },
    "show_boxes": {
      "default": true,
      "type": "boolean"
    },
    "show_confidence": {
      "default": true,
      "type": "boolean"
    },
    "show_labels": {
      "default": true,
      "type": "boolean"
    },
    "show_masks": {
      "default": true,
      "type": "boolean"
    },
    "show_probabilities": {
      "default": true,
      "type": "boolean"
    },
    "task": {
      "default": "detect",
      "enum": [
        "detect",
        "segment",
        "pose",
        "classify",
        "obb"
      ],
      "type": "string"
    }
  },
  "title": "RenderRequest",
  "type": "object"
}
Request examples

curl

curl -X POST https://api.datapark.cloud/snapshotai/api/v1/infer-render -H "X-API-Key: $DATAPARK_API_KEY" -H "Content-Type: application/json"

Python

requests.request("POST", "https://api.datapark.cloud/snapshotai/api/v1/infer-render", headers={"X-API-Key": os.environ["DATAPARK_API_KEY"], "Content-Type": "application/json"})

JavaScript

fetch("https://api.datapark.cloud/snapshotai/api/v1/infer-render", { method: "POST", headers: { "X-API-Key": apiKey, "Content-Type": "application/json" } })
Try API 
Ready.
/snapshotai/api/v1/infer/uploadsnapshotai

Inference — Upload

Run inference from a multipart image upload

POSTAPI key1 points
Accepted request datamultipart/form-data
Required
{
  "properties": {
    "agnostic_nms": {
      "default": false,
      "type": "boolean"
    },
    "augment": {
      "default": false,
      "type": "boolean"
    },
    "classes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Comma-separated class IDs, e.g. 0,2,5"
    },
    "confidence": {
      "default": 0.25,
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "file": {
      "contentMediaType": "application/octet-stream",
      "description": "JPEG, PNG, WEBP, BMP, TIFF, or another Pillow-supported image",
      "type": "string"
    },
    "half": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ]
    },
    "image_size": {
      "default": 640,
      "maximum": 4096,
      "minimum": 32,
      "type": "integer"
    },
    "iou": {
      "default": 0.7,
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "max_detections": {
      "default": 300,
      "maximum": 10000,
      "minimum": 1,
      "type": "integer"
    },
    "model": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "retina_masks": {
      "default": false,
      "type": "boolean"
    },
    "task": {
      "default": "detect",
      "enum": [
        "detect",
        "segment",
        "pose",
        "classify",
        "obb"
      ],
      "type": "string"
    }
  },
  "required": [
    "file"
  ],
  "title": "InferenceUploadRequest",
  "type": "object"
}
Request examples

curl

curl -X POST https://api.datapark.cloud/snapshotai/api/v1/infer/upload -H "X-API-Key: $DATAPARK_API_KEY" -H "Content-Type: multipart/form-data"

Python

requests.request("POST", "https://api.datapark.cloud/snapshotai/api/v1/infer/upload", headers={"X-API-Key": os.environ["DATAPARK_API_KEY"], "Content-Type": "multipart/form-data"})

JavaScript

fetch("https://api.datapark.cloud/snapshotai/api/v1/infer/upload", { method: "POST", headers: { "X-API-Key": apiKey, "Content-Type": "multipart/form-data" } })
Try API 
Ready.
/snapshotai/api/v1/rendersnapshotai

Rendering — JSON

Run inference and return an annotated image

Run inference and return an annotated image

POSTAPI key1 points
Accepted request dataapplication/json
Required
{
  "properties": {
    "agnostic_nms": {
      "default": false,
      "type": "boolean"
    },
    "augment": {
      "default": false,
      "type": "boolean"
    },
    "boxes": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "High-level annotation toggle. true draws bounding boxes, labels, and confidence; false returns a clean image while structured JSON detections remain available."
    },
    "classes": {
      "anyOf": [
        {
          "items": {
            "type": "integer"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional class IDs to retain, for example [0, 2, 5]."
    },
    "confidence": {
      "default": 0.25,
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "font_size": {
      "anyOf": [
        {
          "maximum": 200,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "half": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "FP16 inference. Normally enabled only for the NVIDIA backend."
    },
    "image_base64": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Raw Base64 or a data:image/...;base64,... URI."
    },
    "image_format": {
      "default": "jpeg",
      "enum": [
        "jpeg",
        "png",
        "webp"
      ],
      "type": "string"
    },
    "image_size": {
      "default": 640,
      "maximum": 4096,
      "minimum": 32,
      "type": "integer"
    },
    "image_url": {
      "anyOf": [
        {
          "format": "uri",
          "maxLength": 2083,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "HTTP(S) URL of the image. URL fetching can be disabled by the server administrator."
    },
    "iou": {
      "default": 0.7,
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "keypoint_lines": {
      "default": true,
      "type": "boolean"
    },
    "keypoint_radius": {
      "default": 5,
      "maximum": 50,
      "minimum": 1,
      "type": "integer"
    },
    "line_width": {
      "anyOf": [
        {
          "maximum": 50,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "max_detections": {
      "default": 300,
      "maximum": 10000,
      "minimum": 1,
      "type": "integer"
    },
    "model": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Model alias from the server registry. Direct filenames are disabled by default."
    },
    "quality": {
      "default": 90,
      "maximum": 100,
      "minimum": 1,
      "type": "integer"
    },
    "retina_masks": {
      "default": false,
      "type": "boolean"
    },
    "show_boxes": {
      "default": true,
      "type": "boolean"
    },
    "show_confidence": {
      "default": true,
      "type": "boolean"
    },
    "show_labels": {
      "default": true,
      "type": "boolean"
    },
    "show_masks": {
      "default": true,
      "type": "boolean"
    },
    "show_probabilities": {
      "default": true,
      "type": "boolean"
    },
    "task": {
      "default": "detect",
      "enum": [
        "detect",
        "segment",
        "pose",
        "classify",
        "obb"
      ],
      "type": "string"
    }
  },
  "title": "RenderRequest",
  "type": "object"
}
Request examples

curl

curl -X POST https://api.datapark.cloud/snapshotai/api/v1/render -H "X-API-Key: $DATAPARK_API_KEY" -H "Content-Type: application/json"

Python

requests.request("POST", "https://api.datapark.cloud/snapshotai/api/v1/render", headers={"X-API-Key": os.environ["DATAPARK_API_KEY"], "Content-Type": "application/json"})

JavaScript

fetch("https://api.datapark.cloud/snapshotai/api/v1/render", { method: "POST", headers: { "X-API-Key": apiKey, "Content-Type": "application/json" } })
Try API 
Ready.
/snapshotai/api/v1/render/uploadsnapshotai

Rendering — Upload

Run inference on an upload and return an annotated image

POSTAPI key1 points
Accepted request datamultipart/form-data
Required
{
  "properties": {
    "agnostic_nms": {
      "default": false,
      "type": "boolean"
    },
    "augment": {
      "default": false,
      "type": "boolean"
    },
    "boxes": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "High-level annotation toggle"
    },
    "classes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "confidence": {
      "default": 0.25,
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "file": {
      "contentMediaType": "application/octet-stream",
      "type": "string"
    },
    "font_size": {
      "anyOf": [
        {
          "maximum": 200,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "half": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ]
    },
    "image_format": {
      "default": "jpeg",
      "pattern": "^(jpeg|jpg|png|webp)$",
      "type": "string"
    },
    "image_size": {
      "default": 640,
      "maximum": 4096,
      "minimum": 32,
      "type": "integer"
    },
    "iou": {
      "default": 0.7,
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "keypoint_lines": {
      "default": true,
      "type": "boolean"
    },
    "keypoint_radius": {
      "default": 5,
      "maximum": 50,
      "minimum": 1,
      "type": "integer"
    },
    "line_width": {
      "anyOf": [
        {
          "maximum": 50,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "max_detections": {
      "default": 300,
      "maximum": 10000,
      "minimum": 1,
      "type": "integer"
    },
    "model": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "quality": {
      "default": 90,
      "maximum": 100,
      "minimum": 1,
      "type": "integer"
    },
    "retina_masks": {
      "default": false,
      "type": "boolean"
    },
    "show_boxes": {
      "default": true,
      "type": "boolean"
    },
    "show_confidence": {
      "default": true,
      "type": "boolean"
    },
    "show_labels": {
      "default": true,
      "type": "boolean"
    },
    "show_masks": {
      "default": true,
      "type": "boolean"
    },
    "show_probabilities": {
      "default": true,
      "type": "boolean"
    },
    "task": {
      "default": "detect",
      "enum": [
        "detect",
        "segment",
        "pose",
        "classify",
        "obb"
      ],
      "type": "string"
    }
  },
  "required": [
    "file"
  ],
  "title": "RenderUploadRequest",
  "type": "object"
}
Request examples

curl

curl -X POST https://api.datapark.cloud/snapshotai/api/v1/render/upload -H "X-API-Key: $DATAPARK_API_KEY" -H "Content-Type: multipart/form-data"

Python

requests.request("POST", "https://api.datapark.cloud/snapshotai/api/v1/render/upload", headers={"X-API-Key": os.environ["DATAPARK_API_KEY"], "Content-Type": "multipart/form-data"})

JavaScript

fetch("https://api.datapark.cloud/snapshotai/api/v1/render/upload", { method: "POST", headers: { "X-API-Key": apiKey, "Content-Type": "multipart/form-data" } })
Try API 
Ready.
/snapshotai/healthsnapshotai

Health

GETAPI key0 points
Request examples

curl

curl -X GET https://api.datapark.cloud/snapshotai/health -H "X-API-Key: $DATAPARK_API_KEY"

Python

requests.request("GET", "https://api.datapark.cloud/snapshotai/health", headers={"X-API-Key": os.environ["DATAPARK_API_KEY"], "Content-Type": "application/json"})

JavaScript

fetch("https://api.datapark.cloud/snapshotai/health", { method: "GET", headers: { "X-API-Key": apiKey, "Content-Type": "application/json" } })
Try API 
Ready.