muqtadar08/yolov8 – API reference

muqtadar08 / yolov8

Public
35 runs

Run muqtadar08/yolov8 with an API

Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.

Input schema

The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.

Field	Type	Default value	Description
input_image	string		Path to an image
model_name	string (enum)	yolov8-s Options: yolov8-s, yolov8-m, yolov8-l, yolov8-x, yolov8-n	Model name
return_json	boolean	False	Return results in json format

{
  "type": "object",
  "title": "Input",
  "required": [
    "input_image"
  ],
  "properties": {
    "model_name": {
      "enum": [
        "yolov8-s",
        "yolov8-m",
        "yolov8-l",
        "yolov8-x",
        "yolov8-n"
      ],
      "type": "string",
      "title": "model_name",
      "description": "Model name",
      "default": "yolov8-s",
      "x-order": 1
    },
    "input_image": {
      "type": "string",
      "title": "Input Image",
      "format": "uri",
      "x-order": 0,
      "description": "Path to an image"
    },
    "return_json": {
      "type": "boolean",
      "title": "Return Json",
      "default": false,
      "x-order": 2,
      "description": "Return results in json format"
    }
  }
}

Output schema

The shape of the response you’ll get when you run this model with an API.

Schema

{
  "type": "object",
  "title": "Output",
  "properties": {
    "img": {
      "type": "string",
      "title": "Img",
      "format": "uri"
    },
    "json_str": {
      "type": "string",
      "title": "Json Str"
    }
  }
}