Skip to content

API Passthrough

POST/v1/api/{vendor}/{upstream_path}

Resolve an enabled catalog capability named vendor/upstream_path and execute a JSON object through the unified SandBase pipeline. GET is also supported for capabilities that use it.

Path parameters

stringvendorrequired

First capability-name segment.

stringupstream_pathrequired

Remaining path

Request body

Optional<string>model

Omit to use the URL-derived vendor/path identity. If supplied

Optional<object>capability fields

Fields defined by the selected capability's live schema.

The URL resolves an enabled model named vendor/upstream_path. Use the exact vendor-qualified name returned by the Models API. Nested capability names remain literal path segments rather than percent-encoded slashes.

POST accepts only a JSON object. An empty POST body is allowed and behaves like an object containing the URL-derived model. GET uses an empty body. Response fields and synchronous versus asynchronous behavior depend on the selected capability; poll asynchronous results through GET /v1/run/{id}.