FactorGuide Diagnose API

The Diagnose API from FactorGuide — 1 operation(s) for diagnose.

GitHub OpenAPI

Operations 1

POST /diagnose Diagnose #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/factorguide-io:factorguide-io-diagnose-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

factorguide-io-diagnose-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: FactorGuide Diagnose API
  version: 1.2.1
tags:
- name: Diagnose
paths:
  /diagnose:
    post:
      summary: Diagnose
      description: POST /diagnose — single-pair diagnostic.
      operationId: diagnose_diagnose_post
      parameters:
      - name: x-wallet
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Wallet
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiagnoseRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagnoseResponse'
        '400':
          description: Invalid wallet or request
        '402':
          description: Payment required
        '422':
          description: Validation error
        '429':
          description: Rate limit exceeded
      tags:
      - Diagnose
components:
  schemas:
    DiagnoseRequest:
      properties:
        i:
          anyOf:
          - type: string
          - type: integer
          title: I
        j:
          anyOf:
          - type: string
          - type: integer
          title: J
        coupling_value:
          type: number
          maximum: 1.0
          minimum: 0.0
          title: Coupling Value
        sample_size:
          type: integer
          minimum: 10.0
          title: Sample Size
        variance_i:
          anyOf:
          - type: number
          - type: 'null'
          title: Variance I
        variance_j:
          anyOf:
          - type: number
          - type: 'null'
          title: Variance J
      type: object
      required:
      - i
      - j
      - coupling_value
      - sample_size
      title: DiagnoseRequest
      description: 'Single-pair diagnostic: IC with risk prediction for both model classes.'
    DetectionCostClass:
      type: string
      enum:
      - free
      - cheap
      - marginal
      - expensive
      title: DetectionCostClass
    DiagnoseResponse:
      properties:
        i:
          anyOf:
          - type: string
          - type: integer
          title: I
        j:
          anyOf:
          - type: string
          - type: integer
          title: J
        ic:
          type: number
          title: Ic
        ic_type:
          type: string
          title: Ic Type
          default: marginal_correlation
        risk_constitutive:
          type: number
          title: Risk Constitutive
        risk_inductive:
          type: number
          title: Risk Inductive
        zone:
          type: integer
          title: Zone
        extrapolated:
          type: boolean
          title: Extrapolated
          default: false
        extrapolation_warning:
          anyOf:
          - type: string
          - type: 'null'
          title: Extrapolation Warning
        sign_detectability:
          anyOf:
          - $ref: '#/components/schemas/SignDetectabilityPair'
          - type: 'null'
        note:
          type: string
          title: Note
          default: IC is computed from the provided coupling_value (marginal). For partial correlation IC accounting for all other variables, use /navigate with the full matrix.
      type: object
      required:
      - i
      - j
      - ic
      - risk_constitutive
      - risk_inductive
      - zone
      title: DiagnoseResponse
    SignDetectabilityPair:
      properties:
        i:
          type: string
          title: I
        j:
          type: string
          title: J
        ic:
          type: number
          title: Ic
        variance_ratio:
          type: number
          title: Variance Ratio
        k_eff:
          type: number
          title: K Eff
        even_odd_gap:
          type: number
          title: Even Odd Gap
        sign_detectable:
          type: boolean
          title: Sign Detectable
        signed_ic:
          anyOf:
          - type: number
          - type: 'null'
          title: Signed Ic
        detection_cost_class:
          $ref: '#/components/schemas/DetectionCostClass'
      type: object
      required:
      - i
      - j
      - ic
      - variance_ratio
      - k_eff
      - even_odd_gap
      - sign_detectable
      - detection_cost_class
      title: SignDetectabilityPair