On this page
Document and Share a Function API
A deployed standalone MiniUp Function can have public API documentation and a directory listing. Use this to help intended callers understand your API without exposing its code or credentials.
Publish Function documentation
- Open Functions → your Function → Documentation.
- Set the Public name, Description, and comma-separated Tags.
- Describe the API’s purpose, methods, inputs, output, and access requirement in Documentation text.
- Add safe Example request and Example response values using placeholders.
- Choose Listed in the public API directory if you want discovery, then Save documentation.
- Use Preview public docs when available and verify that no private values are included.
Understand public documentation access
A Public or x402-enabled Function may keep an unlisted documentation link. An API Key Function without x402 must be listed before its documentation is publicly reachable. Listing describes the API; access rules still apply. Site Members Functions without x402 use the Site workflow. With x402 enabled, external callers can use the standalone payment endpoint.
The public MiniUp Function Explorer lets callers search listed APIs, filter by access type, HTTP method, or tag, and sort by useful directory metadata. x402 listings may also show their settled paid-call count. MiniUp does not present account-wide Function quota usage as per-API traffic.
For example, document an open coordinate utility with its accepted JSON fields and a sample response.
Paid Function listings
An x402 Paid listing shows x402 Paid and the exact price per request alongside the endpoint, methods, description, and tags. MiniUp Directory listing does not enable external x402 discovery or remove the payment requirement. Configure external discovery separately in API → x402 Monetization.
Important publishing notes
Do not include real API keys, private business records, or Function Secrets in descriptions or examples. Review the public documentation again after changing your handler’s request or response shape.