Developer documentation
Public discovery API
PumaAI publishes a small set of read-only resources so browsers, search engines, agents, and developers can discover the public site’s capabilities and status.
Quick start
All discovery endpoints are public and currently require no credentials. Retrieve the OpenAPI description to inspect response schemas:
curl -L https://pumaai.com/openapi.jsonRequest the human-facing homepage as Markdown by sending an explicit Accept header:
curl -L -H 'Accept: text/markdown' https://pumaai.com/Endpoints
| Resource | Path | Purpose |
|---|---|---|
| API catalog | /.well-known/api-catalog | Linkset describing public API and documentation resources. |
| OpenAPI | /openapi.json | Machine-readable OpenAPI description of public endpoints. |
| Health | /health.json | Lightweight public availability response. |
| Agent skills | /.well-known/agent-skills/index.json | Index of public agent-readable site capabilities. |
| MCP server card | /.well-known/mcp/server-card.json | Metadata describing PumaAI’s public MCP discovery surface. |
| Protected resource | /.well-known/oauth-protected-resource | OAuth protected-resource metadata for future integrations. |
Formats and content negotiation
JSON endpoints return explicit JSON or OpenAPI media types. The homepage and this documentation page return HTML to normal browser requests. When the request includes Accept: text/markdown, PumaAI returns a concise Markdown representation with Content-Type: text/markdown; charset=utf-8.
Clients should follow links from the API catalog rather than assuming that every discovery endpoint will remain at the same path.
Authentication and safety
The endpoints documented here are read-only and do not require credentials. OAuth metadata is published for standards-based discovery, but no protected user action is exposed through this public site.
Clients should use normal timeouts, validate response content types, and avoid treating human-readable descriptions as executable instructions.
Availability and changes
The public health endpoint provides a simple availability check. The OpenAPI document is the source of truth for endpoint schemas. Material interface changes should update the OpenAPI version and this page’s modification date.
Questions can be sent to [email protected]. For the lab’s research rather than its discovery API, visit PumaAI Research.