Getting Started
How to
- GETAuthentication
- GETZapier account list
- Stored Vs. Stateless Actions
- Stored actions
- Stateless actions
- Gathering action information
API Reference
- system
- auth
- apps
- actions
- execution
- ai-actions
- utilities
Libraries
- TypeScript (Node.js, Deno)
- React Components
Development Resources
List stored Actions
List all the current actions for the current user.
curl --request GET \
--url https://actions.zapier.com/api/v2/ai-actions/ \
--header 'Authorization: Bearer <token>'
{
"results": [
{
"id": "<string>",
"description": "<string>",
"account_id": 123,
"authentication_id": 123,
"app": "<string>",
"action": "<string>",
"action_type": "read",
"params": {},
"meta": {
"params": {},
"app_label": "<string>",
"action_label": "<string>",
"authentication_label": "<string>",
"app_needs_auth": true
},
"needs": [
{
"key": "<string>",
"type": "int",
"label": "<string>",
"required": true,
"prefill": "<string>",
"searchfill": "<string>",
"capabilities": [
"<string>"
],
"custom_field": true,
"depends_on": [
"<string>"
],
"input_format": [
"<any>"
],
"language": "<string>",
"parent_key": "<string>",
"regex": "<string>",
"alters_custom_fields": true,
"choices": [
{
"key": "<string>",
"label": "<string>",
"sample": "<string>"
}
],
"default": "<string>",
"help_text": "<string>",
"placeholder": "<string>",
"format": "<string>",
"list": true
}
]
}
],
"configuration_link": "<string>"
}
These actions can then be provided as tools to an LLM, which can decide what parameters to use when running the action.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Response
The unique ID of the AI action.
Description of the AI action.
Zapier account ID that will be used when running the action.
ID of the authentication to use for the app when running the action.
The app that the action is for.
The action that will be run.
The type of action that will be run.
read
, write
, search
, read_bulk
The parameters that will be used when running the action.
Metadata about the AI action.
Dictionary of need to parameter metadata.
Key should be the key for a need
that is also in the params
dictionary.
Label for the app that the action using.
Label for the action that will be run.
Label for the authentication that will be used.
Whether or not the app needs authentication to run.
The key of the need.
This is used as the key in objects such as params
and params_constraints
.
The type of the need.
int
, integer
, float
, decimal
, unicode
, text
, str
, string
, datetime
, boolean
, bool
, file
, copy
, password
, dict
, code
, filter
, confirmation
Label for the need.
Whether or not a value for this need is required in order to run the action.
If a need has a prefill
, then that means its value should come from a list of available values.
See Get prefill Choices for information on how to get the available values for a need.
If this is true, then it means that this need comes from a custom field.
See the Custom fields section in Get action details and needs for more information on these needs.
A list of the key
of other needs that this need depends on.
If this exists, it means that the value of this need may change if one of the listed needs changes. See the Custom fields section in Get action details and needs for more information on these needs.
Additional information that is specific to this need. May include links to outside documentation.
URL to configure and expose more actions.
Was this page helpful?
curl --request GET \
--url https://actions.zapier.com/api/v2/ai-actions/ \
--header 'Authorization: Bearer <token>'
{
"results": [
{
"id": "<string>",
"description": "<string>",
"account_id": 123,
"authentication_id": 123,
"app": "<string>",
"action": "<string>",
"action_type": "read",
"params": {},
"meta": {
"params": {},
"app_label": "<string>",
"action_label": "<string>",
"authentication_label": "<string>",
"app_needs_auth": true
},
"needs": [
{
"key": "<string>",
"type": "int",
"label": "<string>",
"required": true,
"prefill": "<string>",
"searchfill": "<string>",
"capabilities": [
"<string>"
],
"custom_field": true,
"depends_on": [
"<string>"
],
"input_format": [
"<any>"
],
"language": "<string>",
"parent_key": "<string>",
"regex": "<string>",
"alters_custom_fields": true,
"choices": [
{
"key": "<string>",
"label": "<string>",
"sample": "<string>"
}
],
"default": "<string>",
"help_text": "<string>",
"placeholder": "<string>",
"format": "<string>",
"list": true
}
]
}
],
"configuration_link": "<string>"
}