Skip to content
GhostMind

OpenAPI

Public OpenAPI Specification

The public OpenAPI spec contains only /v1/* data plane routes (40 paths, 0 admin routes):

https://ghostmind.optdmsa.com/openapi-public.json

Source review on 2026-09-10 (9a6a273) found 40 public paths / 50 operations. This is not confirmation of the deployed revision.

Use the spec for discovery, but do not assume generated SDKs are complete: the current spec has no Bearer securitySchemes/operation security declarations, 24 operations contain an empty response schema, and SSE/binary responses need explicit contracts. Authentication is enforced in application code despite the missing OpenAPI metadata. Configure Bearer authentication explicitly in clients. The public filter removes internal paths but currently retains the full components collection, including internal schemas.

Interactive Docs

  • Public Swagger UI: https://ghostmind.optdmsa.com/docs-public
  • Full internal + public ReDoc: https://ghostmind.optdmsa.com/redoc (not a public-only specification)

Using the OpenAPI Spec

You can generate client SDKs from the public OpenAPI specification using tools like:

  • openapi-generator
  • swagger-codegen
Terminal window
# Generate a Python client
openapi-generator-cli generate \
  -i https://ghostmind.optdmsa.com/openapi-public.json \
  -g python \
  -o ghostmind-client

What’s in the Public Spec

The public spec includes all /v1/* endpoints:

  • Chat completions and models
  • Conversations and messages
  • Projects and project files
  • File attachments
  • Assets (generated artifacts) and downloads
  • Audio transcription and speech generation
  • Capabilities and connections discovery
  • Action catalog, runs, events and cancellation (execution is beta-gated)

See the complete method-and-path inventory. There is no public /v1 endpoint for usage-report retrieval or the full teach/compile/verify/publish journey in this revision.

What’s NOT in the Public Spec

Admin routes (/admin/v1/*) and User BFF routes (/me/v1/*) are excluded from the public spec. These are internal operator and user-app endpoints.

Next Steps