Skip to content
v0.39.2

API schema and requests

Full CLI reference for v0.39.2, published . Cloud features may behave differently today.

Use api schema to look up an operation before making a raw cloud API request. The server must expose schema discovery.

Find an operation

Terminal window
npx vizzly api schema --json
npx vizzly api schema sdk.listBuilds --json

The operation details include the HTTP method, path, required headers, query parameters, and request body. Use the values the server returns.

Make a request

Replace api-version-from-schema with the header value from discovery.

Terminal window
npx vizzly api /api/sdk/builds \
--header 'Vizzly-API-Version: api-version-from-schema' --json

Schema discovery can run without signing in. Requests that read or write project data need credentials for that operation. Use --query for query parameters and --data for a JSON request body. Pass --data @request.json to read the body from a file or --data @- to read it from stdin.

Save the schema or response

Terminal window
npx vizzly api schema --full --output ./vizzly-openapi.json

Use api ... --output ./response.png to save an image response to disk. Confirm the method before running a request. Review decisions and comments change cloud state.

For local comparison results, use TDD mode and saved screenshots.