developers.raycast.com

# Raycast API

## Raycast API

- [Introduction](https://developers.raycast.com/readme.md): Start building your perfect tools with the Raycast API.
- [Getting Started](https://developers.raycast.com/basics/getting-started.md): This guide covers the prerequisites you need to start building extensions.
- [Create Your First Extension](https://developers.raycast.com/basics/create-your-first-extension.md): Learn how to build your first extension and use it in Raycast.
- [Contribute to an Extension](https://developers.raycast.com/basics/contribute-to-an-extension.md): Learn how to import an extension to collaborate with others.
- [Prepare an Extension for Store](https://developers.raycast.com/basics/prepare-an-extension-for-store.md): Learn how to get through review process quickly
- [Publish an Extension](https://developers.raycast.com/basics/publish-an-extension.md): Learn how to share your extension with our community.
- [Debug an Extension](https://developers.raycast.com/basics/debug-an-extension.md): This guide covers how to find and fix bugs in your extension.
- [Install an Extension](https://developers.raycast.com/basics/install-an-extension.md): Learn how to find and use extensions from the Raycast Store.
- [Review an Extension in a Pull Request](https://developers.raycast.com/basics/review-pullrequest.md): Learn how to review a contribution from a Pull Request opened by a contributor.
- [Getting Started](https://developers.raycast.com/ai/getting-started.md): This guide explains how to use AI inside extensions.
- [Create an AI Extension](https://developers.raycast.com/ai/create-an-ai-extension.md): Learn how to turn a regular extension into an AI-powered one.
- [Learn Core Concepts of AI Extensions](https://developers.raycast.com/ai/learn-core-concepts-of-ai-extensions.md): Get to know the core concepts of AI extensions.
- [Evals](https://developers.raycast.com/ai/evals.md): Write and run AI Extension evals with tool mocks, expectations, and suggested prompts.
- [Follow Best Practices for AI Extensions](https://developers.raycast.com/ai/follow-best-practices-for-ai-extensions.md): Make the most out of your AI Extension by following best practices.
- [Provide AI Models](https://developers.raycast.com/ai/provide-ai-models.md): This guide explains how an extension can provide AI models to Raycast.
- [Getting Started](https://developers.raycast.com/teams/getting-started.md): This guide sets you up with Raycast for Teams.
- [Publish a Private Extension](https://developers.raycast.com/teams/publish-a-private-extension.md): Learn how to share an extension in your organization's private extension store
- [Collaborate on Private Extensions](https://developers.raycast.com/teams/collaborate-on-private-extensions.md): This guide explains how to collaborate with your team on extensions.
- [Doppler Share Secrets](https://developers.raycast.com/examples/doppler.md): This example uses a simple form to collect data.
- [Hacker News](https://developers.raycast.com/examples/hacker-news.md): This example shows how to show an RSS feed as a List.
- [Todo List](https://developers.raycast.com/examples/todo-list.md): This example show how to use lists in combination with forms.
- [Spotify Controls](https://developers.raycast.com/examples/spotify-controls.md): This example shows how to bundle multiple scripts into a single extension.
- [Terminology](https://developers.raycast.com/information/terminology.md): An explanation of various terms used in this documentation.
- [File Structure](https://developers.raycast.com/information/file-structure.md): Understand the file structure of an extension.
- [Manifest](https://developers.raycast.com/information/manifest.md)
- [Lifecycle](https://developers.raycast.com/information/lifecycle.md)
- [Arguments](https://developers.raycast.com/information/lifecycle/arguments.md)
- [Background Refresh](https://developers.raycast.com/information/lifecycle/background-refresh.md)
- [Deeplinks](https://developers.raycast.com/information/lifecycle/deeplinks.md)
- [Best Practices](https://developers.raycast.com/information/best-practices.md): Tips to guarantee a good user experience for your extensions.
- [Developer Tools](https://developers.raycast.com/information/developer-tools.md)
- [Manage Extensions Command](https://developers.raycast.com/information/developer-tools/manage-extensions-command.md): A Raycast command to manage your extensions, add new commands or tools, etc.
- [CLI](https://developers.raycast.com/information/developer-tools/cli.md): The Raycast CLI allows you to build, develop, and lint your extension.
- [ESLint](https://developers.raycast.com/information/developer-tools/eslint.md)
- [Forked Extensions (community tool)](https://developers.raycast.com/information/developer-tools/forked-extensions.md)
- [VS Code (community tool)](https://developers.raycast.com/information/developer-tools/vscode.md)
- [Templates](https://developers.raycast.com/information/developer-tools/templates.md): Learn about the templates provided by Raycast to help kickstart your extension.
- [Security](https://developers.raycast.com/information/security.md)
- [Versioning](https://developers.raycast.com/information/versioning.md)
- [AI](https://developers.raycast.com/api-reference/ai.md)
- [Browser Extension](https://developers.raycast.com/api-reference/browser-extension.md)
- [Cache](https://developers.raycast.com/api-reference/cache.md)
- [Command](https://developers.raycast.com/api-reference/command.md)
- [Clipboard](https://developers.raycast.com/api-reference/clipboard.md)
- [Environment](https://developers.raycast.com/api-reference/environment.md)
- [Feedback](https://developers.raycast.com/api-reference/feedback.md)
- [Alert](https://developers.raycast.com/api-reference/feedback/alert.md)
- [HUD](https://developers.raycast.com/api-reference/feedback/hud.md)
- [Toast](https://developers.raycast.com/api-reference/feedback/toast.md)
- [Keyboard](https://developers.raycast.com/api-reference/keyboard.md)
- [Menu Bar Commands](https://developers.raycast.com/api-reference/menu-bar-commands.md)
- [OAuth](https://developers.raycast.com/api-reference/oauth.md)
- [Preferences](https://developers.raycast.com/api-reference/preferences.md)
- [Storage](https://developers.raycast.com/api-reference/storage.md)
- [System Utilities](https://developers.raycast.com/api-reference/utilities.md)
- [User Interface](https://developers.raycast.com/api-reference/user-interface.md)
- [Action Panel](https://developers.raycast.com/api-reference/user-interface/action-panel.md)
- [Actions](https://developers.raycast.com/api-reference/user-interface/actions.md)
- [Detail](https://developers.raycast.com/api-reference/user-interface/detail.md)
- [Form](https://developers.raycast.com/api-reference/user-interface/form.md)
- [List](https://developers.raycast.com/api-reference/user-interface/list.md): The de-facto user interface in Raycast. Ideal to present similar data such as to-dos or files.
- [Grid](https://developers.raycast.com/api-reference/user-interface/grid.md)
- [Colors](https://developers.raycast.com/api-reference/user-interface/colors.md)
- [Icons & Images](https://developers.raycast.com/api-reference/user-interface/icons-and-images.md)
- [Navigation](https://developers.raycast.com/api-reference/user-interface/navigation.md)
- [Raycast Window & Search Bar](https://developers.raycast.com/api-reference/window-and-search-bar.md)
- [Tool](https://developers.raycast.com/api-reference/tool.md)
- [Window Management](https://developers.raycast.com/api-reference/window-management.md)
- [Getting Started](https://developers.raycast.com/utilities/getting-started.md)
- [Functions](https://developers.raycast.com/utilities/functions.md)
- [createDeeplink](https://developers.raycast.com/utilities/functions/createdeeplink.md)
- [executeSQL](https://developers.raycast.com/utilities/functions/executesql.md)
- [runAppleScript](https://developers.raycast.com/utilities/functions/runapplescript.md)
- [runPowerShellScript](https://developers.raycast.com/utilities/functions/runpowershellscript.md)
- [showFailureToast](https://developers.raycast.com/utilities/functions/showfailuretoast.md)
- [withCache](https://developers.raycast.com/utilities/functions/withcache.md)
- [Icons](https://developers.raycast.com/utilities/icons.md)
- [getAvatarIcon](https://developers.raycast.com/utilities/icons/getavataricon.md)
- [getFavicon](https://developers.raycast.com/utilities/icons/getfavicon.md)
- [getProgressIcon](https://developers.raycast.com/utilities/icons/getprogressicon.md)
- [OAuth Utils](https://developers.raycast.com/utilities/oauth.md)
- [OAuthService](https://developers.raycast.com/utilities/oauth/oauthservice.md)
- [withAccessToken](https://developers.raycast.com/utilities/oauth/withaccesstoken.md)
- [getAccessToken](https://developers.raycast.com/utilities/oauth/getaccesstoken.md)
- [Getting a Google client ID](https://developers.raycast.com/utilities/oauth/getting-google-client-id.md)
- [React hooks](https://developers.raycast.com/utilities/react-hooks.md)
- [useCachedState](https://developers.raycast.com/utilities/react-hooks/usecachedstate.md)
- [usePromise](https://developers.raycast.com/utilities/react-hooks/usepromise.md)
- [useCachedPromise](https://developers.raycast.com/utilities/react-hooks/usecachedpromise.md)
- [useFetch](https://developers.raycast.com/utilities/react-hooks/usefetch.md)
- [useForm](https://developers.raycast.com/utilities/react-hooks/useform.md)
- [useExec](https://developers.raycast.com/utilities/react-hooks/useexec.md)
- [useSQL](https://developers.raycast.com/utilities/react-hooks/usesql.md)
- [useAI](https://developers.raycast.com/utilities/react-hooks/useai.md)
- [useFrecencySorting](https://developers.raycast.com/utilities/react-hooks/usefrecencysorting.md)
- [useStreamJSON](https://developers.raycast.com/utilities/react-hooks/usestreamjson.md)
- [useLocalStorage](https://developers.raycast.com/utilities/react-hooks/uselocalstorage.md)
- [Changelog](https://developers.raycast.com/misc/changelog.md)
- [Migration](https://developers.raycast.com/misc/migration.md)
- [v1.28.0](https://developers.raycast.com/misc/migration/v1.28.0.md)
- [v1.31.0](https://developers.raycast.com/misc/migration/v1.31.0.md)
- [v1.37.0](https://developers.raycast.com/misc/migration/v1.37.0.md)
- [v1.42.0](https://developers.raycast.com/misc/migration/v1.42.0.md)
- [v1.48.8](https://developers.raycast.com/misc/migration/v1.48.8.md)
- [v1.50.0](https://developers.raycast.com/misc/migration/v1.50.0.md)
- [v1.51.0](https://developers.raycast.com/misc/migration/v1.51.0.md)
- [v1.59.0](https://developers.raycast.com/misc/migration/v1.59.0.md)
- [FAQ](https://developers.raycast.com/misc/faq.md): Answers to the most frequently asked questions.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.raycast.com/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.