Klineo/Docs
Open app ↗

API v1 reference

v1 · API reference

The committed KlineO Liquidity Studio API 1.0.0 contract describes 142 operations across 130 paths. This reference is generated from that contract.

Base path: /api/liquidity-studio/v1. Use your deployment’s origin; the documentation host is not an API origin.

Download the OpenAPI 3.1 contract · Browse schemas · API integration guide

Choose a resource family#

Resource family Operations
Platform, credentials and webhooks 3
Other API resources 62
Venues, allocations and migrations 3
Proof, vaults, receipts and passports 60
Proposal review and Safe evidence 9
Projects and public discovery 5

Access and authority#

Authentication is listed per operation. Alternatives separated by OR are independent ways to authenticate; a session-only route is unavailable to a service token. OAuth scopes permit only the operations listed by the contract. Workspace roles, current resource versions and runtime prerequisites may impose further checks.

The complete application contract includes session-only workflows as well as service SDK operations and public resources. Inclusion here does not promise an anonymous endpoint, active provider, funded vault or production deployment.

Preparation, simulation, policy compilation and lifecycle evidence routes do not grant financial execution authority. Issuer Safe authorization and verified typed adapters remain the authority boundary.

Every operation#

Method Path Operation ID
GET /openapi.json getOpenapiJson
GET /status getStatus
GET /retirement/status getRetirementStatus
POST /access-requests postAccessRequests
GET /public/proofs/{slug} getPublicProofsBySlug
GET /public/proofs/{slug}/bundle getPublicProofsBySlugBundle
GET /public/proofs/{slug}/artifacts getPublicProofsBySlugArtifacts
GET /session getSession
POST /organizations postOrganizations
GET /organizations getOrganizations
POST /invitations/accept postInvitationsAccept
POST /invitations/{token}/accept postInvitationsByTokenAccept
GET /organization getOrganization
PATCH /organization patchOrganization
GET /members getMembers
GET /invitations getInvitations
POST /invitations postInvitations
PATCH /members/{actorId} patchMembersByActorId
POST /members/{actorId}/revoke postMembersByActorIdRevoke
GET /organizations/{orgId}/projects getOrganizationsByOrgIdProjects
GET /assets/{chainId}/{address}/eligibility getAssetsByChainIdByAddressEligibility
GET /assets/{chainId}/{address}/assessments getAssetsByChainIdByAddressAssessments
POST /assets/{chainId}/{address}/assessments postAssetsByChainIdByAddressAssessments
GET /venues/bdex/deployments/current getVenuesBdexDeploymentsCurrent
GET /venues/bdex/deployments/{factoryAddress}/assessments getVenuesBdexDeploymentsByFactoryAddressAssessments
POST /venues/bdex/deployments/assessments postVenuesBdexDeploymentsAssessments
GET /pools/{address}/health getPoolsByAddressHealth
GET /pools/{address}/assessments getPoolsByAddressAssessments
POST /pools/{address}/assessments postPoolsByAddressAssessments
POST /organizations/{orgId}/safes/challenge postOrganizationsByOrgIdSafesChallenge
POST /organizations/{orgId}/safes/verify postOrganizationsByOrgIdSafesVerify
GET /vaults getVaults
POST /vaults postVaults
POST /vaults/preview-deployment postVaultsPreviewDeployment
GET /vaults/{vaultId} getVaultsByVaultId
GET /vaults/{vaultId}/issuer-exit-kit getVaultsByVaultIdIssuerExitKit
GET /vaults/{vaultId}/positions getVaultsByVaultIdPositions
GET /vaults/{vaultId}/inventory getVaultsByVaultIdInventory
GET /vaults/{vaultId}/depth getVaultsByVaultIdDepth
GET /vaults/{vaultId}/depth-history getVaultsByVaultIdDepthHistory
GET /vaults/{vaultId}/policy getVaultsByVaultIdPolicy
POST /vaults/{vaultId}/deployment-preview postVaultsByVaultIdDeploymentPreview
POST /vaults/{vaultId}/deployment-handoff postVaultsByVaultIdDeploymentHandoff
POST /vaults/{vaultId}/runtime-deployment-handoff postVaultsByVaultIdRuntimeDeploymentHandoff
POST /vaults/{vaultId}/deployment-finalization postVaultsByVaultIdDeploymentFinalization
POST /vaults/{vaultId}/deployment-handoff/cancel-expired postVaultsByVaultIdDeploymentHandoffCancelExpired
POST /vaults/{vaultId}/deployment-risk/reassess postVaultsByVaultIdDeploymentRiskReassess
POST /vaults/{vaultId}/lifecycle-transitions postVaultsByVaultIdLifecycleTransitions
POST /vaults/{vaultId}/testnet-mechanics-gates postVaultsByVaultIdTestnetMechanicsGates
POST /vaults/{vaultId}/testnet-mechanics-gates/{artifactId}/approval postVaultsByVaultIdTestnetMechanicsGatesByArtifactIdApproval
POST /vaults/{vaultId}/live-expansion-gates postVaultsByVaultIdLiveExpansionGates
POST /vaults/{vaultId}/live-expansion-gates/{artifactId}/approval postVaultsByVaultIdLiveExpansionGatesByArtifactIdApproval
POST /vaults/{vaultId}/capital-top-up-handoffs postVaultsByVaultIdCapitalTopUpHandoffs
POST /vaults/{vaultId}/capital-top-up-handoffs/{handoffId}/finalization postVaultsByVaultIdCapitalTopUpHandoffsByHandoffIdFinalization
POST /vaults/{vaultId}/capital-top-up-finalizations/{finalizationId}/reassessment postVaultsByVaultIdCapitalTopUpFinalizationsByFinalizationIdReassessment
POST /vaults/{vaultId}/control-handoffs postVaultsByVaultIdControlHandoffs
POST /vaults/{vaultId}/control-handoffs/{handoffId}/finalization postVaultsByVaultIdControlHandoffsByHandoffIdFinalization
POST /vaults/{vaultId}/policy-drafts postVaultsByVaultIdPolicyDrafts
GET /vaults/{vaultId}/policy-drafts getVaultsByVaultIdPolicyDrafts
POST /vaults/{vaultId}/policy-drafts/{policyId}/approve postVaultsByVaultIdPolicyDraftsByPolicyIdApprove
POST /vaults/{vaultId}/policy-drafts/{policyId}/handoffs postVaultsByVaultIdPolicyDraftsByPolicyIdHandoffs
POST /vaults/{vaultId}/policy-handoffs/{handoffId}/finalization postVaultsByVaultIdPolicyHandoffsByHandoffIdFinalization
POST /simulations postSimulations
POST /simulations/indexed postSimulationsIndexed
GET /jobs/{jobId} getJobsByJobId
GET /simulation-datasets getSimulationDatasets
GET /simulations/{simulationId} getSimulationsBySimulationId
POST /simulations/{simulationId}/policy-draft postSimulationsBySimulationIdPolicyDraft
GET /proposals getProposals
GET /vaults/{vaultId}/proposals getVaultsByVaultIdProposals
POST /vaults/{vaultId}/proposals postVaultsByVaultIdProposals
GET /proposals/{proposalId} getProposalsByProposalId
POST /proposals/{proposalId}/approve postProposalsByProposalIdApprove
POST /vaults/{vaultId}/proposals/{proposalId}/approve postVaultsByVaultIdProposalsByProposalIdApprove
POST /proposals/{proposalId}/safe-bundle postProposalsByProposalIdSafeBundle
POST /vaults/{vaultId}/proposals/{proposalId}/safe-bundle postVaultsByVaultIdProposalsByProposalIdSafeBundle
POST /proposals/{proposalId}/submissions postProposalsByProposalIdSubmissions
GET /incidents getIncidents
GET /alert-policies getAlertPolicies
POST /alert-policies postAlertPolicies
GET /alert-deliveries getAlertDeliveries
GET /safety-pause-commands getSafetyPauseCommands
GET /vaults/{vaultId}/executions getVaultsByVaultIdExecutions
POST /incidents/{incidentId}/acknowledge postIncidentsByIncidentIdAcknowledge
POST /incidents/{incidentId}/mitigate postIncidentsByIncidentIdMitigate
POST /incidents/{incidentId}/resolve postIncidentsByIncidentIdResolve
GET /billing getBilling
POST /vaults/{vaultId}/commercial-terms postVaultsByVaultIdCommercialTerms
POST /vaults/{vaultId}/commercial-terms/{termsId}/acceptance postVaultsByVaultIdCommercialTermsByTermsIdAcceptance
GET /reports/{reportId}/fee-accrual-preview getReportsByReportIdFeeAccrualPreview
POST /reports/{reportId}/fee-accruals postReportsByReportIdFeeAccruals
POST /invoices postInvoices
POST /invoices/{invoiceId}/payment-reconciliations postInvoicesByInvoiceIdPaymentReconciliations
GET /reports getReports
GET /reports/{reportId}/exports/{format} getReportsByReportIdExportsByFormat
GET /vaults/{vaultId}/reports/{period} getVaultsByVaultIdReportsByPeriod
POST /reports/{reportId}/publish postReportsByReportIdPublish
POST /reports/{reportId}/publication-finalization postReportsByReportIdPublicationFinalization
GET /data-health getDataHealth
GET /ai/outputs getAiOutputs
POST /ai/outputs postAiOutputs
GET /ai/outputs/{outputId} getAiOutputsByOutputId
GET /audit-events getAuditEvents
GET /organizations/{orgId}/members getOrganizationsByOrgIdMembers
POST /organizations/{orgId}/members postOrganizationsByOrgIdMembers
PATCH /organizations/{orgId}/members/{memberId} patchOrganizationsByOrgIdMembersByMemberId
POST /projects postProjects
GET /projects/{projectId} getProjectsByProjectId
POST /projects/{projectId}/eligibility-assessments postProjectsByProjectIdEligibilityAssessments
POST /projects/{projectId}/data-room/uploads postProjectsByProjectIdDataRoomUploads
POST /projects/{projectId}/lifecycle-transitions postProjectsByProjectIdLifecycleTransitions
POST /vaults/{vaultId}/deploy postVaultsByVaultIdDeploy
POST /vaults/{vaultId}/funding-intents postVaultsByVaultIdFundingIntents
POST /vaults/{vaultId}/pause postVaultsByVaultIdPause
POST /vaults/{vaultId}/exit-preview postVaultsByVaultIdExitPreview
POST /vaults/{vaultId}/exit postVaultsByVaultIdExit
GET /vaults/{vaultId}/balances getVaultsByVaultIdBalances
GET /simulations/{simulationId}/artifacts getSimulationsBySimulationIdArtifacts
POST /vaults/{vaultId}/strategy-evaluations postVaultsByVaultIdStrategyEvaluations
GET /vaults/{vaultId}/strategy-state getVaultsByVaultIdStrategyState
GET /vaults/{vaultId}/policies getVaultsByVaultIdPolicies
POST /vaults/{vaultId}/policies postVaultsByVaultIdPolicies
POST /vaults/{vaultId}/policies/{version}/review postVaultsByVaultIdPoliciesByVersionReview
POST /vaults/{vaultId}/policies/{version}/approve postVaultsByVaultIdPoliciesByVersionApprove
POST /vaults/{vaultId}/policies/{version}/activate postVaultsByVaultIdPoliciesByVersionActivate
POST /vaults/{vaultId}/policies/{version}/revoke postVaultsByVaultIdPoliciesByVersionRevoke
POST /proposals/{proposalId}/reject postProposalsByProposalIdReject
POST /proposals/{proposalId}/submit postProposalsByProposalIdSubmit
GET /proposals/{proposalId}/execution getProposalsByProposalIdExecution
GET /proposals/{proposalId}/reconciliation getProposalsByProposalIdReconciliation
GET /vaults/{vaultId}/market-quality getVaultsByVaultIdMarketQuality
GET /vaults/{vaultId}/data-health getVaultsByVaultIdDataHealth
GET /vaults/{vaultId}/incidents getVaultsByVaultIdIncidents
POST /vaults/{vaultId}/incidents/{incidentId}/acknowledge postVaultsByVaultIdIncidentsByIncidentIdAcknowledge
GET /vaults/{vaultId}/evidence getVaultsByVaultIdEvidence
GET /vaults/{vaultId}/events getVaultsByVaultIdEvents
POST /vaults/{vaultId}/reports postVaultsByVaultIdReports
GET /reports/{reportId} getReportsByReportId
GET /reports/{reportId}/performance-series getReportsByReportIdPerformanceSeries
GET /reports/{reportId}/download getReportsByReportIdDownload
GET /organizations/{orgId}/fee-schedule getOrganizationsByOrgIdFeeSchedule
GET /organizations/{orgId}/invoices getOrganizationsByOrgIdInvoices