List stored Actions

List AI Actions

curl --request GET \
  --url https://actions.zapier.com/api/v2/ai-actions/ \
  --header 'x-api-key: <api-key>'

{
  "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>",
          "custom_field": true,
          "depends_on": [
            "<string>"
          ],
          "choices": [
            {
              "key": "<string>",
              "label": "<string>",
              "sample": "<string>"
            }
          ],
          "help_text": "<string>",
          "searchfill": "<string>",
          "capabilities": [
            "<string>"
          ],
          "input_format": [
            "<unknown>"
          ],
          "language": "<string>",
          "parent_key": "<string>",
          "regex": "<string>",
          "alters_custom_fields": true,
          "default": "<string>",
          "placeholder": "<string>",
          "format": "<string>",
          "list": true
        }
      ]
    }
  ],
  "configuration_link": "<string>"
}

GET

api

ai-actions

List AI Actions

curl --request GET \
  --url https://actions.zapier.com/api/v2/ai-actions/ \
  --header 'x-api-key: <api-key>'

{
  "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>",
          "custom_field": true,
          "depends_on": [
            "<string>"
          ],
          "choices": [
            {
              "key": "<string>",
              "label": "<string>",
              "sample": "<string>"
            }
          ],
          "help_text": "<string>",
          "searchfill": "<string>",
          "capabilities": [
            "<string>"
          ],
          "input_format": [
            "<unknown>"
          ],
          "language": "<string>",
          "parent_key": "<string>",
          "regex": "<string>",
          "alters_custom_fields": true,
          "default": "<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.

See Run a stored action for details on running an action.

Authorizations

x-api-key

string

header

required

Response

200 - application/json

results

AiActionResponse · object[]

required

Show child attributes

results.id

string

required

The unique ID of the AI action.

results.description

string

required

Description of the AI action.

results.account_id

integer | null

required

Zapier account ID that will be used when running the action.

results.authentication_id

integer | null

required

ID of the authentication to use for the app when running the action.

results.app

string | null

required

The app that the action is for.

results.action

string | null

required

The action that will be run.

results.action_type

enum<string> | null

required

The type of action that will be run.

Available options:

read,

write,

search,

read_bulk

results.params

Params · object

required

The parameters that will be used when running the action.

results.meta

AiActionMeta · object

required

Metadata about the AI action.

Show child attributes

results.meta.params

Params · object

required

Dictionary of need to parameter metadata.

Key should be the key for a need that is also in the params dictionary.

Show child attributes

results.meta.params.{key}

ParamsValue · object

Show child attributes

results.meta.params.{key}.label

string

required

Human-readable label for the need.

For example, if a specific spreadsheet was chosen, the label should be the name of the spreadsheet.

results.meta.app_label

string | null

Label for the app that the action using.

results.meta.action_label

string | null

Label for the action that will be run.

results.meta.authentication_label

string | null

Label for the authentication that will be used.

results.meta.app_needs_auth

boolean | null

Whether or not the app needs authentication to run.

results.needs

AiActionNeed · object[] | null

Show child attributes

results.needs.key

string

required

The key of the need.

This is used as the key in objects such as params and params_constraints.

results.needs.type

enum<string> | null

required

The type of the need.

Available options:

int,

integer,

float,

decimal,

unicode,

text,

str,

string,

datetime,

boolean,

bool,

file,

copy,

password,

dict,

code,

filter,

confirmation

results.needs.label

string | null

required

Label for the need.

results.needs.required

boolean | null

required

Whether or not a value for this need is required in order to run the action.

results.needs.prefill

string | null

required

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.

results.needs.custom_field

boolean | null

required

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.

results.needs.depends_on

string[] | null

required

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.

results.needs.choices

ChoiceT · object[] | null

required

If this array exists, then it will be a static list of choices that the value of this need can be when it runs.

Show child attributes

results.needs.choices.key

string

results.needs.choices.label

string

results.needs.choices.sample

string

results.needs.help_text

string | null

required

Additional information that is specific to this need. May include links to outside documentation.

results.needs.searchfill

string | null

results.needs.capabilities

string[] | null

results.needs.input_format

any[] | null

results.needs.language

string | null

results.needs.parent_key

string | null

results.needs.regex

string | null

results.needs.alters_custom_fields

boolean | null

results.needs.default

string | null

results.needs.placeholder

string | null

results.needs.format

string | null

results.needs.list

boolean | null

configuration_link

string

required

URL to configure and expose more actions.

Configure stored actions in the AI Actions UI Run a stored action

⌘I

Getting started

How to

API Reference

Tools

Libraries

Development Resources

Help

List stored Actions

Authorizations

Response