> ## Documentation Index > Fetch the complete documentation index at: https://docs.open-cluster.io/llms.txt > Use this file to discover all available pages before exploring further. # Open investigation ## OpenAPI ````yaml /api/openapi.yaml post /api/v1/investigations openapi: 3.1.0 info: title: OpenCluster Control Plane API version: 0.1.0 description: HTTP contract for the OpenCluster product API and inbound webhook endpoints. license: name: Apache-2.0 servers: - url: http://localhost:8080 description: Local self-hosted deployment security: [] tags: - name: Authentication - name: Organizations - name: Members - name: Sessions - name: Policy - name: Audit - name: Integration Types - name: Integrations - name: Relays - name: Incidents - name: Investigations - name: Conversations - name: Postmortems - name: Webhook Deliveries - name: Webhook Intake - name: Metadata paths: /api/v1/investigations: post: tags: - Investigations summary: Open investigation operationId: openInvestigation parameters: - $ref: '#/components/parameters/Organization' requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenInvestigationRequest' required: true responses: '200': $ref: '#/components/responses/Clarification' '202': $ref: '#/components/responses/Investigation' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/Unavailable' security: - SessionCookie: [] components: parameters: Organization: name: X-OpenCluster-Organization in: header required: true description: Selects the Organization whose data and membership are authorized. schema: $ref: '#/components/schemas/OrganizationID' example: acme-production schemas: OpenInvestigationRequest: type: object additionalProperties: false properties: incidentId: $ref: '#/components/schemas/UUID' question: type: string minLength: 1 maxLength: 8192 anyOf: - required: - incidentId - required: - question OrganizationID: type: string pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$ minLength: 1 maxLength: 63 UUID: type: string format: uuid Clarification: type: object additionalProperties: false required: - clarification properties: clarification: type: string minLength: 1 maxLength: 2048 Investigation: type: object additionalProperties: false required: - id - status - subject - windowFrom - windowUntil - impact - findings - hypotheses - actions - limitations - humanConfirmationRequired - spend - createdAt properties: id: $ref: '#/components/schemas/UUID' status: type: string enum: - queued - investigating - needs_input - partial - concluded - cancelled - failed subject: type: string minLength: 1 maxLength: 1024 question: type: string maxLength: 8192 incidentId: $ref: '#/components/schemas/UUID' integrationId: $ref: '#/components/schemas/UUID' windowFrom: $ref: '#/components/schemas/Timestamp' windowUntil: $ref: '#/components/schemas/Timestamp' conclusionStatus: type: string enum: - verified_cause - supported_explanation - inconclusive - answer_only summary: type: string maxLength: 32768 impact: $ref: '#/components/schemas/ImpactAssessment' findings: type: array items: $ref: '#/components/schemas/Finding' hypotheses: type: array items: $ref: '#/components/schemas/Hypothesis' actions: type: array items: $ref: '#/components/schemas/ActionProposal' limitations: type: array items: $ref: '#/components/schemas/Limitation' humanConfirmationRequired: type: boolean stoppedBy: type: string enum: - spend - tool_runs - reasoner_turns - wall_clock - stagnation - context error: type: string maxLength: 4096 spend: type: object additionalProperties: false required: - inputTokens - outputTokens - microCents properties: inputTokens: type: integer format: int64 minimum: 0 outputTokens: type: integer format: int64 minimum: 0 microCents: type: integer format: int64 minimum: 0 createdBy: type: string maxLength: 256 createdAt: $ref: '#/components/schemas/Timestamp' concludedAt: $ref: '#/components/schemas/Timestamp' Error: type: object additionalProperties: false required: - error properties: error: type: string minLength: 1 maxLength: 1024 example: the selected Organization is not available to this caller reason: type: string enum: - credential_rejected - session_expired - session_revoked requires: type: string minLength: 1 maxLength: 128 Timestamp: type: string format: date-time ImpactAssessment: type: object additionalProperties: false required: - status - currentState - affectedServices - affectedUsers - summary - runRefs properties: status: type: string enum: - known - partial - unknown currentState: type: string maxLength: 4096 affectedServices: type: array items: type: string minLength: 1 maxLength: 512 uniqueItems: true affectedUsers: type: array items: type: string minLength: 1 maxLength: 512 uniqueItems: true summary: type: string maxLength: 4096 runRefs: type: array items: type: integer minimum: 1 uniqueItems: true Finding: type: object additionalProperties: false required: - id - statement - kind - confidence - mechanism - runRefs properties: id: type: string minLength: 1 maxLength: 128 statement: type: string minLength: 1 maxLength: 4096 kind: type: string enum: - cause - trigger - contributing_factor - symptom - propagation - ruled_out - unresolved - observation confidence: type: string enum: - confirmed - likely - possible mechanism: type: string maxLength: 4096 runRefs: type: array minItems: 1 items: type: integer minimum: 1 uniqueItems: true Hypothesis: type: object additionalProperties: false required: - id - statement - status - test - runRefs properties: id: type: string minLength: 1 maxLength: 128 statement: type: string minLength: 1 maxLength: 4096 status: type: string enum: - exploring - supported - ruled_out - unresolved test: type: string maxLength: 4096 runRefs: type: array items: type: integer minimum: 1 uniqueItems: true ActionProposal: type: object additionalProperties: false required: - title - type - rationale - risk - reversible - requiresApproval - verification - runRefs properties: title: type: string minLength: 1 maxLength: 512 type: type: string enum: - mitigate - rollback - verify - fix - monitor rationale: type: string minLength: 1 maxLength: 512 risk: type: string enum: - low - medium - high reversible: type: boolean requiresApproval: type: boolean verification: type: string minLength: 1 maxLength: 512 runRefs: type: array items: type: integer minimum: 1 uniqueItems: true Limitation: type: object additionalProperties: false required: - type - statement - runRefs properties: type: type: string enum: - missing_telemetry - missing_access - contradiction - unresolved_assumption - essential_human_input statement: type: string minLength: 1 maxLength: 4096 runRefs: type: array items: type: integer minimum: 1 uniqueItems: true responses: Clarification: description: A question needed before an Investigation can be opened. content: application/json: schema: $ref: '#/components/schemas/Clarification' Investigation: description: Investigation. content: application/json: schema: $ref: '#/components/schemas/Investigation' BadRequest: description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Missing or rejected credential. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: >- Membership, permission, Organization selection, or cookie origin was rejected. content: application/json: schema: $ref: '#/components/schemas/Error' RateLimited: description: A bounded concurrency or request limit was reached. headers: Retry-After: schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/Error' Unavailable: description: A required configured capability is unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: SessionCookie: type: apiKey in: cookie name: __Host-oc_session ````