https://step.dev/knowledgebase/31/categories/api/ Recent content in API on Step Documentation Hugo -- gohugo.io en Thu, 08 Oct 2026 00:00:00 +0100 https://step.dev/knowledgebase/31/ai/mcp-server/ Mon, 29 Jun 2026 00:00:00 +0000 https://step.dev/knowledgebase/31/ai/mcp-server/ The Step MCP Server lets AI assistants and coding agents drive the Step automation platform through the Model Context Protocol (MCP). https://step.dev/knowledgebase/31/releasestrategy/keyword-api-release/ Tue, 14 Oct 2025 00:00:00 +0000 https://step.dev/knowledgebase/31/releasestrategy/keyword-api-release/ Overview The Step Keyword API is maintained and versioned independently of the Step platform. This independent versioning allows for more flexible updates and backward compatibility across different Step versions. Versioning Scheme The Keyword API follows semantic versioning with the format: MAJOR.MINOR.PATCH Major version: Significant API changes or breaking changes Minor version: New features and enhancements Patch version: Bug fixes and minor improvements Independent Versioning The Keyword API uses a single version across all supported programming languages (Java, . https://step.dev/knowledgebase/31/devdocs/keyword-development/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/devdocs/keyword-development/ Keywords are the fundamental building blocks of Plans. They encapsulate the automation logic and can represent fully automated flows or finer-grained actions, such as single user interactions or service calls. This page is the entry point for developing your own custom keywords: it walks you through your first keyword from project setup to execution in Step, and highlights the concepts and best practices to consider along the way. Refer to the keyword API page for the technical documentation. https://step.dev/knowledgebase/31/devdocs/keyword-javascript/ Thu, 08 Oct 2026 00:00:00 +0100 https://step.dev/knowledgebase/31/devdocs/keyword-javascript/ JavaScript keywords use the Keyword API: each keyword is an exported async function placed in the keywords/ directory of an npm project, executed on the Node.js agent. TypeScript keywords are executed exactly the same way once compiled, see TypeScript Keywords for the project setup. If you are new to keyword development, read the Keyword Development page first. Execution on the Node.js agent Before a keyword is invoked, the Node.js agent prepares the npm project the keyword belongs to. https://step.dev/knowledgebase/31/devdocs/keyword-csharp/ Thu, 02 Jul 2026 14:08:01 +0100 https://step.dev/knowledgebase/31/devdocs/keyword-csharp/ C# keywords use the Keyword API and are executed on the .NET agent, which is currently available with Step Enterprise and Step SaaS. This page describes the C#-specific project setup, local testing, and deployment. If you are new to keyword development, read the Keyword Development page first. Project setup Create a new Console Application project in Visual Studio. The .NET agent requires .NET 8, so your keyword project must target the net8. https://step.dev/knowledgebase/31/devdocs/keyword-typescript/ Thu, 02 Jul 2026 14:08:01 +0100 https://step.dev/knowledgebase/31/devdocs/keyword-typescript/ TypeScript keywords use exactly the same Keyword API as JavaScript: each keyword is an exported async function receiving the same arguments, executed on the Node.js agent. The only difference lies in the project setup, described on this page: the Node.js agent executes CommonJS JavaScript, so the TypeScript sources are compiled into the project’s keywords/ directory as part of your build. If you are new to keyword development, read the Keyword Development page first. https://step.dev/knowledgebase/31/ai/mcp-server/tools/ Mon, 29 Jun 2026 00:00:00 +0000 https://step.dev/knowledgebase/31/ai/mcp-server/tools/ Reference for all tools exposed by the Step MCP Server. For setup and installation, see Getting Started. All tools accept two optional shared parameters: profile (which Step instance and credentials to use) and project (which project to act on). The discovery tools below are the exception: they don’t require a project. When omitted, parameters fall back to the configured defaults (see Profile and project resolution). Every tool’s response includes a resolvedContext block reporting the profile, baseUrl, and project actually used. https://step.dev/knowledgebase/31/whatsnew/release-notes-step-keyword-api/ Tue, 22 Apr 2025 06:27:34 +0100 https://step.dev/knowledgebase/31/whatsnew/release-notes-step-keyword-api/ The Keyword API is maintained and versioned independently of the Step platform. This page outlines the release history of the Keyword API. Each entry specifies the corresponding Step version in which the respective Keyword API version was introduced. Unless stated otherwise, the API is designed to be backward compatible, allowing older API versions to function seamlessly with newer Step versions. Java Keyword API Major release 1.6.0 since Step 30.0 The Java Keyword API (v1. https://step.dev/knowledgebase/31/devdocs/keywordapi/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/devdocs/keywordapi/ For a better understanding of the key concepts and best practices of keywords development, make sure to read first the Keyword development page. The versatility of Step and its keyword API allows developers to implement their own custom Step’s Keywords whether they use 3rd party automation framework or their own libraries. The Keyword API defines a clear interface to: define and configure Keywords access Keyword inputs, session objects, and report data (keyword outputs, performance measurements, attachments) implement hooks related to keyword executions (interceptors, error management) The Keyword API is natively available for Java, C#, and JavaScript/TypeScript — executed respectively on the Java, . https://step.dev/knowledgebase/31/devops/automation-package-java/ Wed, 22 May 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/devops/automation-package-java/ Automation package entities can be defined in a declarative way with the automation package descriptor (YAML) as well as directly in the code for Java Automation Packages. This page focuses on the declaration of Automation Package entities in the code which is supported for Keywords and Plans. Declaration of Keywords In addition to the declaration of Keywords in the automation package descriptor (YAML), Automation packages also fully support the Keyword API to declare Keywords directly in Java. https://step.dev/knowledgebase/31/devdocs/stepclient/ Wed, 22 May 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/devdocs/stepclient/ The Java APIs and libraries (step Client) discussed in this section are currently only available in the step Enterprise Edition Introduction The Step client exposes means to connect to the controller programmatically, access and use Step services in a headless way. It also allows to execute locally Step controller functionalities like building and running a plan. Resources: The Javadocs of the Step client is available here: step.client.StepClient and examples can be found on github. https://step.dev/knowledgebase/31/devdocs/rest-api/ Sat, 12 Jun 2021 14:08:01 +0100 https://step.dev/knowledgebase/31/devdocs/rest-api/ Introduction While you can use the step client to interact programmatically with Step, it is also possible to use the Step’s REST API directly. Note that the service signatures are more likely to change compared to the step client Documentation You will find the documentation of the REST API under the help menu of Step The documentation page provide the detailed specification of every services and means to directly invoke and test the service. https://step.dev/knowledgebase/31/devdocs/eventbrokerapi/ Wed, 22 May 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/devdocs/eventbrokerapi/ The Java APIs and libraries discussed in this section are currently only available in Step Enterprise Edition EventBroker The EventBroker Service and API allow asynchronous communication to happen in Step as well as synchronization between keywords, between plans and between keywords and plans. It is particularly useful in scenarios where a thread (or a “user”) needs to wait for specific events before performing the next task. These events can be created internally (from within a keyword or plan) using various types of clients (Java, REST, prepopulated Keywords and Artefacts). https://step.dev/knowledgebase/31/userdocs/plans/java_plans/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/userdocs/plans/java_plans/ Programmatic plans are the object-oriented representation of a plan. It can be particularly useful for developpers to design, execute and maintain Plans directly in Java. See programmatic examples as part of the stepClient API here. https://step.dev/knowledgebase/31/devdocs/ Wed, 13 Feb 2019 00:00:00 +0000 https://step.dev/knowledgebase/31/devdocs/