seekrit-dev guides API

openapi: 3.1.0
info:
  title: seekrit-dev guides API
  version: '2026-10-30'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-30: 15 operation(s) read from 11 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; seekrit-dev has published no machine-readable contract
    that the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 26
    documentation: 118
    pages-with-code: 27
    pages-read: 40
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-30'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://seekrit.dev/docs/guides/agent-proxy
  - https://seekrit.dev/docs/guides/ai-agents
  - https://seekrit.dev/docs/guides/audit-export
  - https://seekrit.dev/docs/guides/frameworks/openai-agents-api.md
  - https://seekrit.dev/docs/guides/kubernetes
  - https://seekrit.dev/docs/guides/neon-functions
  - https://seekrit.dev/docs/guides/provisioner
  - https://seekrit.dev/docs/guides/run
  - https://seekrit.dev/docs/guides/sandboxes/boat
  - https://seekrit.dev/docs/guides/vault
  - https://seekrit.dev/docs/guides/wasm
  x-docs-section: guides
servers:
- url: https://api.seekrit.dev
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://seekrit.dev/docs/guides/agent-proxy
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl ) is\nbetter served by the forward-proxy model: the workload sets one environment\nvariable and every egress flows through\
          \ the proxy, no per-SDK wiring. \n [ forward ] \n listen = \"127.0.0.1:8081\" \n unmatched_host_policy = \"tunnel\" # or \"deny\" \n\
          \ ca_cert = \"seekrit-proxy-ca.pem\" \n ca_key = \"seekrit-proxy-ca-key.pem\" \n [[ forward . host ]] \n match = \"api.example.com\"\
          \ \n allow = [ \"EXAMPLE_API_KEY\" ]"
  /healthz:
    get:
      operationId: get_healthz
      tags:
      - Healthz
      summary: Health check endpoint for liveness probes.
      x-source: https://seekrit.dev/docs/guides/provisioner
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetHealthzResponse'
      x-evidence:
        kind: documentation
  /install.sh:
    get:
      operationId: get_install_sh
      tags:
      - Install
      summary: GET /install.sh
      x-source: https://seekrit.dev/docs/guides/agent-proxy
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL https://proxy.seekrit.dev/install.sh | sh A binary on your PATH , for a container image, a CI runner, or a systemd\
          \ unit where Node is not in the picture. docker run seekritdev/proxy A container — multi-arch, static musl on scratch . cargo build\
          \ --release From source, in apps/proxy . \n note Every path above lands on the same released binary and verifies the same\npublished\
          \ SHA-256. That i"
  /latest/seekrit-secrets.wasm:
    get:
      operationId: get_latest_seekrit_secrets_wasm
      tags:
      - Latest
      summary: GET /latest/seekrit-secrets.wasm
      x-source: https://seekrit.dev/docs/guides/wasm
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSLO https://wasm.seekrit.dev/latest/seekrit-secrets.wasm \n Everything is versioned ( :0.4.0 / /v0.2.0/ ) and carries\
          \ a latest . The\n rc.1 and environment-only builds are the same reference with -rc1 and\n -env : ghcr.io/seekritdev/secrets:latest-rc1\
          \ , or\n https://wasm.seekrit.dev/latest/seekrit-secrets-env.wasm . The Spin build is a\npackage of its own — ghcr.io/seekritdev/secrets-spin:0.4.0"
  /latest/{latestid}:
    get:
      operationId: get_latest_latestid
      tags:
      - Latest
      summary: GET /latest/seekrit-run-aarch64-apple-darwin.sha256
      x-source: https://seekrit.dev/docs/guides/run
      parameters:
      - name: latestid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL -O https://run.seekrit.dev/latest/seekrit-run-aarch64-apple-darwin.sha256 \n shasum -a 256 -c seekrit-run-aarch64-apple-darwin.sha256\
          \ \n tar xzf seekrit-run-aarch64-apple-darwin.tar.gz \n install -m 0755 seekrit-run /usr/local/bin/ \n Windows ships as a .zip ( seekrit-run-x86_64-pc-windows-msvc.zip\
          \ ). \n Usage "
        collapsed_from: 2 example path(s) differing only at latestId
  /secrets:
    get:
      operationId: get_secrets
      tags:
      - Secrets
      summary: Returns envContents and every secret file's contents verbatim.
      x-source: https://seekrit.dev/docs/guides/sandboxes/boat
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSecretsResponse'
      x-evidence:
        kind: documentation
  /signup:
    post:
      operationId: post_signup
      tags:
      - Signup
      summary: POST /signup
      x-source: https://seekrit.dev/docs/guides/ai-agents
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSignupRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -sX POST https://mcp.seekrit.dev/signup  -H ''content-type: application/json''  -d ''{"orgName": "Acme Storefront", "orgSlug":
          "acme-storefront"}'' '
  /v${SEEKRIT_RUN_VERSION}/seekrit-run-${TARGET}.sha256:
    get:
      operationId: get_v_SEEKRIT_RUN_VERSION_seekrit_run_TARGET_sha256
      tags:
      - V Seekrit Run Version
      summary: Downloads the SHA-256 checksum for a versioned seekrit-run binary archive.
      x-source: https://seekrit.dev/docs/guides/run
      parameters:
      - name: SEEKRIT_RUN_VERSION
        in: path
        required: true
        schema:
          type: string
      - name: TARGET
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v${SEEKRIT_RUN_VERSION}/seekrit-run-${TARGET}.tar.gz:
    get:
      operationId: get_v_SEEKRIT_RUN_VERSION_seekrit_run_TARGET_tar_gz
      tags:
      - V Seekrit Run Version
      summary: GET /v${SEEKRIT_RUN_VERSION}/seekrit-run-${TARGET}.tar.gz
      x-source: https://seekrit.dev/docs/guides/run
      parameters:
      - name: SEEKRIT_RUN_VERSION
        in: path
        required: true
        schema:
          type: string
      - name: TARGET
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl && cd /tmp  && curl -fsSL -O https://run.seekrit.dev/v${SEEKRIT_RUN_VERSION}/seekrit-run-${TARGET}.tar.gz  && curl -fsSL
          -O https://run.seekrit.dev/v${SEEKRIT_RUN_VERSION}/seekrit-run-${TARGET}.sha256  && sha256sum -c seekrit-run-${TARGET}.sha256  && tar
          xzf seekrit-run-${TARGET}.tar.gz -C /usr/local/bin '
  /v1/charges:
    post:
      operationId: post_v1_charges
      tags:
      - Charges
      summary: Process a charge request (example from approval workflow documentation).
      x-source: https://seekrit.dev/docs/guides/agent-proxy
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/connections/{id}/revoke:
    post:
      operationId: post_v1_connections_id_revoke
      tags:
      - Connections
      summary: Revoke a connection through the executor, telling the provider first then revoking in seekrit.
      x-source: https://seekrit.dev/docs/guides/vault
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1ConnectionsIdRevokeRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/models:
    get:
      operationId: get_v1_models
      tags:
      - Models
      summary: GET /v1/models
      x-source: https://seekrit.dev/docs/guides/neon-functions
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1ModelsResponse'
      x-evidence:
        kind: code-example
        language: javascript
        snippet: "fetch ( \"https://api.openai.com/v1/models\" , { \n headers : { authorization : `Bearer ${apiKey} ` }, \n })"
  /v1/orgs:
    put:
      operationId: put_v1_orgs
      tags:
      - Orgs
      summary: PUT /v1/orgs
      x-source: https://seekrit.dev/docs/guides/audit-export
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutV1OrgsRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X PUT https://api.seekrit.dev/v1/orgs/ $ORG /log-sink  -H \"authorization: Bearer $( seekrit token auth ) \"  -H \"content-type:\
          \ application/json\"  -d '{ \n \"endpoint\": \"https://collector.example.com/v1/logs\", \n \"headers\": { \"Authorization\": \"Bearer\
          \ <your-collector-token>\" }, \n \"enabled\": true \n }' \n Endpoint — the full OTLP/HTTP logs URL, typically ending in /v1/logs . \n\
          \ Headers — sent with eve"
  /v1/secrets:
    get:
      operationId: get_v1_secrets
      tags:
      - Secrets
      summary: Returns a whole-environment map with decrypted secrets for use with ESO's dataFrom and target.template.
      x-source: https://seekrit.dev/docs/guides/kubernetes
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1SecretsResponse'
      x-evidence:
        kind: documentation
  /…:
    get:
      operationId: get
      tags:
      - API
      summary: GET /…
      x-source: https://seekrit.dev/docs/guides/frameworks/openai-agents-api.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://api.internal/…` inside the executor''s environment doesn''t. For

          that, run the proxy in [forward mode](/docs/guides/agent-proxy#forward-proxy-transparent-via-https_proxy)

          and set `HTTPS_PROXY` plus the CA bundle in the executor''s environment — every

          outbound request is then matched against the same allowlist, whoever made it.

          The honest caveat is in that section: `HTTPS_PROXY` is not co'
security:
- bearer: []
components:
  schemas:
    GetHealthzResponse:
      type: object
      properties:
        ok:
          type: boolean
    GetSecretsResponse:
      type: object
      properties:
        envContents:
          type: string
    PostSignupRequest:
      type: object
      properties:
        orgName:
          type: string
        orgSlug:
          type: string
    PostV1ConnectionsIdRevokeRequest:
      type: object
      properties:
        userRef:
          type: string
          description: The user's opaque identifier
      required:
      - userRef
    GetV1ModelsResponse:
      type: object
      properties:
        models:
          type: integer
    PutV1OrgsRequest:
      type: object
      properties:
        endpoint:
          type: string
        headers:
          type: object
          properties:
            Authorization:
              type: string
        enabled:
          type: boolean
    GetV1SecretsResponse:
      type: object
      properties:
        data:
          type: object
          description: 'A map of secret names to values (NAME: value, …)'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
tags:
- name: API
- name: Api
- name: Charges
- name: Connections
- name: Healthz
- name: Install
- name: Latest
- name: Models
- name: Orgs
- name: Secrets
- name: Signup
- name: V Seekrit Run Version