Reference

NIM REST API

View as Markdown

Kumo Relational is served through the Universal Structured Data Foundation Models API. Use the Python SDK for standard workflows; use REST directly for service integration or OpenAPI client generation.

Choose an endpoint

  • Self-hosted NIM: Use the base URL of your deployment. The NIM does not require authentication as part of its API contract, but a gateway in front of it might require an API key or another credential.
  • NVIDIA API Catalog: Use the server URL and bearer-token authentication shown in the published API reference.

Run a one-shot prediction

The POST /v1/predictions endpoint accepts a complete Universal TFM request that contains the model, task, relational schema, labeled context, rows to predict, requested outputs, and optional inference settings and metadata. It returns the prediction synchronously and does not create a durable prediction resource.

Copy the complete multitable_binary_classification request example from the published Kumo Relational NIM API reference and save it as request.json.

curl --fail-with-body \
  --request POST \
  --url "${KUMO_RELATIONAL_API_ENDPOINT}/v1/predictions" \
  --header "Content-Type: application/json" \
  --data @request.json

Before running the command, set KUMO_RELATIONAL_API_ENDPOINT to the base URL of your deployment, such as http://localhost:8000. If applicable, add the authentication header required by your gateway. For the NVIDIA API Catalog endpoint, use the Authorization: Bearer $NVIDIA_API_KEY header, as shown in the generated API examples.

Response and errors

A successful response contains a response-level correlation ID, the model name, prediction items, and metadata. Each prediction item includes a zero-based row_index. It can include the input instance_id in the id field and requested fields such as prediction and probabilities.

Errors use application/problem+json with fields such as type, status, title, detail, and code. See the generated API reference for the complete request schema, response schema, error model, and runnable examples.