v31

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-28124212862.9 KB

postWebhookrobots.job.ask_questions.processing

Payload

type'robots.job.ask_questions.processing' required

Type for the webhook event

idstring required

Unique identifier for the event

created_atstring date-time required

Time the event was created

request_idstring nullable
accessorstring nullable
accessor_sourcestring nullable

Example payload

{
  "created_at": "2022-01-01T00:00:00.000000Z",
  "attempts": [
    {
      "created_at": "2022-01-01T00:00:00.000000Z"
    }
  ],
  "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
    },
    "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
        }
      ]
    },
    "resources": {
      "assets": [
        {
          "id": "abc123asset",
          "meta": {
            "title": "My Video",
            "creator_id": "user123",
            "external_id": "ext456"
          },
          "_links": {
            "self": {
              "href": "https://api.mux.com/video/v1/assets/abc123asset"
            }
          }
        }
      ]
    }
  }
}

Response

Return a 200 to indicate that the data was received successfully