Skip to main content
Version: Latest (4.5.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.

API Documentation for Agents​

Two documentation formats are available for agent context:

FileURLBest for
llms.txthttps://servicenow.github.io/sdk/llms.txtLightweight index; use when fitting within tight context budgets
llms-full.txthttps://servicenow.github.io/sdk/llms-full.txtComplete API reference inlined; use for highest code generation accuracy

For most agent workflows, prefer llms-full.txt — it includes full type signatures, property descriptions, and usage examples that reduce hallucinations when generating Fluent API code.

Available Versions​

A machine-readable index of all published versions (including per-version llms.txt and llms-full.txt URLs) 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 condensed API reference for that version
  • llmsFull — the complete API reference 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. Load the llmsFull URL from that version entry as your API reference.

Example: if package.json has "@servicenow/sdk": "4.5.0", fetch versions.json,
match "4.5.0", and load its llmsFull value as the API reference before coding.