Get workload diagnosis metadata

Get the workload diagnosis request schema and a runnable example.

GET /doctor/workload

Get workload diagnosis metadata

cURL

curl --request GET \
  --url https://useorgx.com/api/v1/doctor/workload

200

{
  "name": "OrgX Workload Doctor",
  "schema_version": "workload-diagnosis/0.1",
  "endpoint": "https://useorgx.com/api/v1/doctor/workload",
  "method": "POST",
  "content_type": "application/json",
  "account_required": false,
  "accepts_credentials": false,
  "persists_submissions": false,
  "max_bytes": 16384,
  "request_example": {
    "schema_version": "workload-diagnosis/0.1",
    "workload": {
      "name": "Review the launch plan",
      "outcome": "Deploy the reviewed change.",
      "time_horizon": "single_turn",
      "agent_count": 1,
      "coordination": "none",
      "systems": [
        {
          "category": "code_repository",
          "access": "read",
          "side_effect": "none",
          "data_class": "public"
        }
      ],
      "authority": {
        "actions": [
          "research"
        ],
        "approval_policy": "not_applicable",
        "budget_control": "not_applicable"
      },
      "accountability": {
        "evidence": "none",
        "acceptance": "none",
        "consequence": "low",
        "retention": "none"
      }
    }
  },
  "curl_example": "curl -X POST https://useorgx.com/api/v1/doctor/workload -H 'content-type: application/json' --data '{\"schema_version\":\"workload-diagnosis/0.1\",\"workload\":{\"name\":\"Ship and verify a release\"}}'",
  "browser_handoff": "No browser handoff is required for this workload."
}

Response

200

application/json

Workload Doctor request metadata

name · string · required

Allowed value: "OrgX Workload Doctor"

schema_version · string · required

Allowed value: "workload-diagnosis/0.1"

endpoint · string<uri> · required

method · string · required

Allowed value: "POST"

content_type · string · required

Allowed value: "application/json"

account_required · boolean · required

accepts_credentials · boolean · required

persists_submissions · boolean · required

max_bytes · integer · required

request_example · object · required

Show child attributes

curl_example · string · required

browser_handoff · string · required