Admin Transcode

Generated admin transcode operations.

GET/v1/admin/transcode/capacityRead server transcode capacityadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_admin_transcode_capacity

Responses

200Successapplication/json

Example

{
  "data": {
    "dependencies": {
      "key": {
        "ok": true,
        "path": "string",
        "version": "string"
      }
    },
    "directStreamRemux": true,
    "enabled": true,
    "hardware": {
      "configured": "string",
      "device": "string",
      "devices": [
        {
          "id": "id_8h2k4q",
          "inUse": true,
          "method": "string",
          "name": "Fargo"
        }
      ],
      "effective": "string",
      "formats": [
        {
          "decode": true,
          "encode": true,
          "format": "2026-10-18T19:30:00Z"
        }
      ],
      "lastError": {
        "backend": "string",
        "detail": "string",
        "device": "string",
        "reason": "string"
      },
      "lastTest": 0,
      "probes": [
        {
          "backend": "string",
          "detail": "string",
          "device": "string",
          "encoder": "string",
          "supported": true
        }
      ]
    },
    "hdrToneMapping": {
      "detail": "string",
      "status": "string"
    },
    "observedAt": 0,
    "planningPolicy": "string",
    "playedRetentionMs": 1800000,
    "presets": [
      {
        "audioKbps": 0,
        "height": 0,
        "id": "id_8h2k4q",
        "label": "string",
        "videoKbps": 0
      }
    ],
    "sessions": {
      "active": 0,
      "background": 0,
      "hardware": 0,
      "limits": {
        "background": 0,
        "concurrent": 0,
        "hardware": 0,
        "software": 0
      },
      "software": 0
    },
    "temporaryDirectory": {
      "fallback": true,
      "freeBytes": 0,
      "memoryAvailable": true,
      "memoryPath": "string",
      "path": "string",
      "ready": true
    },
    "throttleBufferMs": 1800000,
    "toolchain": {
      "bitstreamFilters": {
        "key": true
      },
      "configuration": "string",
      "decoders": {
        "key": true
      },
      "dolbyVisionProfile7To81": true,
      "encoders": {
        "key": true
      },
      "filters": {
        "key": true
      },
      "hwaccels": {
        "key": true
      },
      "identity": "string",
      "muxers": {
        "key": true
      },
      "openclAvailable": true,
      "version": "string",
      "vulkanAvailable": true
    },
    "warnings": [
      "string"
    ],
    "x264Preset": "string"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- dependenciesobjectrequired
  - okbooleanrequired
  - pathstringrequired
  - versionstringrequired
- directStreamRemuxbooleanrequired
- enabledbooleanrequired
- hardwareobjectrequired
  - configuredstringrequired
  - devicestringrequired
  - devicesarray of objectrequired
    idstringrequired
    inUsebooleanrequired
    methodstring
    namestringrequired
  - effectivestringrequired
  - formatsarray of objectrequired
    decodebooleanrequired
    encodebooleanrequired
    formatstringrequired
  - lastErrorobject | any | nullrequired
    backendstring
    detailstring
    devicestring
    reasonstringrequired
  - lastTestintegerrequired
  - probesarray of objectrequired
    backendstringrequired
    detailstringrequired
    devicestring
    encoderstring
    supportedbooleanrequired
- hdrToneMappingobjectrequired
  - detailstringrequired
  - statusstringrequired
- observedAtintegerrequired
- planningPolicystringrequired
- playedRetentionMsintegerrequired
- presetsarray of objectrequired
  - audioKbpsintegerrequired
  - heightintegerrequired
  - idstringrequired
  - labelstringrequired
  - videoKbpsintegerrequired
- sessionsobjectrequired
  - activeinteger | any | nullrequired
  - backgroundinteger | any | nullrequired
  - hardwareinteger | any | nullrequired
  - limitsobjectrequired
    backgroundintegerrequired
    concurrentintegerrequired
    hardwareintegerrequired
    softwareintegerrequired
  - softwareinteger | any | nullrequired
- temporaryDirectoryobjectrequired
  - fallbackbooleanrequired
  - freeBytesinteger | any | nullrequired
  - memoryAvailablebooleanrequired
  - memoryPathstringrequired
  - pathstringrequired
  - readybooleanrequired
- throttleBufferMsintegerrequired
- toolchainobject
  - bitstreamFiltersobjectrequired
  - configurationstringrequired
  - decodersobjectrequired
  - dolbyVisionProfile7To81booleanrequired
  - encodersobjectrequired
  - filtersobjectrequired
  - hwaccelsobjectrequired
  - identitystringrequired
  - muxersobjectrequired
  - openclAvailablebooleanrequired
  - versionstringrequired
  - vulkanAvailablebooleanrequired
- warningsarray of stringrequired
- x264Presetstringrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/transcode/capacity" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/transcode/capacity/testProbe every graphics adapter and backend again nowadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: test_admin_transcode_hardware
Max body: 4 KiB

Request body application/json · required

Example

{}

Schema

object

Responses

200Successapplication/json

Example

{
  "data": {
    "dependencies": {
      "key": {
        "ok": true,
        "path": "string",
        "version": "string"
      }
    },
    "directStreamRemux": true,
    "enabled": true,
    "hardware": {
      "configured": "string",
      "device": "string",
      "devices": [
        {
          "id": "id_8h2k4q",
          "inUse": true,
          "method": "string",
          "name": "Fargo"
        }
      ],
      "effective": "string",
      "formats": [
        {
          "decode": true,
          "encode": true,
          "format": "2026-10-18T19:30:00Z"
        }
      ],
      "lastError": {
        "backend": "string",
        "detail": "string",
        "device": "string",
        "reason": "string"
      },
      "lastTest": 0,
      "probes": [
        {
          "backend": "string",
          "detail": "string",
          "device": "string",
          "encoder": "string",
          "supported": true
        }
      ]
    },
    "hdrToneMapping": {
      "detail": "string",
      "status": "string"
    },
    "observedAt": 0,
    "planningPolicy": "string",
    "playedRetentionMs": 1800000,
    "presets": [
      {
        "audioKbps": 0,
        "height": 0,
        "id": "id_8h2k4q",
        "label": "string",
        "videoKbps": 0
      }
    ],
    "sessions": {
      "active": 0,
      "background": 0,
      "hardware": 0,
      "limits": {
        "background": 0,
        "concurrent": 0,
        "hardware": 0,
        "software": 0
      },
      "software": 0
    },
    "temporaryDirectory": {
      "fallback": true,
      "freeBytes": 0,
      "memoryAvailable": true,
      "memoryPath": "string",
      "path": "string",
      "ready": true
    },
    "throttleBufferMs": 1800000,
    "toolchain": {
      "bitstreamFilters": {
        "key": true
      },
      "configuration": "string",
      "decoders": {
        "key": true
      },
      "dolbyVisionProfile7To81": true,
      "encoders": {
        "key": true
      },
      "filters": {
        "key": true
      },
      "hwaccels": {
        "key": true
      },
      "identity": "string",
      "muxers": {
        "key": true
      },
      "openclAvailable": true,
      "version": "string",
      "vulkanAvailable": true
    },
    "warnings": [
      "string"
    ],
    "x264Preset": "string"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- dependenciesobjectrequired
  - okbooleanrequired
  - pathstringrequired
  - versionstringrequired
- directStreamRemuxbooleanrequired
- enabledbooleanrequired
- hardwareobjectrequired
  - configuredstringrequired
  - devicestringrequired
  - devicesarray of objectrequired
    idstringrequired
    inUsebooleanrequired
    methodstring
    namestringrequired
  - effectivestringrequired
  - formatsarray of objectrequired
    decodebooleanrequired
    encodebooleanrequired
    formatstringrequired
  - lastErrorobject | any | nullrequired
    backendstring
    detailstring
    devicestring
    reasonstringrequired
  - lastTestintegerrequired
  - probesarray of objectrequired
    backendstringrequired
    detailstringrequired
    devicestring
    encoderstring
    supportedbooleanrequired
- hdrToneMappingobjectrequired
  - detailstringrequired
  - statusstringrequired
- observedAtintegerrequired
- planningPolicystringrequired
- playedRetentionMsintegerrequired
- presetsarray of objectrequired
  - audioKbpsintegerrequired
  - heightintegerrequired
  - idstringrequired
  - labelstringrequired
  - videoKbpsintegerrequired
- sessionsobjectrequired
  - activeinteger | any | nullrequired
  - backgroundinteger | any | nullrequired
  - hardwareinteger | any | nullrequired
  - limitsobjectrequired
    backgroundintegerrequired
    concurrentintegerrequired
    hardwareintegerrequired
    softwareintegerrequired
  - softwareinteger | any | nullrequired
- temporaryDirectoryobjectrequired
  - fallbackbooleanrequired
  - freeBytesinteger | any | nullrequired
  - memoryAvailablebooleanrequired
  - memoryPathstringrequired
  - pathstringrequired
  - readybooleanrequired
- throttleBufferMsintegerrequired
- toolchainobject
  - bitstreamFiltersobjectrequired
  - configurationstringrequired
  - decodersobjectrequired
  - dolbyVisionProfile7To81booleanrequired
  - encodersobjectrequired
  - filtersobjectrequired
  - hwaccelsobjectrequired
  - identitystringrequired
  - muxersobjectrequired
  - openclAvailablebooleanrequired
  - versionstringrequired
  - vulkanAvailablebooleanrequired
- warningsarray of stringrequired
- x264Presetstringrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/transcode/capacity/test" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'