docs: add OpenAI provider options documentation to scheduleSchema#27988
Closed
agents-git-bot[bot] wants to merge 1 commit into
Closed
docs: add OpenAI provider options documentation to scheduleSchema#27988agents-git-bot[bot] wants to merge 1 commit into
agents-git-bot[bot] wants to merge 1 commit into
Conversation
Adds documentation for the scheduleSchema API which allows parsing natural language scheduling requests using the AI SDK. This includes: - Overview of scheduleSchema and getSchedulePrompt helpers - Installation instructions for required AI SDK packages - Complete usage example with OpenAI provider - Important callout about required providerOptions for OpenAI compatibility Synced from cloudflare/agents PR #815 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
agents-git-bot
Bot
requested review from
elithrar,
irvinebroque,
rita3ko,
thomasgauvin,
threepointone and
whoiskatrin
as code owners
January 30, 2026 11:18
github-actions
Bot
added
product:agents
github-actions
Bot
assigned
elithrar,
irvinebroque,
rita3ko,
thomasgauvin,
threepointone and
whoiskatrin
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
|
Preview URL: https://44387e30.preview.developers.cloudflare.com Files with changes (up to 15)
|
|
|
||
| The `scheduleSchema` provides a structured way to parse natural language scheduling requests into a format that can be used with `this.schedule()`. This is useful when building agents that accept user input like "remind me tomorrow at 3pm" or "schedule a meeting next Monday". | ||
|
|
||
| The schema uses the [AI SDK](https://sdk.vercel.ai/docs/introduction) to extract scheduling information from natural language text. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
scheduleSchemaAPI which parses natural language scheduling requestsproviderOptionsfor OpenAI compatibilityContext
Synced from cloudflare/agents PR cloudflare/agents#815
When using
scheduleSchemawith OpenAI models via the AI SDK, users must passproviderOptions: { openai: { strictJsonSchema: false } }togenerateObject. This is required because@ai-sdk/openainow defaultsstrictJsonSchematotrue, which requires all schema properties to be in therequiredarray. ThescheduleSchemauses optional fields which are not compatible with this strict mode.🤖 Generated with Claude Code