API Catalog

01When to use API Catalog

Use the API Catalog to:

• Understand which endpoints were called during a run
• Debug unexpected server responses
• Correlate UI failures with API failures
• Inspect request, response, credential, and test details for a captured call
• Import API definitions so your team can review documented endpoints alongside captured activity
• Jump from captured API calls to building and debugging API Sequences when you need deeper investigation

When you identify a request or response pattern that needs more focused debugging, continue in the API Sequences reference. Use API Catalog to inspect captured calls, then use API Sequences to build repeatable checks, review detailed run results, and work through AI Doctor repair suggestions.

02Import API definitions

Import API definitions when you want the API Catalog to include endpoints from an existing schema, not only calls captured during runs. This helps you review documented coverage, inspect endpoints before they are exercised in a run, and keep your catalog aligned with an external source.

You can import definitions by uploading a file or by connecting a URL.

Import from URL

Use a URL import when your API schema is published at a stable endpoint and you want to refresh it later without re-uploading a file.

1. Open API Catalog.
2. Click Import API.
3. Choose URL.
4. Enter the schema URL.
5. Review the detected source details.
6. Click Import.

After the import finishes, the source appears in your catalog and remains available for later refresh or sync actions.

Importing Postman collections

Use a Postman collection import when you want to bring an existing collection into API Catalog and review its endpoints before or alongside captured traffic.

1. Open API Catalog.
2. Click Import API.
3. Upload your Postman collection file.
4. Review the preview details.
5. Adjust any available configuration options.
6. Click Import.

The import flow follows three stages:

Stage	What you do	What to expect
Preview	Upload the Postman collection and review the detected contents	API Catalog checks the file and shows a preview when it can read the collection
Configure	Review import settings before submitting	Confirm the import details before you continue
Import	Start the import	API Catalog creates the source and adds it to your catalog when the import succeeds

If the file is invalid or the collection cannot be previewed, API Catalog shows a clear error instead of continuing to configuration or import. If the collection passes preview but fails validation during import, API Catalog shows the failure in a single global notification so you can fix the file and try again.

Supported schema sources

API Catalog supports common URL-based schema sources, including metadata-style endpoints such as Bubble.

Source type	What to use it for
OpenAPI or similar schema URL	Import a published API definition from a stable documentation or schema endpoint
Bubble metadata endpoint	Import endpoints exposed through Bubble metadata-style API definitions
Uploaded schema file	Add a definition when you do not have a stable URL to sync from
Uploaded Postman collection	Add endpoints from an existing Postman collection file

If your schema is available at a URL, prefer the URL import flow so you can refresh the source later.

Refreshing and managing sources

After you import a source, use source actions to keep the catalog current.

Action	What it does
Refresh or Sync	Pull the latest version from the connected source URL
View source details	Confirm where the definition came from and review its current state
Re-import	Replace an older file-based import when you need to update a source manually

Use the source list to confirm whether a connected definition is healthy before you refresh it. Health and status indicators help you spot sources that imported successfully, need attention, or recently failed to sync.

Open a source when you need more context about recent sync activity. Review the latest sync status to confirm whether Canary pulled the newest definition, then refresh or re-import the source if the catalog is out of date.

03Inspect endpoint and request details

Use the API Catalog to move from a high-level list of endpoints into the details for a specific request or endpoint. The updated detail experience gives you a denser view of endpoint information and more room to investigate individual calls.

Drawer vs full-page detail view

Open endpoint and request details in the drawer when you want to inspect context without leaving the current list. Open the full-page detail view when you need more space to review large payloads, responses, credentials, tests, or multiple sections of the same request.

Use the full-page view for longer debugging sessions or when you want a stable URL you can revisit directly.

Requests, responses, credentials, and tests

In endpoint and request details, review the captured information that helps you understand what happened during a run.

Detail area	What to inspect
Requests	Method, path, headers, query parameters, request body schema, sample payloads, and timing for the captured call
Responses	Status, body, and returned data so you can spot failures or unexpected output
Credentials	Which credential context was used for the request
Tests	Related checks or validation context tied to the request

Use endpoint details to compare repeated calls, identify failing responses quickly, and move between summary information and deeper inspection without losing context.

Inspect endpoints

Open an endpoint detail view when you want to understand the current shape and recent behavior of a specific route.

Review the endpoint header for health and status indicators that summarize whether recent traffic looks healthy. Use recent status history to spot endpoints that are intermittently failing, returning errors, or recovering after a temporary issue.

In the request body section, switch between schema and sample content when you need either a structured definition or a concrete example. Edit the request body schema or sample directly in the endpoint view, then generate schema from sample content when you need to turn example payloads into a reusable structure.

When you want to reproduce a request outside Canary, copy the generated curl snippet from the endpoint detail view. Use it to retest an endpoint quickly in your terminal or share a concrete request example with teammates.

Endpoint details

Use the endpoint detail view to inspect both endpoint-level context and individual captured calls.

Section	What you can do
Health and status	Review health indicators and recent status history for the endpoint
Request body	Edit the request body schema, review sample content, or generate schema from sample payloads
Request example	Copy the generated curl snippet to replay the request outside Canary
Request inspection	Review method, path, headers, query parameters, payloads, and timing
Response inspection	Review status codes, response body, and returned data in more detail
Related context	Check credentials and test details tied to the captured call

Use the fuller request and response sections when you need to investigate exactly what was sent and returned for a request. This view is especially helpful when the endpoint definition and captured traffic do not match, or when you need to compare multiple examples from recent activity.

04Filtering and search

Use filters and search to narrow the catalog to the requests or endpoints you want to review.

Apply filters when you want to focus on a subset of captured traffic, such as a single method, endpoint, status, or run context. Use search when you already know part of the path or request you need to find.

If your current search or filters do not match any captured API calls, API Catalog shows a clear empty state instead of a blank list. Use that empty state as a signal to broaden your search, remove one or more filters, or confirm that the run captured the traffic you expected.

05Browsing captured requests

Browse captured requests to move from a broad view of traffic into the specific call you need to inspect.

Review the request list to compare endpoints, spot failures, and identify repeated calls during a run. Use the available sortable columns to reorganize the list, but do not expect the Health column to support sorting. When the list is empty after you apply filters or enter a search, look for the no-results empty state to confirm that no captured API calls match your current view.

Clear or adjust filters, update your search term, or switch to a different run if you expected to see results.

06Related

Troubleshooting

Use these checks when a Postman collection import does not complete as expected.

Issue	What you see	What to do
Invalid file	The preview does not load and an error appears immediately after upload	Confirm that the file is a valid Postman collection, then upload the corrected file again
Validation failure during import	The preview appears, but the import fails after you click Import	Review the error shown in the global notification, update the collection, and retry the import
Duplicate-looking error messages	You expect more than one error message, but only see one clear failure notification	Use the displayed error as the source of truth and resolve that issue before retrying

If the import continues to fail after you correct the file, try exporting the collection again from Postman and re-importing the new file.

• API Sequences reference — Build and debug API Sequences with detailed run results and AI Doctor repair tools.