> ## Documentation Index > Fetch the complete documentation index at: https://docs.useorgx.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get workload diagnosis metadata > Get the workload diagnosis request schema and a runnable example. ## OpenAPI ````yaml /openapi/v1.yaml get /doctor/workload openapi: 3.1.0 info: title: OrgX REST API v1 version: '1' description: >- Build accountable work into your product with OrgX REST API v1. Create work with one field, attach evidence when it is complete, and keep the receipt. Every authenticated request is scoped to the workspace resolved from your credential. Start with `POST /work`. Human guide: https://docs.useorgx.com/docs/api/quickstart contact: name: OrgX Support url: https://useorgx.com/support email: support@useorgx.com license: name: Proprietary url: https://useorgx.com/terms servers: - url: https://useorgx.com/api/v1 description: Production security: [] tags: - name: Work description: Create accountable work and complete it with evidence - name: Initiatives description: Organize related work around an outcome - name: Operating processes description: Evidence-backed company workflow/process lifecycle - name: Operating map description: Derived, rebuildable Operating Map projection over the process ledger - name: Discovery runs description: Wizard and deep-search workflow discovery over connected company sources - name: Handoffs description: Ledger-backed stage handoffs between operating-process stages - name: Events description: Replayable, workspace-scoped accepted ledger events - name: Projections description: Workspace-scoped, rebuildable read projections over OrgX sources - name: Episodes description: Mission-compatible Episode read adapters - name: Receipt validation description: Account-free Agent Work Receipt schema discovery and conformance - name: Receipt import description: Authenticated, workspace-scoped import into the hosted receipt ledger - name: Workload diagnosis description: >- Account-free evaluation of time, agents, systems, authority, and accountability boundaries - name: Content Studio description: >- Estimate, showcase, checkout, and payment event operations for Content Studio - name: Decisions description: Raise decisions for human ruling and read their state - name: Controllers description: Shadow-only domain controller status and reconciliation - name: Artifacts description: Register produced work against the entity it belongs to - name: Launches description: Preview and run an initiative launch through its spend gates - name: Runs description: Control agent runs with pause, resume, cancel, and rollback - name: Lifecycle description: Pause, resume, retry, or cancel work hierarchy nodes and runs - name: Deduplication description: Claim durable event fingerprints so duplicate triggers fire once - name: Credential description: >- Resolve the calling credential, the workspaces it reaches, and what it may do - name: API discovery description: Account-free error codes, request schemas, and closed vocabularies for v1 externalDocs: description: Human-readable OrgX REST API v1 reference url: https://docs.useorgx.com/docs/api/public-api paths: /doctor/workload: get: tags: - Workload diagnosis summary: Get workload diagnosis metadata description: Get the workload diagnosis request schema and a runnable example. operationId: getWorkloadDoctorMetadata responses: '200': description: Workload Doctor request metadata content: application/json: schema: type: object required: - name - schema_version - endpoint - method - content_type - account_required - accepts_credentials - persists_submissions - max_bytes - request_example - curl_example - browser_handoff properties: name: type: string const: OrgX Workload Doctor schema_version: type: string const: workload-diagnosis/0.1 endpoint: type: string format: uri method: type: string const: POST content_type: type: string const: application/json account_required: type: boolean const: false accepts_credentials: type: boolean const: false persists_submissions: type: boolean const: false max_bytes: type: integer const: 16384 request_example: $ref: '#/components/schemas/WorkloadDiagnosisRequest' curl_example: type: string browser_handoff: type: string example: 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. '429': description: Public Workload Doctor metadata rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/PublicApiError' '503': description: Distributed production rate limiting is unavailable content: application/json: schema: $ref: '#/components/schemas/PublicApiError' components: schemas: WorkloadDiagnosisRequest: type: object additionalProperties: false required: - schema_version - workload properties: schema_version: type: string const: workload-diagnosis/0.1 workload: type: object additionalProperties: false required: - name - outcome - time_horizon - agent_count - coordination - systems - authority - accountability allOf: - if: required: - agent_count properties: agent_count: const: 1 then: properties: coordination: const: none - if: required: - authority properties: authority: required: - actions properties: actions: contains: const: write_internal_records then: properties: systems: contains: required: - access properties: access: enum: - write - admin - if: required: - authority properties: authority: required: - actions properties: actions: contains: const: modify_code then: properties: systems: contains: required: - category - access properties: category: enum: - code_repository - local_files access: enum: - write - admin - if: required: - authority properties: authority: required: - actions properties: actions: contains: const: merge_or_deploy then: properties: systems: contains: required: - category - access properties: category: enum: - code_repository - cloud_runtime access: enum: - write - admin - if: required: - authority properties: authority: required: - actions properties: actions: contains: const: send_external_message then: properties: systems: contains: required: - category - access properties: category: enum: - messaging - crm - browser - other access: enum: - write - admin - if: required: - authority properties: authority: required: - actions properties: actions: contains: const: spend_funds then: properties: systems: contains: required: - category - access properties: category: enum: - finance - browser access: enum: - write - admin - if: required: - authority properties: authority: required: - actions properties: actions: contains: const: create_account then: properties: systems: contains: required: - category - access properties: category: enum: - identity - browser - other access: enum: - write - admin - if: required: - authority properties: authority: required: - actions properties: actions: contains: const: change_permissions then: properties: systems: contains: required: - access properties: access: const: admin - if: required: - authority properties: authority: required: - actions properties: actions: contains: const: delete_data then: properties: systems: contains: required: - category - access properties: category: enum: - code_repository - document_store - crm - database - cloud_runtime - local_files - other access: enum: - write - admin properties: name: type: string description: >- Trimmed before the 1-to-120-character length check; whitespace-only, control-character, and credential-shaped values are rejected with 400. minLength: 1 allOf: - pattern: \S - pattern: ^\s*(?:\S|\S[\s\S]{0,118}\S)\s*$ - not: pattern: '[\u0000-\u0008\u000b\u000c\u000e-\u001f\u007f]' - not: pattern: >- (?:\b(?:[Aa][Pp][Ii][_-]?[Kk][Ee][Yy]|[Aa][Cc][Cc][Ee][Ss][Ss][_-]?[Tt][Oo][Kk][Ee][Nn]|[Rr][Ee][Ff][Rr][Ee][Ss][Hh][_-]?[Tt][Oo][Kk][Ee][Nn]|[Cc][Ll][Ii][Ee][Nn][Tt][_-]?[Ss][Ee][Cc][Rr][Ee][Tt]|[Pp][Aa][Ss][Ss][Ww][Oo][Rr][Dd])\s*[:=]\s*\S+|\b[Bb][Ee][Aa][Rr][Ee][Rr]\s+[A-Za-z0-9._~+/=-]{8,}|\b(?:(?:[Oo][Xx][Kk]_|[Ss][Kk]-|[Gg][Hh][PpOoUuSsRr]_)[A-Za-z0-9_-]{8,}|[Aa][Kk][Ii][Aa][A-Za-z0-9]{16})\b|-----[Bb][Ee][Gg][Ii][Nn] [A-Za-z ]*[Pp][Rr][Ii][Vv][Aa][Tt][Ee] [Kk][Ee][Yy]-----|:\/\/[^\/\s:@]+:[^\/\s@]+@) - not: pattern: >- (?:\b[Gg][Ii][Tt][Hh][Uu][Bb]_[Pp][Aa][Tt]_[A-Za-z0-9_]{8,}|\b[Gg][Ll][Pp][Aa][Tt]-[A-Za-z0-9_-]{16,}|\b[Xx][Oo][Xx][BbAaPpRrSs]-[A-Za-z0-9-]{8,}|\b[Ss][Kk]_[Ll][Ii][Vv][Ee]_[A-Za-z0-9_-]{8,}|\b[Rr][Kk]_[Ll][Ii][Vv][Ee]_[A-Za-z0-9_-]{8,}|\b[Nn][Pp][Mm]_[A-Za-z0-9]{8,}|\b[Aa][Ss][Ii][Aa][A-Z0-9]{16}|\b[Dd][Oo][Pp]_[Vv]1_[A-Fa-f0-9]{16,}|\b[Hh][Ff]_[A-Za-z0-9]{20,}|\beyJ[A-Za-z0-9_-]{8,}\.eyJ[A-Za-z0-9_-]{8,}\.[A-Za-z0-9_-]{8,}) outcome: type: string description: >- Trimmed before the 1-to-500-character length check; whitespace-only, control-character, and credential-shaped values are rejected with 400. minLength: 1 allOf: - pattern: \S - pattern: ^\s*(?:\S|\S[\s\S]{0,498}\S)\s*$ - not: pattern: '[\u0000-\u0008\u000b\u000c\u000e-\u001f\u007f]' - not: pattern: >- (?:\b(?:[Aa][Pp][Ii][_-]?[Kk][Ee][Yy]|[Aa][Cc][Cc][Ee][Ss][Ss][_-]?[Tt][Oo][Kk][Ee][Nn]|[Rr][Ee][Ff][Rr][Ee][Ss][Hh][_-]?[Tt][Oo][Kk][Ee][Nn]|[Cc][Ll][Ii][Ee][Nn][Tt][_-]?[Ss][Ee][Cc][Rr][Ee][Tt]|[Pp][Aa][Ss][Ss][Ww][Oo][Rr][Dd])\s*[:=]\s*\S+|\b[Bb][Ee][Aa][Rr][Ee][Rr]\s+[A-Za-z0-9._~+/=-]{8,}|\b(?:(?:[Oo][Xx][Kk]_|[Ss][Kk]-|[Gg][Hh][PpOoUuSsRr]_)[A-Za-z0-9_-]{8,}|[Aa][Kk][Ii][Aa][A-Za-z0-9]{16})\b|-----[Bb][Ee][Gg][Ii][Nn] [A-Za-z ]*[Pp][Rr][Ii][Vv][Aa][Tt][Ee] [Kk][Ee][Yy]-----|:\/\/[^\/\s:@]+:[^\/\s@]+@) - not: pattern: >- (?:\b[Gg][Ii][Tt][Hh][Uu][Bb]_[Pp][Aa][Tt]_[A-Za-z0-9_]{8,}|\b[Gg][Ll][Pp][Aa][Tt]-[A-Za-z0-9_-]{16,}|\b[Xx][Oo][Xx][BbAaPpRrSs]-[A-Za-z0-9-]{8,}|\b[Ss][Kk]_[Ll][Ii][Vv][Ee]_[A-Za-z0-9_-]{8,}|\b[Rr][Kk]_[Ll][Ii][Vv][Ee]_[A-Za-z0-9_-]{8,}|\b[Nn][Pp][Mm]_[A-Za-z0-9]{8,}|\b[Aa][Ss][Ii][Aa][A-Z0-9]{16}|\b[Dd][Oo][Pp]_[Vv]1_[A-Fa-f0-9]{16,}|\b[Hh][Ff]_[A-Za-z0-9]{20,}|\beyJ[A-Za-z0-9_-]{8,}\.eyJ[A-Za-z0-9_-]{8,}\.[A-Za-z0-9_-]{8,}) time_horizon: type: string enum: - single_turn - single_session - multi_day - recurring - continuous agent_count: type: integer minimum: 1 maximum: 64 coordination: type: string enum: - none - handoff - parallel - hierarchical systems: type: array maxItems: 12 uniqueItems: true description: >- Each category may appear at most once; report its highest access and consequence. allOf: - contains: required: - category properties: category: const: code_repository minContains: 0 maxContains: 1 - contains: required: - category properties: category: const: issue_tracker minContains: 0 maxContains: 1 - contains: required: - category properties: category: const: document_store minContains: 0 maxContains: 1 - contains: required: - category properties: category: const: messaging minContains: 0 maxContains: 1 - contains: required: - category properties: category: const: crm minContains: 0 maxContains: 1 - contains: required: - category properties: category: const: database minContains: 0 maxContains: 1 - contains: required: - category properties: category: const: cloud_runtime minContains: 0 maxContains: 1 - contains: required: - category properties: category: const: finance minContains: 0 maxContains: 1 - contains: required: - category properties: category: const: browser minContains: 0 maxContains: 1 - contains: required: - category properties: category: const: local_files minContains: 0 maxContains: 1 - contains: required: - category properties: category: const: identity minContains: 0 maxContains: 1 - contains: required: - category properties: category: const: other minContains: 0 maxContains: 1 items: type: object additionalProperties: false required: - category - access - side_effect - data_class properties: category: type: string enum: - code_repository - issue_tracker - document_store - messaging - crm - database - cloud_runtime - finance - browser - local_files - identity - other access: type: string enum: - read - write - admin side_effect: type: string enum: - none - reversible - external - irreversible data_class: type: string enum: - public - internal - confidential - regulated authority: type: object additionalProperties: false required: - actions - approval_policy - budget_control allOf: - if: properties: actions: contains: enum: - write_internal_records - modify_code - merge_or_deploy - send_external_message - spend_funds - create_account - change_permissions - delete_data then: properties: approval_policy: enum: - per_action - sensitive_actions - exceptions_only - undefined - if: properties: actions: contains: const: spend_funds then: properties: budget_control: enum: - fixed_limit - dynamic_limit - unbounded - undefined else: properties: budget_control: enum: - not_applicable - undefined properties: actions: type: array uniqueItems: true maxItems: 11 items: type: string enum: - research - draft - read_internal_data - write_internal_records - modify_code - merge_or_deploy - send_external_message - spend_funds - create_account - change_permissions - delete_data approval_policy: type: string enum: - not_applicable - per_action - sensitive_actions - exceptions_only - undefined budget_control: type: string enum: - not_applicable - fixed_limit - dynamic_limit - unbounded - undefined accountability: type: object additionalProperties: false required: - evidence - acceptance - consequence - retention properties: evidence: type: string enum: - none - activity_log - artifact - verified_outcome acceptance: type: string enum: - none - agent - human - downstream_system consequence: type: string enum: - low - moderate - high - regulated retention: type: string enum: - none - short_term - long_term - regulated PublicApiError: type: object required: - error properties: ok: type: boolean valid: type: boolean error: type: object required: - code - message properties: code: type: string message: type: string issues: type: array items: type: object ````