FastAPI
 0.1.0 
OAS 3.1

/openapi.json

internal-api

Parameters

NameDescription
X-Nonce *
string
(header)

Request body

{
  "ip": "string",
  "port": 0,
  "busy": false
}

Responses

CodeDescriptionLinks
200

no response

Media type
Controls Accept header.
"string"
No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

api

Parameters

No parameters

Request body

{
  "image": "string",
  "config": {
    "render": {
      "alignment": "auto",
      "direction": "auto",
      "disable_font_border": false,
      "font_size_minimum": -1,
      "font_size_offset": 0,
      "gimp_font": "Sans-serif",
      "lowercase": false,
      "no_hyphenation": false,
      "renderer": "default",
      "uppercase": false
    },
    "upscale": {
      "revert_upscaling": false,
      "upscaler": "esrgan"
    },
    "translator": {
      "no_text_lang_skip": false,
      "target_lang": "ENG",
      "translator": "sugoi"
    },
    "detector": {
      "box_threshold": 0.7,
      "det_auto_rotate": false,
      "det_gamma_correct": false,
      "det_invert": false,
      "det_rotate": false,
      "detection_size": 2048,
      "detector": "default",
      "text_threshold": 0.5,
      "unclip_ratio": 2.3
    },
    "colorizer": {
      "colorization_size": 576,
      "colorizer": "none",
      "denoise_sigma": 30
    },
    "inpainter": {
      "inpainter": "lama_large",
      "inpainting_precision": "bf16",
      "inpainting_size": 2048
    },
    "ocr": {
      "ignore_bubble": 0,
      "min_text_length": 0,
      "ocr": "48px",
      "use_mocr_merge": false
    },
    "kernel_size": 3,
    "mask_dilation_offset": 0
  }
}

Responses

CodeDescriptionLinks
200

json strucure inspired by the ichigo translator extension

Media type
Controls Accept header.
{
  "translations": [
    {
      "minX": 0,
      "minY": 0,
      "maxX": 0,
      "maxY": 0,
      "is_bulleted_list": true,
      "angle": 0,
      "prob": 0,
      "text_color": {
        "fg": [
          null,
          null,
          null
        ],
        "bg": [
          null,
          null,
          null
        ]
      },
      "text": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "background": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA..."
    }
  ]
}
No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

{
  "image": "string",
  "config": {
    "render": {
      "alignment": "auto",
      "direction": "auto",
      "disable_font_border": false,
      "font_size_minimum": -1,
      "font_size_offset": 0,
      "gimp_font": "Sans-serif",
      "lowercase": false,
      "no_hyphenation": false,
      "renderer": "default",
      "uppercase": false
    },
    "upscale": {
      "revert_upscaling": false,
      "upscaler": "esrgan"
    },
    "translator": {
      "no_text_lang_skip": false,
      "target_lang": "ENG",
      "translator": "sugoi"
    },
    "detector": {
      "box_threshold": 0.7,
      "det_auto_rotate": false,
      "det_gamma_correct": false,
      "det_invert": false,
      "det_rotate": false,
      "detection_size": 2048,
      "detector": "default",
      "text_threshold": 0.5,
      "unclip_ratio": 2.3
    },
    "colorizer": {
      "colorization_size": 576,
      "colorizer": "none",
      "denoise_sigma": 30
    },
    "inpainter": {
      "inpainter": "lama_large",
      "inpainting_precision": "bf16",
      "inpainting_size": 2048
    },
    "ocr": {
      "ignore_bubble": 0,
      "min_text_length": 0,
      "ocr": "48px",
      "use_mocr_merge": false
    },
    "kernel_size": 3,
    "mask_dilation_offset": 0
  }
}

Responses

CodeDescriptionLinks
200

custom byte structure for decoding look at examples in 'examples/response.*'

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

{
  "image": "string",
  "config": {
    "render": {
      "alignment": "auto",
      "direction": "auto",
      "disable_font_border": false,
      "font_size_minimum": -1,
      "font_size_offset": 0,
      "gimp_font": "Sans-serif",
      "lowercase": false,
      "no_hyphenation": false,
      "renderer": "default",
      "uppercase": false
    },
    "upscale": {
      "revert_upscaling": false,
      "upscaler": "esrgan"
    },
    "translator": {
      "no_text_lang_skip": false,
      "target_lang": "ENG",
      "translator": "sugoi"
    },
    "detector": {
      "box_threshold": 0.7,
      "det_auto_rotate": false,
      "det_gamma_correct": false,
      "det_invert": false,
      "det_rotate": false,
      "detection_size": 2048,
      "detector": "default",
      "text_threshold": 0.5,
      "unclip_ratio": 2.3
    },
    "colorizer": {
      "colorization_size": 576,
      "colorizer": "none",
      "denoise_sigma": 30
    },
    "inpainter": {
      "inpainter": "lama_large",
      "inpainting_precision": "bf16",
      "inpainting_size": 2048
    },
    "ocr": {
      "ignore_bubble": 0,
      "min_text_length": 0,
      "ocr": "48px",
      "use_mocr_merge": false
    },
    "kernel_size": 3,
    "mask_dilation_offset": 0
  }
}

Responses

CodeDescriptionLinks
200

the result image

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

{
  "image": "string",
  "config": {
    "render": {
      "alignment": "auto",
      "direction": "auto",
      "disable_font_border": false,
      "font_size_minimum": -1,
      "font_size_offset": 0,
      "gimp_font": "Sans-serif",
      "lowercase": false,
      "no_hyphenation": false,
      "renderer": "default",
      "uppercase": false
    },
    "upscale": {
      "revert_upscaling": false,
      "upscaler": "esrgan"
    },
    "translator": {
      "no_text_lang_skip": false,
      "target_lang": "ENG",
      "translator": "sugoi"
    },
    "detector": {
      "box_threshold": 0.7,
      "det_auto_rotate": false,
      "det_gamma_correct": false,
      "det_invert": false,
      "det_rotate": false,
      "detection_size": 2048,
      "detector": "default",
      "text_threshold": 0.5,
      "unclip_ratio": 2.3
    },
    "colorizer": {
      "colorization_size": 576,
      "colorizer": "none",
      "denoise_sigma": 30
    },
    "inpainter": {
      "inpainter": "lama_large",
      "inpainting_precision": "bf16",
      "inpainting_size": 2048
    },
    "ocr": {
      "ignore_bubble": 0,
      "min_text_length": 0,
      "ocr": "48px",
      "use_mocr_merge": false
    },
    "kernel_size": 3,
    "mask_dilation_offset": 0
  }
}

Responses

CodeDescriptionLinks
200

A stream over elements with strucure(1byte status, 4 byte size, n byte data) status code are 0,1,2,3,4 0 is result data, 1 is progress report, 2 is error, 3 is waiting queue position, 4 is waiting for translator instance

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

{
  "image": "string",
  "config": {
    "render": {
      "alignment": "auto",
      "direction": "auto",
      "disable_font_border": false,
      "font_size_minimum": -1,
      "font_size_offset": 0,
      "gimp_font": "Sans-serif",
      "lowercase": false,
      "no_hyphenation": false,
      "renderer": "default",
      "uppercase": false
    },
    "upscale": {
      "revert_upscaling": false,
      "upscaler": "esrgan"
    },
    "translator": {
      "no_text_lang_skip": false,
      "target_lang": "ENG",
      "translator": "sugoi"
    },
    "detector": {
      "box_threshold": 0.7,
      "det_auto_rotate": false,
      "det_gamma_correct": false,
      "det_invert": false,
      "det_rotate": false,
      "detection_size": 2048,
      "detector": "default",
      "text_threshold": 0.5,
      "unclip_ratio": 2.3
    },
    "colorizer": {
      "colorization_size": 576,
      "colorizer": "none",
      "denoise_sigma": 30
    },
    "inpainter": {
      "inpainter": "lama_large",
      "inpainting_precision": "bf16",
      "inpainting_size": 2048
    },
    "ocr": {
      "ignore_bubble": 0,
      "min_text_length": 0,
      "ocr": "48px",
      "use_mocr_merge": false
    },
    "kernel_size": 3,
    "mask_dilation_offset": 0
  }
}

Responses

CodeDescriptionLinks
200

A stream over elements with strucure(1byte status, 4 byte size, n byte data) status code are 0,1,2,3,4 0 is result data, 1 is progress report, 2 is error, 3 is waiting queue position, 4 is waiting for translator instance

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

{
  "image": "string",
  "config": {
    "render": {
      "alignment": "auto",
      "direction": "auto",
      "disable_font_border": false,
      "font_size_minimum": -1,
      "font_size_offset": 0,
      "gimp_font": "Sans-serif",
      "lowercase": false,
      "no_hyphenation": false,
      "renderer": "default",
      "uppercase": false
    },
    "upscale": {
      "revert_upscaling": false,
      "upscaler": "esrgan"
    },
    "translator": {
      "no_text_lang_skip": false,
      "target_lang": "ENG",
      "translator": "sugoi"
    },
    "detector": {
      "box_threshold": 0.7,
      "det_auto_rotate": false,
      "det_gamma_correct": false,
      "det_invert": false,
      "det_rotate": false,
      "detection_size": 2048,
      "detector": "default",
      "text_threshold": 0.5,
      "unclip_ratio": 2.3
    },
    "colorizer": {
      "colorization_size": 576,
      "colorizer": "none",
      "denoise_sigma": 30
    },
    "inpainter": {
      "inpainter": "lama_large",
      "inpainting_precision": "bf16",
      "inpainting_size": 2048
    },
    "ocr": {
      "ignore_bubble": 0,
      "min_text_length": 0,
      "ocr": "48px",
      "use_mocr_merge": false
    },
    "kernel_size": 3,
    "mask_dilation_offset": 0
  }
}

Responses

CodeDescriptionLinks
200

A stream over elements with strucure(1byte status, 4 byte size, n byte data) status code are 0,1,2,3,4 0 is result data, 1 is progress report, 2 is error, 3 is waiting queue position, 4 is waiting for translator instance

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

image *
string($binary)
config
string

Responses

CodeDescriptionLinks
200

json strucure inspired by the ichigo translator extension

Media type
Controls Accept header.
{
  "translations": [
    {
      "minX": 0,
      "minY": 0,
      "maxX": 0,
      "maxY": 0,
      "is_bulleted_list": true,
      "angle": 0,
      "prob": 0,
      "text_color": {
        "fg": [
          null,
          null,
          null
        ],
        "bg": [
          null,
          null,
          null
        ]
      },
      "text": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "background": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA..."
    }
  ]
}
No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

image *
string($binary)
config
string

Responses

CodeDescriptionLinks
200

custom byte structure for decoding look at examples in 'examples/response.*'

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

image *
string($binary)
config
string

Responses

CodeDescriptionLinks
200

the result image

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

image *
string($binary)
config
string

Responses

CodeDescriptionLinks
200

A stream over elements with strucure(1byte status, 4 byte size, n byte data) status code are 0,1,2,3,4 0 is result data, 1 is progress report, 2 is error, 3 is waiting queue position, 4 is waiting for translator instance

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

image *
string($binary)
config
string

Responses

CodeDescriptionLinks
200

A stream over elements with strucure(1byte status, 4 byte size, n byte data) status code are 0,1,2,3,4 0 is result data, 1 is progress report, 2 is error, 3 is waiting queue position, 4 is waiting for translator instance

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

image *
string($binary)
config
string

Responses

CodeDescriptionLinks
200

A stream over elements with strucure(1byte status, 4 byte size, n byte data) status code are 0,1,2,3,4 0 is result data, 1 is progress report, 2 is error, 3 is waiting queue position, 4 is waiting for translator instance

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Responses

CodeDescriptionLinks
200

Successful Response

Media type
Controls Accept header.
0
No links

json

Parameters

No parameters

Request body

{
  "image": "string",
  "config": {
    "render": {
      "alignment": "auto",
      "direction": "auto",
      "disable_font_border": false,
      "font_size_minimum": -1,
      "font_size_offset": 0,
      "gimp_font": "Sans-serif",
      "lowercase": false,
      "no_hyphenation": false,
      "renderer": "default",
      "uppercase": false
    },
    "upscale": {
      "revert_upscaling": false,
      "upscaler": "esrgan"
    },
    "translator": {
      "no_text_lang_skip": false,
      "target_lang": "ENG",
      "translator": "sugoi"
    },
    "detector": {
      "box_threshold": 0.7,
      "det_auto_rotate": false,
      "det_gamma_correct": false,
      "det_invert": false,
      "det_rotate": false,
      "detection_size": 2048,
      "detector": "default",
      "text_threshold": 0.5,
      "unclip_ratio": 2.3
    },
    "colorizer": {
      "colorization_size": 576,
      "colorizer": "none",
      "denoise_sigma": 30
    },
    "inpainter": {
      "inpainter": "lama_large",
      "inpainting_precision": "bf16",
      "inpainting_size": 2048
    },
    "ocr": {
      "ignore_bubble": 0,
      "min_text_length": 0,
      "ocr": "48px",
      "use_mocr_merge": false
    },
    "kernel_size": 3,
    "mask_dilation_offset": 0
  }
}

Responses

CodeDescriptionLinks
200

json strucure inspired by the ichigo translator extension

Media type
Controls Accept header.
{
  "translations": [
    {
      "minX": 0,
      "minY": 0,
      "maxX": 0,
      "maxY": 0,
      "is_bulleted_list": true,
      "angle": 0,
      "prob": 0,
      "text_color": {
        "fg": [
          null,
          null,
          null
        ],
        "bg": [
          null,
          null,
          null
        ]
      },
      "text": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "background": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA..."
    }
  ]
}
No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

{
  "image": "string",
  "config": {
    "render": {
      "alignment": "auto",
      "direction": "auto",
      "disable_font_border": false,
      "font_size_minimum": -1,
      "font_size_offset": 0,
      "gimp_font": "Sans-serif",
      "lowercase": false,
      "no_hyphenation": false,
      "renderer": "default",
      "uppercase": false
    },
    "upscale": {
      "revert_upscaling": false,
      "upscaler": "esrgan"
    },
    "translator": {
      "no_text_lang_skip": false,
      "target_lang": "ENG",
      "translator": "sugoi"
    },
    "detector": {
      "box_threshold": 0.7,
      "det_auto_rotate": false,
      "det_gamma_correct": false,
      "det_invert": false,
      "det_rotate": false,
      "detection_size": 2048,
      "detector": "default",
      "text_threshold": 0.5,
      "unclip_ratio": 2.3
    },
    "colorizer": {
      "colorization_size": 576,
      "colorizer": "none",
      "denoise_sigma": 30
    },
    "inpainter": {
      "inpainter": "lama_large",
      "inpainting_precision": "bf16",
      "inpainting_size": 2048
    },
    "ocr": {
      "ignore_bubble": 0,
      "min_text_length": 0,
      "ocr": "48px",
      "use_mocr_merge": false
    },
    "kernel_size": 3,
    "mask_dilation_offset": 0
  }
}

Responses

CodeDescriptionLinks
200

custom byte structure for decoding look at examples in 'examples/response.*'

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

{
  "image": "string",
  "config": {
    "render": {
      "alignment": "auto",
      "direction": "auto",
      "disable_font_border": false,
      "font_size_minimum": -1,
      "font_size_offset": 0,
      "gimp_font": "Sans-serif",
      "lowercase": false,
      "no_hyphenation": false,
      "renderer": "default",
      "uppercase": false
    },
    "upscale": {
      "revert_upscaling": false,
      "upscaler": "esrgan"
    },
    "translator": {
      "no_text_lang_skip": false,
      "target_lang": "ENG",
      "translator": "sugoi"
    },
    "detector": {
      "box_threshold": 0.7,
      "det_auto_rotate": false,
      "det_gamma_correct": false,
      "det_invert": false,
      "det_rotate": false,
      "detection_size": 2048,
      "detector": "default",
      "text_threshold": 0.5,
      "unclip_ratio": 2.3
    },
    "colorizer": {
      "colorization_size": 576,
      "colorizer": "none",
      "denoise_sigma": 30
    },
    "inpainter": {
      "inpainter": "lama_large",
      "inpainting_precision": "bf16",
      "inpainting_size": 2048
    },
    "ocr": {
      "ignore_bubble": 0,
      "min_text_length": 0,
      "ocr": "48px",
      "use_mocr_merge": false
    },
    "kernel_size": 3,
    "mask_dilation_offset": 0
  }
}

Responses

CodeDescriptionLinks
200

the result image

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

{
  "image": "string",
  "config": {
    "render": {
      "alignment": "auto",
      "direction": "auto",
      "disable_font_border": false,
      "font_size_minimum": -1,
      "font_size_offset": 0,
      "gimp_font": "Sans-serif",
      "lowercase": false,
      "no_hyphenation": false,
      "renderer": "default",
      "uppercase": false
    },
    "upscale": {
      "revert_upscaling": false,
      "upscaler": "esrgan"
    },
    "translator": {
      "no_text_lang_skip": false,
      "target_lang": "ENG",
      "translator": "sugoi"
    },
    "detector": {
      "box_threshold": 0.7,
      "det_auto_rotate": false,
      "det_gamma_correct": false,
      "det_invert": false,
      "det_rotate": false,
      "detection_size": 2048,
      "detector": "default",
      "text_threshold": 0.5,
      "unclip_ratio": 2.3
    },
    "colorizer": {
      "colorization_size": 576,
      "colorizer": "none",
      "denoise_sigma": 30
    },
    "inpainter": {
      "inpainter": "lama_large",
      "inpainting_precision": "bf16",
      "inpainting_size": 2048
    },
    "ocr": {
      "ignore_bubble": 0,
      "min_text_length": 0,
      "ocr": "48px",
      "use_mocr_merge": false
    },
    "kernel_size": 3,
    "mask_dilation_offset": 0
  }
}

Responses

CodeDescriptionLinks
200

A stream over elements with strucure(1byte status, 4 byte size, n byte data) status code are 0,1,2,3,4 0 is result data, 1 is progress report, 2 is error, 3 is waiting queue position, 4 is waiting for translator instance

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

{
  "image": "string",
  "config": {
    "render": {
      "alignment": "auto",
      "direction": "auto",
      "disable_font_border": false,
      "font_size_minimum": -1,
      "font_size_offset": 0,
      "gimp_font": "Sans-serif",
      "lowercase": false,
      "no_hyphenation": false,
      "renderer": "default",
      "uppercase": false
    },
    "upscale": {
      "revert_upscaling": false,
      "upscaler": "esrgan"
    },
    "translator": {
      "no_text_lang_skip": false,
      "target_lang": "ENG",
      "translator": "sugoi"
    },
    "detector": {
      "box_threshold": 0.7,
      "det_auto_rotate": false,
      "det_gamma_correct": false,
      "det_invert": false,
      "det_rotate": false,
      "detection_size": 2048,
      "detector": "default",
      "text_threshold": 0.5,
      "unclip_ratio": 2.3
    },
    "colorizer": {
      "colorization_size": 576,
      "colorizer": "none",
      "denoise_sigma": 30
    },
    "inpainter": {
      "inpainter": "lama_large",
      "inpainting_precision": "bf16",
      "inpainting_size": 2048
    },
    "ocr": {
      "ignore_bubble": 0,
      "min_text_length": 0,
      "ocr": "48px",
      "use_mocr_merge": false
    },
    "kernel_size": 3,
    "mask_dilation_offset": 0
  }
}

Responses

CodeDescriptionLinks
200

A stream over elements with strucure(1byte status, 4 byte size, n byte data) status code are 0,1,2,3,4 0 is result data, 1 is progress report, 2 is error, 3 is waiting queue position, 4 is waiting for translator instance

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

{
  "image": "string",
  "config": {
    "render": {
      "alignment": "auto",
      "direction": "auto",
      "disable_font_border": false,
      "font_size_minimum": -1,
      "font_size_offset": 0,
      "gimp_font": "Sans-serif",
      "lowercase": false,
      "no_hyphenation": false,
      "renderer": "default",
      "uppercase": false
    },
    "upscale": {
      "revert_upscaling": false,
      "upscaler": "esrgan"
    },
    "translator": {
      "no_text_lang_skip": false,
      "target_lang": "ENG",
      "translator": "sugoi"
    },
    "detector": {
      "box_threshold": 0.7,
      "det_auto_rotate": false,
      "det_gamma_correct": false,
      "det_invert": false,
      "det_rotate": false,
      "detection_size": 2048,
      "detector": "default",
      "text_threshold": 0.5,
      "unclip_ratio": 2.3
    },
    "colorizer": {
      "colorization_size": 576,
      "colorizer": "none",
      "denoise_sigma": 30
    },
    "inpainter": {
      "inpainter": "lama_large",
      "inpainting_precision": "bf16",
      "inpainting_size": 2048
    },
    "ocr": {
      "ignore_bubble": 0,
      "min_text_length": 0,
      "ocr": "48px",
      "use_mocr_merge": false
    },
    "kernel_size": 3,
    "mask_dilation_offset": 0
  }
}

Responses

CodeDescriptionLinks
200

A stream over elements with strucure(1byte status, 4 byte size, n byte data) status code are 0,1,2,3,4 0 is result data, 1 is progress report, 2 is error, 3 is waiting queue position, 4 is waiting for translator instance

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Responses

CodeDescriptionLinks
200

Successful Response

Media type
Controls Accept header.
0
No links

form

Parameters

No parameters

Request body

image *
string($binary)
config
string

Responses

CodeDescriptionLinks
200

json strucure inspired by the ichigo translator extension

Media type
Controls Accept header.
{
  "translations": [
    {
      "minX": 0,
      "minY": 0,
      "maxX": 0,
      "maxY": 0,
      "is_bulleted_list": true,
      "angle": 0,
      "prob": 0,
      "text_color": {
        "fg": [
          null,
          null,
          null
        ],
        "bg": [
          null,
          null,
          null
        ]
      },
      "text": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "background": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA..."
    }
  ]
}
No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

image *
string($binary)
config
string

Responses

CodeDescriptionLinks
200

custom byte structure for decoding look at examples in 'examples/response.*'

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

image *
string($binary)
config
string

Responses

CodeDescriptionLinks
200

the result image

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

image *
string($binary)
config
string

Responses

CodeDescriptionLinks
200

A stream over elements with strucure(1byte status, 4 byte size, n byte data) status code are 0,1,2,3,4 0 is result data, 1 is progress report, 2 is error, 3 is waiting queue position, 4 is waiting for translator instance

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

image *
string($binary)
config
string

Responses

CodeDescriptionLinks
200

A stream over elements with strucure(1byte status, 4 byte size, n byte data) status code are 0,1,2,3,4 0 is result data, 1 is progress report, 2 is error, 3 is waiting queue position, 4 is waiting for translator instance

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

Parameters

No parameters

Request body

image *
string($binary)
config
string

Responses

CodeDescriptionLinks
200

A stream over elements with strucure(1byte status, 4 byte size, n byte data) status code are 0,1,2,3,4 0 is result data, 1 is progress report, 2 is error, 3 is waiting queue position, 4 is waiting for translator instance

No links
422

Validation Error

Media type
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
No links

ui

Parameters

No parameters

Responses

CodeDescriptionLinks
200

Successful Response

Media type
Controls Accept header.
string
No links

Parameters

No parameters

Responses

CodeDescriptionLinks
200

Successful Response

Media type
Controls Accept header.
string
No links

string
array
  • #0"auto"
  • #1"left"
  • #2"center"
  • #3"right"
object
  • image
    stringbinary
  • string
    Default"{}"
object
  • image
    stringbinary
  • string
    Default"{}"
object
  • image
    stringbinary
  • string
    Default"{}"
object
  • image
    stringbinary
  • string
    Default"{}"
object
  • image
    stringbinary
  • string
    Default"{}"
object
  • image
    stringbinary
  • string
    Default"{}"
string
array
  • #0"none"
  • #1"mc2"
object
  • integer
    Default576
  • integer
    Default30
  • string
    array
    • #0"none"
    • #1"mc2"
    Default"none"
object
  • (string | null)
    (string | null)
    • #0
      string
    • #1
      null
  • object
    • string
      array
      • #0"default"
      • #1"manga2eng"
      • #2"none"
      Default"default"
    • string
      array
      • #0"auto"
      • #1"left"
      • #2"center"
      • #3"right"
      Default"auto"
    • boolean
      Defaultfalse
    • integer
      Default0
    • integer
      Default-1
    • string
      array
      • #0"auto"
      • #1"horizontal"
      • #2"vertical"
      Default"auto"
    • boolean
      Defaultfalse
    • boolean
      Defaultfalse
    • string
      Default"Sans-serif"
    • boolean
      Defaultfalse
    • (string | null)
      (string | null)
      • #0
        string
      • #1
        null
    • (integer | null)
      (integer | null)
      • #0
        integer
      • #1
        null
    • (integer | null)
      (integer | null)
      • #0
        integer
      • #1
        null
    object
    • renderer"default"
    • alignment"auto"
    • disable_font_borderfalse
    • font_size_offset0
    • font_size_minimum-1
    • direction"auto"
    • uppercasefalse
    • lowercasefalse
    • gimp_font"Sans-serif"
    • no_hyphenationfalse
  • object
    • string
      array
      • #0"waifu2x"
      • #1"esrgan"
      • #2"4xultrasharp"
      Default"esrgan"
    • boolean
      Defaultfalse
    • (integer | null)
      (integer | null)
      • #0
        integer
      • #1
        null
    object
    • upscaler"esrgan"
    • revert_upscalingfalse
  • object
    • string
      array
      • #0"youdao"
      • #1"baidu"
      • #2"deepl"
      • #3"papago"
      • #4"caiyun"
      • #5"chatgpt"
      • #6"none"
      • #7"original"
      • #8"sakura"
      • #9"deepseek"
      • #10"groq"
      • #11"custom_openai"
      • #12"offline"
      • #13"nllb"
      • #14"nllb_big"
      • #15"sugoi"
      • #16"jparacrawl"
      • #17"jparacrawl_big"
      • #18"m2m100"
      • #19"m2m100_big"
      • #20"mbart50"
      • #21"qwen2"
      • #22"qwen2_big"
      Default"sugoi"
    • string
      Default"ENG"
    • boolean
      Defaultfalse
    • (string | null)
      (string | null)
      • #0
        string
      • #1
        null
    • (string | null)
      (string | null)
      • #0
        string
      • #1
        null
    • (string | null)
      (string | null)
      • #0
        string
      • #1
        null
    • (string | null)
      (string | null)
      • #0
        string
      • #1
        null
    object
    • translator"sugoi"
    • target_lang"ENG"
    • no_text_lang_skipfalse
  • object
    • string
      array
      • #0"default"
      • #1"dbconvnext"
      • #2"ctd"
      • #3"craft"
      • #4"paddle"
      • #5"none"
      Default"default"
    • integer
      Default2048
    • number
      Default0.5
    • boolean
      Defaultfalse
    • boolean
      Defaultfalse
    • boolean
      Defaultfalse
    • boolean
      Defaultfalse
    • number
      Default0.7
    • number
      Default2.3
    object
    • detector"default"
    • detection_size2048
    • text_threshold0.5
    • det_rotatefalse
    • det_auto_rotatefalse
    • det_invertfalse
    • det_gamma_correctfalse
    • box_threshold0.7
    • unclip_ratio2.3
  • object
    • integer
      Default576
    • integer
      Default30
    • string
      array
      • #0"none"
      • #1"mc2"
      Default"none"
    object
    • colorization_size576
    • denoise_sigma30
    • colorizer"none"
  • object
    • string
      array
      • #0"default"
      • #1"lama_large"
      • #2"lama_mpe"
      • #3"sd"
      • #4"none"
      • #5"original"
      Default"lama_large"
    • integer
      Default2048
    • string
      array
      • #0"fp32"
      • #1"fp16"
      • #2"bf16"
      Default"bf16"
    object
    • inpainter"lama_large"
    • inpainting_size2048
    • inpainting_precision"bf16"
  • object
    • boolean
      Defaultfalse
    • string
      array
      • #0"32px"
      • #1"48px"
      • #2"48px_ctc"
      • #3"mocr"
      Default"48px"
    • integer
      Default0
    • integer
      Default0
    object
    • use_mocr_mergefalse
    • ocr"48px"
    • min_text_length0
    • ignore_bubble0
  • integer
    Default3
  • integer
    Default0
string
array
  • #0"default"
  • #1"dbconvnext"
  • #2"ctd"
  • #3"craft"
  • #4"paddle"
  • #5"none"
object
  • string
    array
    • #0"default"
    • #1"dbconvnext"
    • #2"ctd"
    • #3"craft"
    • #4"paddle"
    • #5"none"
    Default"default"
  • integer
    Default2048
  • number
    Default0.5
  • boolean
    Defaultfalse
  • boolean
    Defaultfalse
  • boolean
    Defaultfalse
  • boolean
    Defaultfalse
  • number
    Default0.7
  • number
    Default2.3
string
array
  • #0"auto"
  • #1"horizontal"
  • #2"vertical"
object
  • ip
    string
  • port
    integer
  • boolean
    Defaultfalse
object
  • array<object>
    object
    • array<(string | integer)>
      (string | integer)
      (string | integer)
      • #0
        string
      • #1
        integer
    • msg
      string
    • type
      string
string
array
  • #0"fp32"
  • #1"fp16"
  • #2"bf16"
string
array
  • #0"default"
  • #1"lama_large"
  • #2"lama_mpe"
  • #3"sd"
  • #4"none"
  • #5"original"
object
  • string
    array
    • #0"default"
    • #1"lama_large"
    • #2"lama_mpe"
    • #3"sd"
    • #4"none"
    • #5"original"
    Default"lama_large"
  • integer
    Default2048
  • string
    array
      Default"bf16"
    string
    array
    • #0"32px"
    • #1"48px"
    • #2"48px_ctc"
    • #3"mocr"
    object
    • boolean
      Defaultfalse
    • string
      array
      • #0"32px"
      • #1"48px"
      • #2"48px_ctc"
      • #3"mocr"
      Default"48px"
    • integer
      Default0
    • integer
      Default0
    object
    • string
      array
      • #0"default"
      • #1"manga2eng"
      • #2"none"
      Default"default"
    • string
      array
      • #0"auto"
      • #1"left"
      • #2"center"
      • #3"right"
      Default"auto"
    • boolean
      Defaultfalse
    • integer
      Default0
    • integer
      Default-1
    • string
      array
      • #0"auto"
      • #1"horizontal"
      • #2"vertical"
      Default"auto"
    • boolean
      Defaultfalse
    • boolean
      Defaultfalse
    • string
      Default"Sans-serif"
    • boolean
      Defaultfalse
    • (string | null)
      (string | null)
      • #0
        string
      • #1
        null
    • (integer | null)
      (integer | null)
      • #0
        integer
      • #1
        null
    • (integer | null)
      (integer | null)
      • #0
        integer
      • #1
        null
    string
    array
    • #0"default"
    • #1"manga2eng"
    • #2"none"
    object
    • array<[integer, integer, integer], any>3 items
      array<[integer, integer, integer], any>
      • #0
        integer
      • #1
        integer
      • #2
        integer
    • array<[integer, integer, integer], any>3 items
      array<[integer, integer, integer], any>
      • #0
        integer
      • #1
        integer
      • #2
        integer
    object

    This request can be a multipart or a json request

    • (string | string)
      (string | string)
      • #0
        stringbinary
      • #1
        string
    • object
      • (string | null)
        (string | null)
        • #0
          string
        • #1
          null
      • object
        • string
          array
          • #0"default"
          • #1"manga2eng"
          • #2"none"
          Default"default"
        • string
          array
          • #0"auto"
          • #1"left"
          • #2"center"
          • #3"right"
          Default"auto"
        • boolean
          Defaultfalse
        • integer
          Default0
        • integer
          Default-1
        • string
          array
          • #0"auto"
          • #1"horizontal"
          • #2"vertical"
          Default"auto"
        • boolean
          Defaultfalse
        • boolean
          Defaultfalse
        • string
          Default"Sans-serif"
        • boolean
          Defaultfalse
        • (string | null)
          (string | null)
          • #0
            string
          • #1
            null
        • (integer | null)
          (integer | null)
          • #0
            integer
          • #1
            null
        • (integer | null)
          (integer | null)
          • #0
            integer
          • #1
            null
        object
        • renderer"default"
        • alignment"auto"
        • disable_font_borderfalse
        • font_size_offset0
        • font_size_minimum-1
        • direction"auto"
        • uppercasefalse
        • lowercasefalse
        • gimp_font"Sans-serif"
        • no_hyphenationfalse
      • object
        • string
          array
          • #0"waifu2x"
          • #1"esrgan"
          • #2"4xultrasharp"
          Default"esrgan"
        • boolean
          Defaultfalse
        • (integer | null)
          (integer | null)
          • #0
            integer
          • #1
            null
        object
        • upscaler"esrgan"
        • revert_upscalingfalse
      • object
        • string
          array
          • #0"youdao"
          • #1"baidu"
          • #2"deepl"
          • #3"papago"
          • #4"caiyun"
          • #5"chatgpt"
          • #6"none"
          • #7"original"
          • #8"sakura"
          • #9"deepseek"
          • #10"groq"
          • #11"custom_openai"
          • #12"offline"
          • #13"nllb"
          • #14"nllb_big"
          • #15"sugoi"
          • #16"jparacrawl"
          • #17"jparacrawl_big"
          • #18"m2m100"
          • #19"m2m100_big"
          • #20"mbart50"
          • #21"qwen2"
          • #22"qwen2_big"
          Default"sugoi"
        • string
          Default"ENG"
        • boolean
          Defaultfalse
        • (string | null)
          (string | null)
          • #0
            string
          • #1
            null
        • (string | null)
          (string | null)
          • #0
            string
          • #1
            null
        • (string | null)
          (string | null)
          • #0
            string
          • #1
            null
        • (string | null)
          (string | null)
          • #0
            string
          • #1
            null
        object
        • translator"sugoi"
        • target_lang"ENG"
        • no_text_lang_skipfalse
      • object
        • string
          array
          • #0"default"
          • #1"dbconvnext"
          • #2"ctd"
          • #3"craft"
          • #4"paddle"
          • #5"none"
          Default"default"
        • integer
          Default2048
        • number
          Default0.5
        • boolean
          Defaultfalse
        • boolean
          Defaultfalse
        • boolean
          Defaultfalse
        • boolean
          Defaultfalse
        • number
          Default0.7
        • number
          Default2.3
        object
        • detector"default"
        • detection_size2048
        • text_threshold0.5
        • det_rotatefalse
        • det_auto_rotatefalse
        • det_invertfalse
        • det_gamma_correctfalse
        • box_threshold0.7
        • unclip_ratio2.3
      • object
        • integer
          Default576
        • integer
          Default30
        • string
          array
          • #0"none"
          • #1"mc2"
          Default"none"
        object
        • colorization_size576
        • denoise_sigma30
        • colorizer"none"
      • object
        • string
          array
          • #0"default"
          • #1"lama_large"
          • #2"lama_mpe"
          • #3"sd"
          • #4"none"
          • #5"original"
          Default"lama_large"
        • integer
          Default2048
        • string
          array
          • #0"fp32"
          • #1"fp16"
          • #2"bf16"
          Default"bf16"
        object
        • inpainter"lama_large"
        • inpainting_size2048
        • inpainting_precision"bf16"
      • object
        • boolean
          Defaultfalse
        • string
          array
          • #0"32px"
          • #1"48px"
          • #2"48px_ctc"
          • #3"mocr"
          Default"48px"
        • integer
          Default0
        • integer
          Default0
        object
        • use_mocr_mergefalse
        • ocr"48px"
        • min_text_length0
        • ignore_bubble0
      • integer
        Default3
      • integer
        Default0
      object
      • object
        • alignment"auto"
        • direction"auto"
        • disable_font_borderfalse
        • font_size_minimum-1
        • font_size_offset0
        • gimp_font"Sans-serif"
        • lowercasefalse
        • no_hyphenationfalse
        • renderer"default"
        • uppercasefalse
      • object
        • revert_upscalingfalse
        • upscaler"esrgan"
      • object
        • no_text_lang_skipfalse
        • target_lang"ENG"
        • translator"sugoi"
      • object
        • box_threshold0.7
        • det_auto_rotatefalse
        • det_gamma_correctfalse
        • det_invertfalse
        • det_rotatefalse
        • detection_size2048
        • detector"default"
        • text_threshold0.5
        • unclip_ratio2.3
      • object
        • colorization_size576
        • colorizer"none"
        • denoise_sigma30
      • object
        • inpainter"lama_large"
        • inpainting_precision"bf16"
        • inpainting_size2048
      • object
        • ignore_bubble0
        • min_text_length0
        • ocr"48px"
        • use_mocr_mergefalse
      • kernel_size3
      • mask_dilation_offset0
    object
    • minX
      integer
    • minY
      integer
    • maxX
      integer
    • maxY
      integer
    • is_bulleted_list
      boolean
    • (number | integer)
    • prob
      number
    • object
      • array<[integer, integer, integer], any>3 items
        array<[integer, integer, integer], any>
        • #0
          integer
        • #1
          integer
        • #2
          integer
      • array<[integer, integer, integer], any>3 items
        array<[integer, integer, integer], any>
        • #0
          integer
        • #1
          integer
        • #2
          integer
    • object
      Additional properties
      string
    • stringbase64

      Background image encoded as a base64 string

      array
      • #0"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA..."
    object
    • array<object>
      object
      • minX
        integer
      • minY
        integer
      • maxX
        integer
      • maxY
        integer
      • is_bulleted_list
        boolean
      • (number | integer)
        (number | integer)
        • #0
          number
        • #1
          integer
      • prob
        number
      • object
        • array<[integer, integer, integer], any>3 items
          array<[integer, integer, integer], any>
          • #0
            integer
          • #1
            integer
          • #2
            integer
        • array<[integer, integer, integer], any>3 items
          array<[integer, integer, integer], any>
          • #0
            integer
          • #1
            integer
          • #2
            integer
      • object
        Additional properties
        string
      • stringbase64

        Background image encoded as a base64 string

        array
        • #0"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA..."
    string
    array
    • #0"youdao"
    • #1"baidu"
    • #2"deepl"
    • #3"papago"
    • #4"caiyun"
    • #5"chatgpt"
    • #6"none"
    • #7"original"
    • #8"sakura"
    • #9"deepseek"
    • #10"groq"
    • #11"custom_openai"
    • #12"offline"
    • #13"nllb"
    • #14"nllb_big"
    • #15"sugoi"
    • #16"jparacrawl"
    • #17"jparacrawl_big"
    • #18"m2m100"
    • #19"m2m100_big"
    • #20"mbart50"
    • #21"qwen2"
    • #22"qwen2_big"
    object
    • string
      array
      • #0"youdao"
      • #1"baidu"
      • #2"deepl"
      • #3"papago"
      • #4"caiyun"
      • #5"chatgpt"
      • #6"none"
      • #7"original"
      • #8"sakura"
      • #9"deepseek"
      • #10"groq"
      • #11"custom_openai"
      • #12"offline"
      • #13"nllb"
      • #14"nllb_big"
      • #15"sugoi"
      • #16"jparacrawl"
      • #17"jparacrawl_big"
      • #18"m2m100"
      • #19"m2m100_big"
      • #20"mbart50"
      • #21"qwen2"
      • #22"qwen2_big"
      Default"sugoi"
    • string
      Default"ENG"
    • boolean
      Defaultfalse
    • (string | null)
      (string | null)
      • #0
        string
      • #1
        null
    • (string | null)
      (string | null)
      • #0
        string
      • #1
        null
    • (string | null)
      (string | null)
      • #0
        string
      • #1
        null
    • (string | null)
      (string | null)
      • #0
        string
      • #1
        null
    object
    • string
      array
      • #0"waifu2x"
      • #1"esrgan"
      • #2"4xultrasharp"
      Default"esrgan"
    • boolean
      Defaultfalse
    • (integer | null)
      (integer | null)
      • #0
        integer
      • #1
        null
    string
    array
    • #0"waifu2x"
    • #1"esrgan"
    • #2"4xultrasharp"
    object
    • array<(string | integer)>
      (string | integer)
      (string | integer)
      • #0
        string
      • #1
        integer
    • msg
      string
    • type
      string
    set 限制解除