Microsoft Azure Reviews API

openapi: 3.2.0
info:
  title: Microsoft Azure Content Moderator Client Reviews API
  version: '1.0'
  description: You use the API to scan your content as it's generated.
security:
- apim_key: []
tags:
- name: Reviews
paths:
  /contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}:
    get:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsGetreview
      description: Returns review details for the passed review ID.
      parameters:
      - name: teamName
        in: path
        description: Your team name.
        required: true
        schema:
          type: string
      - name: reviewId
        in: path
        description: ID of the review.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Review'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Get Review request:
          $ref: ../v1.0/examples/GetReviewResource.JSON
      summary: Microsoft Azure Get Contentmoderator Review 0 Teams Teamname Reviews Reviewid
  /contentmoderator/review/v1.0/teams/{teamName}/jobs/{JobId}:
    get:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsGetjobdetails
      description: Get the job details for a job ID.
      parameters:
      - name: teamName
        in: path
        description: Your team name.
        required: true
        schema:
          type: string
      - name: JobId
        in: path
        description: ID of the job.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Get Job Details request:
          $ref: ../v1.0/examples/GetJobDetailsResource.JSON
      summary: Microsoft Azure Get Contentmoderator Review 0 Teams Teamname Jobs Jobid
  /contentmoderator/review/v1.0/teams/{teamName}/reviews:
    post:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsCreatereviews
      description: 'The created reviews appear for reviewers on your team. As reviewers finish reviewing, results of the reviews are posted (that is, HTTP POST) on the specified CallBackEndpoint value.


        CallBack Schemas

        Review Completion CallBack Sample


        {

        "ReviewId": "",

        "ModifiedOn": "2016-10-11T22:36:32.9934851Z",

        "ModifiedBy": "",

        "CallBackType": "Review",

        "ContentId": "",

        "Metadata": {

        "adultscore": "0.xxx",

        "a": "False",

        "racyscore": "0.xxx",

        "r": "True"

        },

        "ReviewerResultTags": {

        "a": "False",

        "r": "True"

        }

        }


        .'
      parameters:
      - name: UrlContentType
        description: Content type.
        required: true
        in: header
        schema:
          type: string
      - $ref: '#/components/parameters/teamName'
      - $ref: '#/components/parameters/subTeam'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewList'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Create Review request:
          $ref: ../v1.0/examples/CreateReviewResource.JSON
      summary: Microsoft Azure Post Contentmoderator Review 0 Teams Teamname Reviews
      requestBody:
        content:
          application/json:
            schema:
              type: array
              description: Schema of the body.
              items:
                required:
                - Content
                - ContentId
                - Type
                type: object
                description: Schema items of the body.
                properties:
                  Type:
                    description: Type of the content.
                    enum:
                    - Image
                    - Text
                    type: string
                  Content:
                    description: Content to review.
                    type: string
                  ContentId:
                    description: Content identifier.
                    type: string
                  CallbackEndpoint:
                    description: Callback endpoint.
                    type: string
                  Metadata:
                    description: Metadata details.
                    type: array
                    items:
                      required:
                      - Key
                      - Value
                      type: object
                      properties:
                        Key:
                          description: Your key parameter.
                          type: string
                        Value:
                          description: Your value parameter.
                          type: string
        description: Body of the API for creating reviews.
        required: true
  /contentmoderator/review/v1.0/teams/{teamName}/jobs:
    post:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsCreatejob
      description: 'A job ID will be returned for the content posted on this endpoint.


        After the content is evaluated against the provided workflow, the review will be created or ignored based on the workflow expression.


        CallBack Schemas


        Job Completion CallBack Sample


        {

        "JobId": ",

        "ReviewId": "",

        "WorkFlowId": "default",

        "Status": "",

        "ContentType": "Image",

        "ContentId": "",

        "CallBackType": "Job",

        "Metadata": {

        "adultscore": "0.xxx",

        "a": "False",

        "racyscore": "0.xxx",

        "r": "True"

        }

        }


        Review Completion CallBack Sample


        {

        "ReviewId": "",

        "ModifiedOn": "2016-10-11T22:36:32.9934851Z",

        "ModifiedBy": "",

        "CallBackType": "Review",

        "ContentId": "",

        "Metadata": {

        "adultscore": "0.xxx",

        "a": "False",

        "racyscore": "0.xxx",

        "r": "True"

        },

        "ReviewerResultTags": {

        "a": "False",

        "r": "True"

        }

        }


        .'
      parameters:
      - $ref: '#/components/parameters/teamName'
      - $ref: '#/components/parameters/ContentType'
      - $ref: '#/components/parameters/ContentId'
      - $ref: '#/components/parameters/WorkflowName'
      - $ref: '#/components/parameters/CallBackEndpoint'
      - name: Content-Type
        description: Content type.
        required: true
        x-ms-client-name: jobContentType
        in: header
        schema:
          type: string
          enum:
          - application/json
          - image/jpeg
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobId'
            text/json:
              schema:
                $ref: '#/components/schemas/JobId'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
            text/json:
              schema:
                $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Create Job request:
          $ref: ../v1.0/examples/CreateJobResource.JSON
      summary: Microsoft Azure Post Contentmoderator Review 0 Teams Teamname Jobs
      requestBody:
        content:
          application/json:
            schema:
              required:
              - ContentValue
              type: object
              properties:
                ContentValue:
                  description: Content to evaluate for a job.
                  type: string
          image/jpeg:
            schema:
              required:
              - ContentValue
              type: object
              properties:
                ContentValue:
                  description: Content to evaluate for a job.
                  type: string
        description: Content to evaluate.
        required: true
  /contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/frames:
    post:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsAddvideoframe
      description: 'The created reviews appear for reviewers on your team. As reviewers finish reviewing, results of the reviews are posted (that is, HTTP POST) on the specified CallBackEndpoint value.


        CallBack Schemas

        Review Completion CallBack Sample


        {

        "ReviewId": "",

        "ModifiedOn": "2016-10-11T22:36:32.9934851Z",

        "ModifiedBy": "",

        "CallBackType": "Review",

        "ContentId": "",

        "Metadata": {

        "adultscore": "0.xxx",

        "a": "False",

        "racyscore": "0.xxx",

        "r": "True"

        },

        "ReviewerResultTags": {

        "a": "False",

        "r": "True"

        }

        }


        .'
      parameters:
      - $ref: '#/components/parameters/teamName'
      - name: reviewId
        description: ID of the review.
        in: path
        required: true
        schema:
          type: string
      - name: timescale
        description: Timescale of the video that you're adding frames to.
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: OK.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      summary: Microsoft Azure Post Contentmoderator Review 0 Teams Teamname Reviews Reviewid…
    get:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsGetvideoframes
      description: 'The created reviews appear for reviewers on your team. As reviewers finish reviewing, results of the reviews are posted (that is, HTTP POST) on the specified CallBackEndpoint value.


        CallBack Schemas

        Review Completion CallBack Sample


        {

        "ReviewId": "",

        "ModifiedOn": "2016-10-11T22:36:32.9934851Z",

        "ModifiedBy": "",

        "CallBackType": "Review",

        "ContentId": "",

        "Metadata": {

        "adultscore": "0.xxx",

        "a": "False",

        "racyscore": "0.xxx",

        "r": "True"

        },

        "ReviewerResultTags": {

        "a": "False",

        "r": "True"

        }

        }


        .'
      parameters:
      - $ref: '#/components/parameters/teamName'
      - $ref: '#/components/parameters/reviewId'
      - name: startSeed
        in: query
        description: Time stamp of the frame from where you want to start fetching the frames.
        schema:
          type: integer
      - name: noOfRecords
        in: query
        description: Number of frames to fetch.
        schema:
          type: integer
      - name: filter
        in: query
        description: Get frames filtered by tags.
        schema:
          type: string
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Frames'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Get Frames Request:
          $ref: ./examples/GetFramesResource.JSON
      summary: Microsoft Azure Get Contentmoderator Review 0 Teams Teamname Reviews Reviewid…
  /contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/publish:
    post:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsPublishvideoreview
      description: Publish a video review.
      parameters:
      - $ref: '#/components/parameters/teamName'
      - $ref: '#/components/parameters/reviewId'
      responses:
        '204':
          description: No content.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      x-ms-examples:
        publish video request:
          $ref: ../v1.0/examples/PublishVideoReviewResource.JSON
      summary: Microsoft Azure Post Contentmoderator Review 0 Teams Teamname Reviews Reviewid…
  /contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/transcriptmoderationresult:
    put:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsAddvideotranscriptmoderationresult
      description: This API adds a transcript screen text result file for a video review. The transcript screen text result file is a result of the Screen Text API. To generate a transcript screen text result file, you must screen a transcript file for profanity by using the Screen Text API.
      parameters:
      - name: Content-Type
        description: Content type.
        x-ms-client-name: ContentType
        required: true
        in: header
        schema:
          type: string
      - $ref: '#/components/parameters/teamName'
      - $ref: '#/components/parameters/reviewId'
      - $ref: '#/components/parameters/transcriptModerationBody'
      responses:
        '204':
          description: No content.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Transcript moderation result request:
          $ref: ../v1.0/examples/TranscriptModerationResult.JSON
      summary: Microsoft Azure Put Contentmoderator Review 0 Teams Teamname Reviews Reviewid…
  /contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/transcript:
    put:
      tags:
      - Reviews
      operationId: microsoftAzureReviewsAddvideotranscript
      description: This API adds a transcript file (text version of all the words spoken in a video) to a video review. The file should be in a valid WebVTT format.
      parameters:
      - $ref: '#/components/parameters/teamName'
      - $ref: '#/components/parameters/reviewId'
      - name: Content-Type
        description: Content type.
        required: true
        x-ms-client-name: ContentType
        in: header
        schema:
          type: string
          enum:
          - text/plain
      - $ref: '#/components/parameters/transcriptFile'
      responses:
        '204':
          description: No content.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      x-ms-examples:
        Add transcript request:
          $ref: ../v1.0/examples/AddVideoTranscriptResource.JSON
      summary: Microsoft Azure Put Contentmoderator Review 0 Teams Teamname Reviews Reviewid…
components:
  schemas:
    APIError:
      type: object
      description: Error information that the API returns.
      properties:
        Error:
          $ref: '#/components/schemas/Error'
    KeyValuePair:
      description: Key/value pair object properties.
      properties:
        Key:
          description: Key parameter.
          type: string
        Value:
          description: Value parameter.
          type: string
    Review:
      description: Review object.
      properties:
        ReviewId:
          description: ID of the review.
          type: string
        SubTeam:
          description: Name of the subteam.
          type: string
        Status:
          description: Status string (<Pending, Complete>).
          type: string
        ReviewerResultTags:
          description: Array of key/value pairs with reviewer-set tags.
          type: array
          items:
            $ref: '#/components/schemas/KeyValuePair'
        CreatedBy:
          description: Reviewer name.
          type: string
        Metadata:
          description: Array of key/value pairs.
          type: array
          items:
            $ref: '#/components/schemas/KeyValuePair'
        Type:
          description: Type of content.
          type: string
        Content:
          description: Content value.
          type: string
        ContentId:
          description: ID of the content.
          type: string
        CallbackEndpoint:
          description: Callback endpoint.
          type: string
    JobExecutionReportDetails:
      description: Values in the job execution report.
      properties:
        Ts:
          description: Time details.
          type: string
        Msg:
          description: Message details.
          type: string
    Tag:
      description: Tag details.
      properties:
        Key:
          description: Key parameter.
          type: string
        Value:
          description: Value parameter.
          type: string
    Job:
      description: Job object.
      properties:
        Id:
          description: Job ID.
          type: string
        TeamName:
          description: Team name associated with the job.
          type: string
        Status:
          description: Status string.
          type: string
        WorkflowId:
          description: ID of the workflow.
          type: string
        Type:
          description: Type of the content.
          type: string
        CallBackEndpoint:
          description: Callback endpoint.
          type: string
        ReviewId:
          description: Review ID if one is created.
          type: string
        ResultMetaData:
          description: Array of key/value pairs.
          type: array
          items:
            $ref: '#/components/schemas/KeyValuePair'
        JobExecutionReport:
          description: Array of key/value pair objects in the job execution report.
          type: array
          items:
            $ref: '#/components/schemas/JobExecutionReportDetails'
    JobId:
      properties:
        JobId:
          description: ID of the created job.
          type: string
    Frames:
      description: Response for a request to get frames.
      properties:
        ReviewId:
          description: ID of the review.
          type: string
        VideoFrames:
          type: array
          items:
            $ref: '#/components/schemas/Frame'
    ReviewList:
      description: List of review IDs.
      type: array
      items:
        type: string
    Frame:
      description: Video frame property details.
      properties:
        Timestamp:
          description: Time stamp of the frame.
          type: string
        FrameImage:
          description: Frame image.
          type: string
        Metadata:
          description: Array of key/value pairs.
          type: array
          items:
            $ref: '#/components/schemas/KeyValuePair'
        ReviewerResultTags:
          description: Reviewer result tags.
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    Error:
      type: object
      description: Error body.
      properties:
        Code:
          type: string
        Message:
          type: string
  parameters:
    transcriptFile:
      name: VTT file
      in: body
      required: true
      schema:
        type: object
        format: file
      description: Transcript file of the video.
      x-ms-parameter-location: method
    WorkflowName:
      name: WorkflowName
      in: query
      description: Workflow name that you want to invoke.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    CallBackEndpoint:
      name: CallBackEndpoint
      in: query
      description: Callback endpoint for posting the result of creating a job.
      x-ms-parameter-location: method
      schema:
        type: string
    ContentType:
      name: ContentType
      in: query
      description: Image, text or video.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        enum:
        - Image
        - Text
        - Video
    teamName:
      name: teamName
      description: Your team name.
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    transcriptModerationBody:
      name: transcriptModerationBody
      description: Body of the API for adding video transcript moderation results.
      in: body
      required: true
      schema:
        type: array
        description: Schema of the body.
        items:
          required:
          - Timestamp
          - Terms
          type: object
          description: Schema items of the body.
          properties:
            Timestamp:
              description: Time stamp of the image.
              type: string
            Terms:
              description: Metadata details.
              type: array
              items:
                required:
                - Index
                - Term
                type: object
                properties:
                  Index:
                    description: Index of the word.
                    type: integer
                  Term:
                    description: Detected word.
                    type: string
      x-ms-parameter-location: method
    reviewId:
      name: reviewId
      description: ID of the review.
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    ContentId:
      name: ContentId
      in: query
      description: ID or name to identify the submitted content.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    subTeam:
      name: subTeam
      description: Subteam that you want to assign the created review to.
      in: query
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
  securitySchemes:
    apim_key:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
x-ms-parameterized-host:
  hostTemplate: '{Endpoint}'
  useSchemePrefix: false
  parameters:


# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-reviews-api-openapi.yml