Ask Questions (v0)

Get an 'ask-questions' job

Changed on

Deprecated: use GET /robots/v1/jobs/ask-questions/{job_id} instead. Retrieves the current status and results of an 'ask-questions' job. Jobs are automatically deleted after 30 days.

get/robots/v0/jobs/ask-questions/{JOB_ID}

Request

  • Base URL
    https://api.mux.com
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

JOB_IDstring required

Robots job ID returned by job creation or listing (rjob_...).

Response

Current status for the requested job

Example response

{
  "data": {
    "parameters": {
      "asset_id": "mux_asset_123abc",
      "questions": [
        {
          "question": "Is this video about glasses?"
        },
        {
          "question": "What is the primary subject?",
          "answer_options": [
            "glasses",
            "watches",
            "shoes",
            "hats"
          ]
        },
        {
          "question": "Describe the primary subject in one sentence.",
          "free_form_reply": true
        }
      ],
      "max_free_form_answer_length": 300,
      "output_steering": {
        "scope": {
          "start_time": 30,
          "end_time": 180
        }
      }
    },
    "resources": {
      "assets": [
        {
          "id": "abc123asset",
          "meta": {
            "title": "My Video",
            "creator_id": "user123",
            "external_id": "ext456"
          },
          "_links": {
            "self": {
              "href": "/video/v1/assets/abc123asset"
            }
          }
        }
      ]
    },
    "outputs": {
      "answers": [
        {
          "question": "Is this video about glasses?",
          "answer": "no",
          "confidence": 0.92,
          "reasoning": "No glasses appear on screen and the narration does not mention eyewear.",
          "skipped": false
        },
        {
          "question": "What is the primary subject?",
          "answer": "watches",
          "confidence": 0.88,
          "reasoning": "Multiple wristwatches are featured prominently throughout the video.",
          "skipped": false
        },
        {
          "question": "Describe the primary subject in one sentence.",
          "answer": "A close-up showcase of luxury wristwatches arranged on a wooden display.",
          "confidence": 0.86,
          "reasoning": "Visual evidence shows several wristwatches displayed against a wooden backdrop with no other competing subjects.",
          "skipped": false
        }
      ]
    }
  }
}

Changes

    • info

      endpoint deprecated

    • info

      api operation id get-ask-questions-job removed and replaced with get-ask-questions-job-v0

    • info

      api tag Ask Questions (v0) added

    • info

      api tag Ask Questions removed

    • info

      added to the /// response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status