@sap-ai-sdk/ai-api
The AI Core API surface of SAP's AI SDK, covering deployments, configurations and the rest of the control plane, as opposed to calling a model.
Facts
Where it sits
Who is behind it
In the atlas: maintains 137, wrote 14@SAPmaintainerAnjanContributes to this
In the atlas: contributes to 7@anjan-poonachaSAP Cloud SDK BotContributes to this
In the atlas: contributes to 11@bot-sdk-jsBrigittaK307Contributes to this
In the atlas: contributes to 12@BrigittaK307Charles DuboisContributes to this
In the atlas: contributes to 5@CharlesDuboisSAPChristoph MatthiesContributes to this
In the atlas: contributes to 5@ChristophMatthiesDavid KnaackContributes to this
In the atlas: contributes to 13, wrote 1@davidkna-sapDeeksha SinhaContributes to this
In the atlas: contributes to 12@deekshas8Guilherme DellagustinContributes to this
In the atlas: contributes to 27@dellagustin-sapemincihangeriContributes to this
In the atlas: contributes to 12@emincihangeriTian TengContributes to this
In the atlas: contributes to 5@Herrtian21 contributors
Before choosing this
Conditions
LicenceSAP Developer License Agreement 3.2 CAP§ 3from LLM integrationCovered SAP materials or a covered CAP customer application are used as training data or to develop or refine an AI model or system.
- § 3 Artificial Intelligence Training. The agreement prohibits use of the covered materials and customer applications for training artificial-intelligence models or systems.
Calling a model for inference is not automatically AI training. Section 3 matters when the covered material or application participates in training, model development, refinement or the text-and-data-mining uses it names.
SAP Developer License Agreement 3.2 CAP →What it declares
Every artifact
- Type
- Package
- Origin
- By SAP
As a package
- Where it runs
- does not say
- Distributed through
- npm
Connections
Calling a language model with tenant and credential handling solved
Download
Install
npm add @sap-ai-sdk/ai-apiDerived from the package name. No recipe recorded; the README has the configuration.
README
quoted from SAP/ai-sdk-js under Apache-2.0, read@sap-ai-sdk/ai-api
SAP Cloud SDK for AI is the official Software Development Kit (SDK) for SAP AI Core, SAP Generative AI Hub, and Orchestration Service.
This package provides tools to manage scenarios and workflows in SAP AI Core.
- Streamline data preprocessing and model training pipelines.
- Execute batch inference jobs.
- Deploy inference endpoints for trained models.
- Register custom Docker registries, sync AI content from Git repositories, and register object storage for training data and model artifacts.
We maintain a list of currently available and tested AI Core APIs
Table of Contents
Installation
npm install @sap-ai-sdk/ai-api
Documentation
Visit the SAP Cloud SDK for AI (JavaScript) documentation portal to learn more about its capabilities and detailed usage.
Support, Feedback, Contribution
This project is open to feature requests, bug reports and questions via GitHub issues.
Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.
License
The SAP Cloud SDK for AI is released under the Apache License Version 2.0..
History
Fixes 4
Notes
Patch Changes
- Updated dependencies [0da56e2]
- Updated dependencies [3483acb]
- Updated dependencies [94b36e5]
- Updated dependencies [4b2c014]
- @sap-ai-sdk/core@2.16.0
Fixes 2
Notes
Patch Changes
- Updated dependencies [cca7edd]
- Updated dependencies [cca7edd]
- @sap-ai-sdk/core@2.14.0
Fixes 4
Notes
Patch Changes
- Updated dependencies [11baf52]
- Updated dependencies [cb8ffe7]
- Updated dependencies [a8c9b29]
- Updated dependencies [6542a2a]
- @sap-ai-sdk/core@2.13.0
Fixes 3
Notes
Patch Changes
- Updated dependencies [0f10482]
- Updated dependencies [e944aa1]
- Updated dependencies [2faf4a8]
- @sap-ai-sdk/core@2.12.0
Fixes 2
Notes
Patch Changes
- Updated dependencies [c8c0e41]
- Updated dependencies [75bb9a9]
- @sap-ai-sdk/core@2.11.0
Features 3, Fixes 3
Notes
Minor Changes
- 8616d5e: [Compatibility Note] Extract functionality around execution scheduling from the
ExecutionApitoExecutionScheduleApi. - 8616d5e: [Compatibility Note] Remove the
BckndEventtype. - 8616d5e: [Compatibility Note] Split the
BckndArgoCDApplicationDataintoBckndArgoCDApplicationDataResponseandBckndArgoCDApplicationDataRequest.
Patch Changes
- Updated dependencies [b11b00c]
- Updated dependencies [56e9c3f]
- Updated dependencies [b12626b]
- @sap-ai-sdk/core@2.7.0
- 8616d5e: [Compatibility Note] Extract functionality around execution scheduling from the
Features 1, Fixes 3
Notes
Minor Changes
- 58464e9: [feat] Update
ai-apipackage with the new specification (2509b).
Patch Changes
- Updated dependencies [6100bca]
- Updated dependencies [5225275]
- Updated dependencies [347eac1]
- @sap-ai-sdk/core@2.2.0
- 58464e9: [feat] Update
Features 1, Fixes 2
Notes
Minor Changes
- 14745de: [New Functionality] Add
resolveDeploymentUrl()function to resolve the deployment URL that matches the given criteria.
Patch Changes
- Updated dependencies [500c0dd]
- Updated dependencies [9e1c43a]
- @sap-ai-sdk/core@2.0.0
- 14745de: [New Functionality] Add
Fixes 2
Notes
Patch Changes
-
bfed500: [Fixed Issue] Add missing cause in the error object for failing HTTP requests by using
ErrorWithCause, providing more context for debugging.[Compatibility Note] Due to the introduction of
ErrorWithCause,AxiosErroris now wrapped inside thecauseproperty. For example, useerror.cause.response.datainstead oferror.response.datato access the error response from the server. -
Updated dependencies [bfed500]
- @sap-ai-sdk/core@1.9.0
-
Features 2, Fixes 1
Notes
Minor Changes
- 09b0d2d: [Fixed Issue] Consider destination when resolving deployment ids.
- 1731104: [Compatibility Note] Update AI API spec to 2501b release.
The
kubesubmitV4GenericSecretsGetfunction is renamed tokubesubmitV4GenericSecretsGetAll.
Patch Changes
- @sap-ai-sdk/core@1.8.0
Features 1, Fixes 1
Notes
Minor Changes
- b4a5506: [New Functionality] Add support for providing custom destination for AI Core besides using environment variable and service binding.
Patch Changes
- Updated dependencies [b4a5506]
- @sap-ai-sdk/core@1.5.0
Features 4, Fixes 3
Notes
Minor Changes
- 5bd2e4d: [Compatibility Note] Move
modelsGet()fromModelApitoScenarioApi, and removeModelAPI. - 5bd2e4d: [Fixed Issue] Fix
AiExecutionModificationResponseListtype to correctly represent an array of responses or errors. - 771f986: [Fixed Issue] Fix sending the correct resource group headers when custom resource group is set.
- 5bd2e4d: [Improvement] Add
kubesubmitV4ResourceQuotaGetDeploymentQuota()function inDeploymentApito get details about quota and usage for deployments. Additionally introduce two new typesBckndDeploymentQuotaItemandBckndDeploymentResourceQuotaResponse.
Patch Changes
- 506a1e4: [Fixed Issue] Fix missing and unused dependencies.
- Updated dependencies [506a1e4]
- Updated dependencies [771f986]
- @sap-ai-sdk/core@1.1.0
- 5bd2e4d: [Compatibility Note] Move
Breaking 1, Fixes 1
Notes
Major Changes
- ba9133b: [New Functionality] Provide an HTTP wrapper to consume the AI Core Rest APIs. It is powered by the SAP Cloud SDK OpenAPI generator.
Patch Changes
- @sap-ai-sdk/core@1.0.0
Others providing
Compare all 14 on the LLM integration page →- SAP AI CoreSAP AI CoreSAP's AI service on BTP: the runtime for AI assets, and through the Generative AI Hub inside it the access to foundation models, the orchestration service with its templating, masking, filtering and grounding modules, the Prompt Registry and Document Grounding.sap official, btpAI runtime on BTP with the Generative AI Hub
- cap-java/cds-aicap-java/cds-aiBridges CAP Java to SAP AI Core and adds AI-powered field recommendations to Fiori draft UIs, as two alpha Maven modules with mock fallbacks for local development.sap official, capBridge from CAP Java to SAP AI Core, with Fiori field recommendations
- @cap-js/ai@cap-js/aiOut-of-the-box value-help recommendations powered by SAP RPT-1, SAP AI Core as a standard CAP service, and an experimental local embedding model behind SQLite's vector functions.sap official, capValue-help recommendations and SAP AI Core as a CAP service
- cap-llm-plugincap-llm-pluginGenerative AI in a CAP application with the sensitive fields anonymised through SAP HANA before the prompt leaves, so the model never sees the confidential half.independent, capGenerative AI in CAP with fields anonymised through SAP HANA
- @geertjanklaps/cds-toon-ai-protocol-adapter@geertjanklaps/cds-toon-ai-protocol-adapterA protocol adapter that serves CAP data as TOON — Token-Oriented Object Notation — instead of JSON, so a payload bound for a language model costs fewer tokens to send.independent, capProtocol adapter serving CAP data as TOON instead of JSON
- @jerome-benoit/sap-ai-provider@jerome-benoit/sap-ai-providerA provider for the Vercel AI SDK that speaks to SAP AI Core through its orchestration or foundation models API, so an application written against that SDK runs on SAP's models without being rewritten.independent, capVercel AI SDK provider for SAP AI Core
- ui5-cap-ai-featuresui5-cap-ai-featuresBoth halves of an AI text feature in one package: a CDS plugin serving an AIService over SAP AI Core's Orchestration Service, and the be.wl.ai UI5 control library that calls exactly that service.independent, capCDS plugin and UI5 controls for AI text features via SAP AI Core
- @sap-ai-sdk/core@sap-ai-sdk/coreThe shared internals that the packages of SAP's AI SDK build on, which its own readme says are not meant to be depended on directly.sap official, capShared internals of SAP's AI SDK
- @sap-ai-sdk/foundation-models@sap-ai-sdk/foundation-modelsThe package of SAP's AI SDK that calls foundation models through SAP AI Core and the Generative AI Hub, and the one an application actually reaches for.sap official, capClient for foundation models via SAP AI Core and Generative AI Hub
- @sap-ai-sdk/orchestration@sap-ai-sdk/orchestrationThe Orchestration Service client of SAP's AI SDK, which applies templating, grounding, filtering and masking around a model call rather than in the application.sap official, capOrchestration Service client for templating, grounding and masking
- @sap-ai-sdk/prompt-registry@sap-ai-sdk/prompt-registryA package for keeping prompts in SAP's prompt registry rather than in the codebase, so changing a prompt is not a deployment.sap official, capClient for prompts kept in SAP's prompt registry
- @saptarishi/cds-plugin-llm@saptarishi/cds-plugin-llmA CAP service kind that puts eleven model providers behind one chat, stream, embed and batch interface, so which backend a service calls is a profile in package.json rather than a change to the handler.independent, capCAP service kind putting eleven model providers behind one API
- @shahid.la/cds-db-nlquery-mcp@shahid.la/cds-db-nlquery-mcpMCP server that answers plain-English questions against the entities in db/schema.cds — it discovers the schema, generates CQN-backed SQL with real joins, and returns rows.independent, capMCP server answering plain-English questions against a CDS schema
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
Contributors
History in the atlas
- Typed cds-plugin by placement, which defaults every candidate to that. It is not one.
- The AI Core API surface of SAP's AI SDK — deployments, configurations and the rest of the control plane, as opposed to calling a model.
- First seen.
For your agent
- Ref
artifact:sap-ai-sdk-ai-api- JSON
- /artifacts/sap-ai-sdk-ai-api.json
- MCP
- Connecting an agent