Coactive Classification API

openapi: 3.2.0
info:
  title: Reference Classification API
  version: 1.0.0
servers:
- url: https://api.coactive.ai
  description: Production
- url: https://app.coactive.ai
  description: Production
tags:
- name: Classification
paths:
  /api/v1/classify/image/url:
    post:
      operationId: classification_classify_image_at_url
      summary: Classify image at public url
      description: Classify an image downloadable via a public url for specific concepts or all concepts within a dataset
      tags:
      - Classification
      parameters:
      - name: threshold
        in: query
        description: Threshold above which classification is positive
        required: false
        schema:
          type: number
          format: double
          default: 0.5
      responses:
        '200':
          description: Result of the classification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Classification'
        '404':
          description: Dataset not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicUrlClassificationRequest'
      security:
      - HTTPBearer: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Details about the encountered error
      required:
      - detail
      description: Details about an error that occurred
      title: ErrorResponse
    PublicUrlClassificationRequest:
      type: object
      properties:
        url:
          type: string
          description: A public url for downloading the image
        conceptIds:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid4
          description: The ids of concepts to use to classify an image
        datasetId:
          type:
          - string
          - 'null'
          format: uuid4
          description: The id of the dataset related to the concepts to use to classify an image
      required:
      - url
      description: 'A request to classify a publicly downloadable image for specific concepts or all concepts

        for a dataset. Either concept ids of a dataset id must be provided.'
      title: PublicUrlClassificationRequest
    ValidationError:
      type: object
      properties:
        loc:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorLocItems'
        msg:
          type: string
        type:
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      title: HTTPValidationError
    ClassificationScore:
      type: object
      properties:
        conceptName:
          type: string
          description: The concept name
        conceptId:
          type: string
          format: uuid4
          description: The concept id
        threshold:
          type: number
          format: double
          description: The threshold used to determine if it's a positive example
        positive:
          type: boolean
          description: If the sample is classified as positive
        score:
          type: number
          format: double
          description: The classification score in the range [0, 1]
      required:
      - conceptName
      - conceptId
      - threshold
      - positive
      - score
      description: A classification of an asset for a single concept
      title: ClassificationScore
    ValidationErrorLocItems:
      oneOf:
      - type: string
      - type: integer
      - type: string
      - type: integer
      title: ValidationErrorLocItems
    Classification:
      type: object
      properties:
        scores:
          type: array
          items:
            $ref: '#/components/schemas/ClassificationScore'
          description: Classifications of images for the relevant concept(s)
      required:
      - scores
      description: A classification of an asset for one or more concepts
      title: Classification
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Coactive
  source: https://docs.coactive.ai/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)