API Docs
Live OpenAPI references from the Cloud apps that publish an API contract.
API Docs collects the OpenAPI references published by currently registered Cloud apps. Use it to find an operation, read its request and response schemas, or retrieve a live contract for tooling without searching application source.
Use API Docs
- Choose the app that owns the data or action you want to integrate.
- Search by operation name, route, field, or schema.
- Open an operation to inspect its method, path, parameters, request body, responses, and declared authentication.
- Compare reusable schemas before creating a client or mapping data.
- Retrieve the raw OpenAPI document when another tool needs the live contract.
Understand the API Docs model
| Resource or surface | Responsibility |
|---|---|
| API source | One registered app and the OpenAPI URL it publishes |
| Operation | An HTTP method and path with parameters, schemas, and responses |
| Schema | A reusable request or response shape from the owning app |
| Security metadata | The credentials an operation declares it accepts |
| Source selector | The browser control for switching between app references |
Only apps that publish a safe OpenAPI source appear in API Docs. The list changes with the live app registry, so a missing app may be offline or may not publish an OpenAPI contract.
An operation that validates its input lists a 400 response for input that
fails validation. Unless the app documents another body, it is a JSON object
with a message and, when the app returns a stable error, a code. A request
body that cannot be parsed, such as malformed JSON, gets a 400 with a
plain-text message instead.
How API Docs fits Cloud
API Docs aggregates contracts; it does not own the operations or merge their schemas into one API. Each app remains responsible for the accuracy of its own reference. Published security metadata describes accepted credentials but does not enforce access, and seeing an operation does not grant permission to call it.
Find detailed product help
Open Help inside API Docs for source selection, operation lookup, schemas, authentication metadata, and CLI reference. Developers can read Typed HTTP APIs, Define an application, and Route policies for publishing and enforcing an application's API contract.
Search API Docs from the terminal
The native CLI module uses the same live source list as the browser app:
cld api-docs list --json
cld api-docs search "account request" --app accounts --jsonRun cld api-docs help for operation lookup and raw specification output. A
query can only return contracts that the current deployment is publishing.
Deployment requirements
See Deployment requirements for this app’s startup prerequisites, optional integrations, configuration and functional checks.