isStepCount

Creates a stop condition that stops when the number of completed steps equals a specified count.

This function is used with stopWhen in generateText and streamText to control when a tool-calling loop should stop based on the number of steps executed.

import { generateText, isStepCount } from 'ai';

const result = await generateText({
  model: 'anthropic/claude-sonnet-5.5',
  tools: {
    // your tools
  },
  // Stop after 5 steps
  stopWhen: isStepCount(5),
});

Import

import { isStepCount } from "ai"

API Signature

Parameters

• stepCount (number): The number of completed steps that should trigger the stop condition.

Returns

A StopCondition function that returns true when the number of completed steps equals the specified number. The function can be used with the stopWhen parameter in generateText and streamText.

Examples

Basic Usage

Stop after 3 steps:

import { generateText, isStepCount } from 'ai';

const result = await generateText({
  model: yourModel,
  tools: yourTools,
  stopWhen: isStepCount(3),
});

Combining with Other Conditions

You can combine multiple stop conditions in an array:

import { generateText, isStepCount, hasToolCall } from 'ai';

const result = await generateText({
  model: yourModel,
  tools: yourTools,
  // Stop after 10 steps OR when finalAnswer tool is called
  stopWhen: [isStepCount(10), hasToolCall('finalAnswer')],
});

See also

• hasToolCall()
• generateText()
• streamText()