MIGHTY DEVELOPERS

Get a file processing request

GET /v1/mic/processing-requests/{requestId}. MIC API request examples, required scopes and response schemas. Sandbox access requires an approved application.

Start here →

Request access

Service access is reviewed before credentials are issued. Public documentation and the read-only demo do not grant private sandbox or production access.

GET /v1/mic/processing-requests/{requestId}

Operation ID: getMicSharedFileProcessingRequest

Authenticate your application

After access approval, sandbox provisioning and license activation, create client credentials in your workspace. Keep MIGHTY_CLIENT_ID and MIGHTY_CLIENT_SECRET in your server environment. Exchange them for an access token with the required scope. This example uses a POSIX shell such as Bash.

curl --request POST "https://www.pradiota.com/sandbox/oauth/token" \
  --user "$MIGHTY_CLIENT_ID:$MIGHTY_CLIENT_SECRET" \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'scope=mic.jobs:read'

Set MIGHTY_ACCESS_TOKEN to the returned access_token. Send it as Authorization: Bearer and request a new token when it expires. MIC API access is not enabled yet; request sandbox access to prepare your integration.

Send a request

After sandbox access is approved, use an access token for your application. Set MIGHTY_ACCESS_TOKEN. After MIC access is approved, open the MIC console at /developers/console/mic, choose the application and credential, then Load current workspace. Use the returned micws_ ID as MIC_WORKSPACE_ID and replace the other MIC variables with your workspace’s resource IDs. The example sends Bearer authentication and required query parameters; copying it does not send a request.

Required scope: mic.jobs:read. Additional permissions: none.

curl --request GET "https://www.pradiota.com/sandbox/v1/mic/processing-requests/${MIC_PROCESSING_REQUEST_ID}" \
  --header "Authorization: Bearer ${MIGHTY_ACCESS_TOKEN}" \
  --header 'Accept: application/json'

Query & header schemas

{
  "query": {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  },
  "headers": {}
}

Success response schema

HTTP 200

{
  "$ref": "#/$defs/Envelope",
  "$defs": {
    "Envelope": {
      "type": "object",
      "properties": {
        "data": {
          "$ref": "#/$defs/ProcessingRequestView"
        },
        "meta": {
          "$ref": "#/$defs/Meta"
        }
      },
      "required": [
        "data",
        "meta"
      ],
      "additionalProperties": false
    },
    "ProcessingRequestView": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 49,
          "maxLength": 49,
          "pattern": "^micsharedrequest_[a-f0-9]{32}$"
        },
        "sourceOrigin": {
          "type": "string",
          "const": "SHARED_FILE_REQUEST"
        },
        "workspaceId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "pattern": "^(?!.*\\.\\.)[A-Za-z0-9][A-Za-z0-9_.:-]*$"
        },
        "inputId": {
          "type": "string",
          "minLength": 41,
          "maxLength": 41,
          "pattern": "^micinput_[a-f0-9]{32}$"
        },
        "recipeVersionId": {
          "type": "string",
          "minLength": 43,
          "maxLength": 43,
          "pattern": "^micrecipev_[a-f0-9]{32}$"
        },
        "state": {
          "type": "string",
          "enum": [
            "SUBMITTED",
            "REVIEWABLE",
            "APPROVED",
            "REJECTED",
            "REVOKED"
          ]
        },
        "revision": {
          "type": "integer",
          "minimum": 1,
          "x-native-max-signed64-integer": "9223372036854775807",
          "x-native-integer-type-no-coercion": true
        },
        "requestHash": {
          "type": "string",
          "minLength": 64,
          "maxLength": 64,
          "pattern": "^[a-f0-9]{64}$"
        },
        "reviewHash": {
          "oneOf": [
            {
              "type": "string",
              "minLength": 64,
              "maxLength": 64,
              "pattern": "^[a-f0-9]{64}$"
            },
            {
              "type": "null"
            }
          ]
        },
        "reasonCode": {
          "oneOf": [
            {
              "type": "string",
              "enum": [
                "REVIEWED_PROCESSING_PURPOSE",
                "PURPOSE_NOT_ALLOWED",
                "SOURCE_NOT_ELIGIBLE",
                "ACCESS_NO_LONGER_REQUIRED",
                "SECURITY_REVOKED"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,6})?Z$",
          "x-native-valid-instant-required": true
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,6})?Z$",
          "x-native-valid-instant-required": true
        }
      },
      "required": [
        "id",
        "sourceOrigin",
        "workspaceId",
        "inputId",
        "recipeVersionId",
        "state",
        "revision",
        "requestHash",
        "reviewHash",
        "reasonCode",
        "createdAt",
        "expiresAt"
      ],
      "additionalProperties": false
    },
    "Meta": {
      "type": "object",
      "properties": {
        "requestId": {
          "type": "string",
          "minLength": 39,
          "maxLength": 39,
          "pattern": "^micreq_[a-f0-9]{32}$"
        }
      },
      "required": [
        "requestId"
      ],
      "additionalProperties": false
    }
  }
}

Use cURL or install the MIC SDK and follow the language examples.

Browse MIC methods