PackagePackagetypeA library you install and call yourself.See every one →What this type is →by SAPby SAPoriginPublished by SAP itself. A visible facet, never an input to a reading — a dormant official plugin reads exactly like a dormant independent one.See every one →

@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

Latestv2.17.0ReleasedLast pushLicenceApache-2.0

Where it sits

Lives in
Provides
LLM integrationCAPLLM integrationcapabilityCalling a language model from application code with the tenant, destination and credential handling already solved instead using an SDK call with a hand-rolled key.

Who is behind it

SAPSAPOrganisationMaintains this
In the atlas: maintains 137, wrote 14
@SAP
maintainerAnjanPersonContributes to this
In the atlas: contributes to 7
@anjan-poonacha
SAP Cloud SDK BotPersonContributes to this
In the atlas: contributes to 11
@bot-sdk-js
BrigittaK307PersonContributes to this
In the atlas: contributes to 12
@BrigittaK307
Charles DuboisPersonContributes to this
In the atlas: contributes to 5
@CharlesDuboisSAP
Christoph MatthiesPersonContributes to this
In the atlas: contributes to 5
@ChristophMatthies
David KnaackPersonContributes to this
In the atlas: contributes to 13, wrote 1
@davidkna-sap
Deeksha SinhaPersonContributes to this
In the atlas: contributes to 12
@deekshas8
Guilherme DellagustinPersonContributes to this
In the atlas: contributes to 27
@dellagustin-sap
emincihangeriPersonContributes to this
In the atlas: contributes to 12
@emincihangeri
Tian TengPersonContributes to this
In the atlas: contributes to 5
@Herrtian
21 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

Connections1

Install

npm add @sap-ai-sdk/ai-api

Derived 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-js/packages/ai-api/README.mdOn GitHub

@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..

Apache-2.0, read

History

Latest

v2.17.0

  1. v2.16.0

    Fixes 4

    Notes
    Patch Changes
    • Updated dependencies [0da56e2]
    • Updated dependencies [3483acb]
    • Updated dependencies [94b36e5]
    • Updated dependencies [4b2c014]
      • @sap-ai-sdk/core@2.16.0
  2. v2.15.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [a5407c8]
      • @sap-ai-sdk/core@2.15.0
  3. v2.14.0

    Fixes 2

    Notes
    Patch Changes
    • Updated dependencies [cca7edd]
    • Updated dependencies [cca7edd]
      • @sap-ai-sdk/core@2.14.0
  4. v2.13.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
  5. v2.12.0

    Fixes 3

    Notes
    Patch Changes
    • Updated dependencies [0f10482]
    • Updated dependencies [e944aa1]
    • Updated dependencies [2faf4a8]
      • @sap-ai-sdk/core@2.12.0
  6. v2.11.0

    Fixes 2

    Notes
    Patch Changes
    • Updated dependencies [c8c0e41]
    • Updated dependencies [75bb9a9]
      • @sap-ai-sdk/core@2.11.0
  7. v2.10.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [8cb466a]
      • @sap-ai-sdk/core@2.10.0
  8. v2.9.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [cd3d8ed]
      • @sap-ai-sdk/core@2.9.0
  9. v2.8.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@2.8.0
  10. v2.7.0

    Features 3, Fixes 3

    Notes
    Minor Changes
    • 8616d5e: [Compatibility Note] Extract functionality around execution scheduling from the ExecutionApi to ExecutionScheduleApi.
    • 8616d5e: [Compatibility Note] Remove the BckndEvent type.
    • 8616d5e: [Compatibility Note] Split the BckndArgoCDApplicationData into BckndArgoCDApplicationDataResponse and BckndArgoCDApplicationDataRequest.
    Patch Changes
    • Updated dependencies [b11b00c]
    • Updated dependencies [56e9c3f]
    • Updated dependencies [b12626b]
      • @sap-ai-sdk/core@2.7.0
  11. v2.6.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@2.6.0
  12. v2.5.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@2.5.0
  13. v2.4.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [2e1d2c2]
      • @sap-ai-sdk/core@2.4.0
  14. v2.3.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@2.3.0
  15. v2.2.0

    Features 1, Fixes 3

    Notes
    Minor Changes
    • 58464e9: [feat] Update ai-api package with the new specification (2509b).
    Patch Changes
    • Updated dependencies [6100bca]
    • Updated dependencies [5225275]
    • Updated dependencies [347eac1]
      • @sap-ai-sdk/core@2.2.0
  16. v2.1.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [0cf7d80]
      • @sap-ai-sdk/core@2.1.0
  17. v2.0.0

    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
  18. v1.17.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@1.17.0
  19. v1.16.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@1.16.0
  20. v1.15.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [5307dd0]
      • @sap-ai-sdk/core@1.15.0
  21. v1.14.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@1.14.0
  22. v1.13.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [a6ba3af]
      • @sap-ai-sdk/core@1.13.0
  23. v1.12.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@1.12.0
  24. v1.11.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [627a152]
      • @sap-ai-sdk/core@1.11.0
  25. v1.10.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [6f28f47]
      • @sap-ai-sdk/core@1.10.0
  26. v1.9.0

    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, AxiosError is now wrapped inside the cause property. For example, use error.cause.response.data instead of error.response.data to access the error response from the server.

    • Updated dependencies [bfed500]

      • @sap-ai-sdk/core@1.9.0
  27. v1.8.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 kubesubmitV4GenericSecretsGet function is renamed to kubesubmitV4GenericSecretsGetAll.
    Patch Changes
    • @sap-ai-sdk/core@1.8.0
  28. v1.7.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@1.7.0
  29. v1.6.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@1.6.0
  30. v1.5.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
  31. v1.4.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@1.4.0
  32. v1.3.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@1.3.0
  33. v1.2.0

    Fixes 1

    Notes
    Patch Changes
    • @sap-ai-sdk/core@1.2.0
  34. v1.1.0

    Features 4, Fixes 3

    Notes
    Minor Changes
    • 5bd2e4d: [Compatibility Note] Move modelsGet() from ModelApi to ScenarioApi, and remove ModelAPI.
    • 5bd2e4d: [Fixed Issue] Fix AiExecutionModificationResponseList type 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 in DeploymentApi to get details about quota and usage for deployments. Additionally introduce two new types BckndDeploymentQuotaItem and BckndDeploymentResourceQuotaResponse.
    Patch Changes
    • 506a1e4: [Fixed Issue] Fix missing and unused dependencies.
    • Updated dependencies [506a1e4]
    • Updated dependencies [771f986]
      • @sap-ai-sdk/core@1.1.0
  35. v1.0.0

    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
  36. v0.1.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [4d5edc7]
      • @sap-ai-sdk/core@0.1.0
26,656downloads per week, npm
Weekly downloads for @sap-ai-sdk/ai-api26 complete calendar weeks from 2026-04-27 to 2026-10-25; the latest total is 26656.27 Apr – 3 May: 27,5254 May – 10 May: 29,70711 May – 17 May: 35,35718 May – 24 May: 31,74725 May – 31 May: 36,1531 Jun – 7 Jun: 50,5548 Jun – 14 Jun: 102,71415 Jun – 21 Jun: 69,77322 Jun – 28 Jun: 77,49029 Jun – 5 Jul: 74,0186 Jul – 12 Jul: 69,52913 Jul – 19 Jul: 210,96720 Jul – 26 Jul: 123,52327 Jul – 2 Aug: 172,9683 Aug – 9 Aug: 145,94010 Aug – 16 Aug: 135,89217 Aug – 23 Aug: 173,14324 Aug – 30 Aug: 166,54031 Aug – 6 Sept: 122,7557 Sept – 13 Sept: 116,02714 Sept – 20 Sept: 122,02421 Sept – 27 Sept: 158,70728 Sept – 4 Oct: 205,7405 Oct – 11 Oct: 105,56712 Oct – 18 Oct: 73,29119 Oct – 25 Oct: 26,656
LLM integration
  1. SAP AI CoreAI runtime on BTP with the Generative AI Hub
  2. cap-java/cds-aiBridge from CAP Java to SAP AI Core, with Fiori field recommendations
  3. @cap-js/aiValue-help recommendations and SAP AI Core as a CAP service
  4. cap-llm-pluginGenerative AI in CAP with fields anonymised through SAP HANA
  5. @geertjanklaps/cds-toon-ai-protocol-adapterProtocol adapter serving CAP data as TOON instead of JSON
  6. @jerome-benoit/sap-ai-providerVercel AI SDK provider for SAP AI Core
  7. ui5-cap-ai-featuresCDS plugin and UI5 controls for AI text features via SAP AI Core
  8. @sap-ai-sdk/coreShared internals of SAP's AI SDK
  9. @sap-ai-sdk/foundation-modelsClient for foundation models via SAP AI Core and Generative AI Hub
  10. @sap-ai-sdk/orchestrationOrchestration Service client for templating, grounding and masking
  11. @sap-ai-sdk/prompt-registryClient for prompts kept in SAP's prompt registry
  12. @saptarishi/cds-plugin-llmCAP service kind putting eleven model providers behind one API
  13. @shahid.la/cds-db-nlquery-mcpMCP server answering plain-English questions against a CDS schema

Details

Sources5
npm registrydiscovered herechecked
The discovery passdiscovered herechecked
npm registry, @sap-ai-sdk/ai-apiversion, releases, installschecked
github.com/https://github.com/SAP/ai-sdk-jstree, pushes, contributors, CIchecked
packages/ai-api/README.mdquoted, and what the entry declareschecked

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
latestv2.17.0
first release
releases and cadence787, ~0d median
discovered vianpm registry, The discovery pass
first seen in the atlas
ecosystem and domaincap, ai-and-agents
Contributors21
History in the atlas3
  1. Typed cds-plugin by placement, which defaults every candidate to that. It is not one.
  2. 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.
  3. First seen.
For your agent
Ref
artifact:sap-ai-sdk-ai-api
JSON
/artifacts/sap-ai-sdk-ai-api.json
MCP
Connecting an agent