Skip to main content
Version: Latest (4.6.0)

ServiceNow SDK API Reference

The ServiceNow SDK lets you develop applications in source code using ServiceNow Fluent — a domain-specific language for creating application metadata as code.

What is ServiceNow Fluent?​

ServiceNow Fluent provides a set of typed API functions that map directly to platform records. Instead of configuring records through the UI, you define them in TypeScript and deploy them with the SDK.

Getting Started​

Install the SDK:

npm install @servicenow/sdk -d

Import APIs from @servicenow/sdk/core:

import { Acl, BusinessRule, Role } from "@servicenow/sdk/core";

Available APIs​

Browse the API Reference section in the sidebar for complete documentation on each available function.

AI Agent Configuration​

If you are using an AI coding agent (such as Claude, Cursor, GitHub Copilot, or similar), you can configure it with the Fluent API documentation to improve code generation accuracy.

Starting with SDK version 4.6.0, we publish dedicated AI agent skills with richer context and tooling integration as part of the @servicenow/sdk npm package. See the AI Skills documentation for setup instructions and usage.

All Versions​

A lightweight API reference is available for agent context across all SDK versions:

FileURLDescription
llms.txthttps://servicenow.github.io/sdk/llms.txtDocumentation index with links to guides and API pages

Available Versions​

A machine-readable index of all published versions is available at:

https://servicenow.github.io/sdk/versions.json

This is useful for agents or tooling that need to target a specific SDK version. Each entry in the versions array includes:

  • version — the SDK version string
  • url — the docs base URL for that version
  • llms — the documentation index for that version

Example Agent System Prompt​

Before generating any ServiceNow Fluent SDK code:
1. Read the local project's package.json and find the version of @servicenow/sdk in dependencies.
2. Fetch https://servicenow.github.io/sdk/versions.json and find the closest semver
   match to the installed version.
3. Fetch the llms URL from that version entry to get the documentation index.
4. Use the index to identify relevant guides or API pages, then fetch those
   pages for detailed reference before writing code.

Example: if package.json has "@servicenow/sdk": "4.5.0", fetch versions.json,
match "4.5.0", fetch its llms URL to see available docs, then fetch specific
pages (e.g., business-rule-guide, acl-api) as needed for the task.