> ## Documentation Index
> Fetch the complete documentation index at: https://docs.parmanasystems.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Machine-readable SDK and discovery manifest

> A single machine-readable index for coding agents and tooling: the OpenAPI spec locations, the rendered documentation views, the authentication scheme, and both official SDKs (TypeScript and Python) with their real, current package name, registry, and version, read directly from each package's own manifest at startup, see packages/api/src/routes/api-manifest.ts. Go and Java are reported as null: no SDK exists for those languages in this repository (see /sdks/other-languages on the documentation site). Exempt from caller authentication for the same reason GET /openapi.json is.




## OpenAPI

````yaml /openapi.bundled.yaml get /api-manifest.json
openapi: 3.1.0
info:
  title: Parmana API
  version: 1.0.0
  description: >
    Parmana is an Execution Trust Infrastructure that ensures there is no gap
    between what humans decide and what AI systems do. The API enables creation,
    execution, verification, replay, and auditing of Business Transactions
    through cryptographically verifiable Execution Trust Records.


    **Every route requires a caller bearer key**, except the liveness/readiness
    probes and documentation/verification routes that must be reachable with no
    credential: GET /health, GET /ready, GET /openapi.yaml, GET /documentation,
    GET /reference, POST /refusal/verify, POST /audit/verify, GET /keys/{keyId},
    and GET /.well-known/jwks.json. Send `Authorization: Bearer <key>` on every
    other request. Keys are issued by `scripts/generate-api-key.ts` and
    configured server-side via `PARMANA_API_KEYS`; only a hash of each key is
    ever held by the server, verified in constant time. A missing or invalid
    credential returns 401 before a Business Transaction is even constructed,
    independent of Policy evaluation and gateway attestation, see
    `packages/api/src/middleware/caller-auth.ts` and
    [Authentication](/api-reference/authentication). Local development may set
    `PARMANA_AUTH_DISABLED=true` to skip this middleware entirely; that flag
    must never be set in a real deployment.
  contact:
    name: Parmana Systems
    email: founder@parmanasystems.com
  license:
    name: Proprietary, source-available for evaluation only, see LICENSE
    url: https://github.com/pavancharak/AgentLabsBuildathon/blob/main/LICENSE
servers:
  - url: http://localhost:3000
    description: Local (packages/api, PORT env var, default 3000)
security:
  - bearerAuth: []
tags:
  - name: Execution
    description: >-
      Executes a Business Transaction through the complete Execution Trust
      pipeline
  - name: Transactions
    description: Business Transaction creation and retrieval
  - name: Verification
    description: Deterministic verification of an Execution Trust Record
  - name: Receipts
    description: Cryptographically signed Execution Trust Receipts
  - name: Trust Records
    description: Execution Trust Record retrieval
  - name: Replay
    description: Deterministic replay of a recorded Execution Trust Record
  - name: Policies
    description: Policy existence/readability check
  - name: Policy Governance
    description: Maker-checker proposal, listing, approval, and rejection of policy changes
  - name: Refusal Records
    description: >-
      Durable, signed evidence that a policy decision rejected a transaction
      (RFC-0021)
  - name: Audit
    description: >-
      Signed caller-authentication audit events, independently
      third-party-verifiable
  - name: System
    description: Operational endpoints
paths:
  /api-manifest.json:
    get:
      tags:
        - System
      summary: Machine-readable SDK and discovery manifest
      description: >
        A single machine-readable index for coding agents and tooling: the
        OpenAPI spec locations, the rendered documentation views, the
        authentication scheme, and both official SDKs (TypeScript and Python)
        with their real, current package name, registry, and version, read
        directly from each package's own manifest at startup, see
        packages/api/src/routes/api-manifest.ts. Go and Java are reported as
        null: no SDK exists for those languages in this repository (see
        /sdks/other-languages on the documentation site). Exempt from caller
        authentication for the same reason GET /openapi.json is.
      operationId: getApiManifest
      responses:
        '200':
          description: The manifest, JSON.
          content:
            application/json:
              schema:
                type: object
              examples:
                liveCapture:
                  summary: Real captured response
                  value:
                    name: Parmana
                    apiVersion: v1
                    buildVersion: 0.4.0
                    openapi:
                      json: /openapi.json
                      yaml: /openapi.yaml
                    documentation:
                      site: https://docs.parmanasystems.com
                      swaggerUi: /documentation
                      redoc: /reference
                    authentication:
                      type: bearer
                      header: 'Authorization: Bearer <key>'
                      docs: >-
                        https://docs.parmanasystems.com/api-reference/authentication
                    sdks:
                      typescript:
                        package: '@parmana/sdk'
                        registry: npm
                        version: 1.1.2
                        install: npm install @parmana/sdk
                        docs: https://docs.parmanasystems.com/sdks/typescript
                        reference: >-
                          https://docs.parmanasystems.com/sdks/reference/typescript/classes/ParmanaClient
                      python:
                        package: parmana
                        registry: pypi
                        version: 1.1.4
                        install: pip install parmana
                        docs: https://docs.parmanasystems.com/sdks/python
                        reference: >-
                          https://docs.parmanasystems.com/sdks/reference/python/client
                      go: null
                      java: null
                    connectorSdks:
                      typescript:
                        package: '@parmana/connector-sdk'
                        registry: npm
                        version: 0.1.0
                        install: npm install @parmana/connector-sdk
                        docs: >-
                          https://docs.parmanasystems.com/reference/connector-sdk
                      python:
                        package: parmana-connector-sdk
                        registry: pypi
                        version: 0.1.0
                        install: pip install parmana-connector-sdk
                        docs: >-
                          https://docs.parmanasystems.com/reference/connector-sdk-python
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Caller API key issued by scripts/generate-api-key.ts. Sent as
        Authorization: Bearer <key>. Verified against a stored SHA-256 hash in
        constant time by packages/api/src/auth/StaticKeyAuthenticator.ts.
        Required on every route not listed as exempt in this document's
        top-level description. See /api-reference/authentication.

````