Describe a connected REST API
Work out what a caller's own REST API connection offers before calling it. Reads the API's OpenAPI or Swagger description when one is published, looks for it at the conventional addresses when it is not named, and otherwise inspects the API itself — following the links a self-describing root returns. Reports which endpoints can be read, what was tried, and the owner's own notes about the API.
Access
This tool reads a data source you connect. Cortexa hosts no dataset behind it and nothing here is publicly queryable — there is no result to show a visitor, only the shape of the call. Add a connection in Settings → Connections, and the agent can use it in your own sessions.
- Works with
- Scope
- Endpoint discovery for one REST API connection, confined to that connection's base URL.
Access is read-only and re-authorized on every call against the connection's owner, your active workspace, and any explicit grants. Credentials stay encrypted at rest and are never returned by a tool.
Schema
JSON Schema the agent (or your API call) must match.
View JSON schemaExpandCollapse
Examples (1)
Illustrative only — the ids below are placeholders. Real ids come from list_connections at run time and are scoped to the caller.
Learn what an internal reporting API exposes
Identifiers
- Catalog ID
- api_describe
- Agent tool
- api_describe
- Added
- 2026-08-12 23:08Z
- Tags
- connection, private, read-only, api, discovery