Nanonets Image Classification Predict API

Predict on uploaded images or image URLs against a classification model.

Documentation

📖
Documentation
https://docs.nanonets.com/reference/overview
📖
Documentation
https://docs.nanonets.com/reference/ocrmodellabelfilebymodelidpost-1
📖
Documentation
https://docs.nanonets.com/reference/ocrmodellabelfileasyncbymodelidpost-1
📖
Documentation
https://docs.nanonets.com/reference/ocrmodellabelurlsbymodelidpost
📖
Documentation
https://docs.nanonets.com/reference/ocrmodellabelurlsasyncbymodelidpost-1
📖
Documentation
https://docs.nanonets.com/reference/ocrmodelgetpredictionfilebyfileid
📖
Documentation
https://docs.nanonets.com/reference/ocrmodelgetpredictionfilebypageid
📖
Documentation
https://docs.nanonets.com/reference/ocrmodellistpredictionfiles
📖
Documentation
https://docs.nanonets.com/reference/ocrmodeluploadfilebymodelidpost-1
📖
Documentation
https://docs.nanonets.com/reference/ocrmodeluploadurlsbymodelidpost-1
📖
Documentation
https://docs.nanonets.com/reference/ocrmodeltrainbymodelidpost-1
📖
Documentation
https://docs.nanonets.com/reference/imagecategorizationlabelfilepost
📖
Documentation
https://docs.nanonets.com/reference/imagecategorizationlabelurlspost2
📖
Documentation
https://docs.nanonets.com/reference/file-review-api
📖
Documentation
https://docs.nanonets.com/reference/assign-files-via-api
📖
Documentation
https://docs.nanonets.com/reference/delete-files-via-api
📖
Documentation
https://docs.nanonets.com/reference/export-files-via-api
📖
Documentation
https://docs.nanonets.com/reference/update-fields-via-api
📖
Documentation
https://docs.nanonets.com/docs/retry-file-upload-via-api

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

nanonets-image-classification-predict-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Nanonets External Integrations Image Classification Predict API
  description: 'Manage external database integrations linked to a Nanonets account and

    execute generic SQL-style queries against them inside a Nanonets workflow.

    Used by the Database Matching Conditions and database lookup workflow blocks.

    '
  version: 1.0.0
  contact:
    name: Nanonets
    url: https://nanonets.com
    email: support@nanonets.com
servers:
- url: https://app.nanonets.com
security:
- BasicAuth: []
tags:
- name: Image Classification Predict
  description: Predict on uploaded images or image URLs against a classification model.
paths:
  /ImageCategorization/LabelFile/:
    post:
      tags:
      - Image Classification Predict
      summary: Prediction For Image File
      description: Upload a file from the local filesystem to an image classification model.
      operationId: imageCategorizationLabelFilePost
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - file
              - modelId
              properties:
                file:
                  type: string
                  format: binary
                modelId:
                  type: string
                  description: Unique identifier of the classification model.
      responses:
        '200':
          description: Classification result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationResponse'
  /ImageCategorization/LabelUrls/:
    post:
      tags:
      - Image Classification Predict
      summary: Prediction For Image URLs
      description: Submit one or more publicly accessible image URLs for classification.
      operationId: imageCategorizationLabelUrlsPost
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - urls
              - modelId
              properties:
                urls:
                  type: array
                  items:
                    type: string
                    format: uri
                modelId:
                  type: string
      responses:
        '200':
          description: Classification result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationResponse'
components:
  schemas:
    ClassificationResponse:
      type: object
      properties:
        message:
          type: string
        result:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              prediction:
                type: array
                items:
                  type: object
                  properties:
                    label:
                      type: string
                    probability:
                      type: number
                      minimum: 0
                      maximum: 1
              input:
                type: string
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic