Kumoai Authentication

generated: '2026-07-19'
method: searched
source: https://docs.nvidia.com/sdgm/rest-api , https://docs.nvidia.com/sdgm/fine-tuning/api-key-management
docs: https://docs.nvidia.com/sdgm/rest-api
summary:
  types:
  - apiKey
  - snowflakeCredentials
  - http
  api_key_in:
  - header
  oauth2_flows: []
  note: The Kumo REST API and Python SDK authenticate with a customer-scoped API key
    sent as an X-API-Key header. There is no OAuth2 scope surface, so no scopes/ artifact
    is produced.
schemes:
- name: KumoApiKey
  type: apiKey
  in: header
  parameter: X-API-Key
  format: <customer_id>:<secret_value>
  example_shape: demo:qBX-J36iE8mL0o779j-U
  scope: global — one key per Kumo tenant, generated by a platform administrator
  provisioning: Admin tab in the Kumo UI → "Reset and generate new API Key"
  rotation: Generating a new key automatically invalidates all previous keys; docs
    recommend periodic rotation.
  applies_to:
  - Kumo REST API (retrain, batch predict, job status, cancel job)
  - Kumo Python SDK via kumo.init(url=..., api_key=...)
  docs: https://docs.nvidia.com/sdgm/rest-api
- name: SnowflakeCredentials
  type: platform
  description: In the Snowpark Container Services (SPCS) deployment, API keys are unnecessary
    — authentication is handled by the Snowflake environment and Snowflake user/password/account
    credentials are forwarded to the SPCS application via kumo.init(snowflake_credentials=...).
  applies_to:
  - Kumo Snowflake Native Application
  docs: https://docs.nvidia.com/sdgm/fine-tuning/api-key-management
- name: KumoRfmApiKey
  type: apiKey
  in: environment
  parameter: KUMO_API_KEY
  description: KumoRFM API key used by the kumo-rfm-mcp MCP server and the RFM SDK.
    Issued at https://kumorfm.ai. If not injected as an environment variable the server
    falls back to a browser-based OAuth flow, or the client may call the `authenticate`
    tool with an `api_key` argument.
  docs: https://github.com/kumo-ai/kumo-rfm-mcp
- name: McpBearerToken
  type: http
  scheme: bearer
  parameter: Authorization
  description: Optional shared bearer token (MCP_BEARER_TOKEN) protecting the kumo-rfm-mcp
    streamable-http endpoint.
  docs: https://github.com/kumo-ai/kumo-rfm-mcp
base_urls:
- pattern: https://<customer_id>.kumoai.cloud/api
  deployment: SaaS and Databricks Edition
- pattern: https://<kumo_spcs_deployment_url>/api
  deployment: Snowpark Container Services
sso:
  supported: true
  docs: https://docs.nvidia.com/sdgm/configuring-sso