GET
/
api
/
v2
/
ai-actions
/
{ai_action_id}
curl --request GET \
  --url https://actions.zapier.com/api/v2/ai-actions/{ai_action_id}/ \
  --header 'x-api-key: <api-key>'
{
  "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
    }
  ]
}
See Run a stored action for details on running an action.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
ai_action_id
string
required

Response

200 - application/json
OK
​
id
string
required

The unique ID of the AI action.

​
description
string
required

Description of the AI action.

​
account_id
integer | null
required

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

​
authentication_id
integer | null
required

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

​
app
string | null
required

The app that the action is for.

​
action
string | null
required

The action that will be run.

​
action_type
enum<string> | null
required

The type of action that will be run.

Available options:
read,
write,
search,
read_bulk
​
params
object
required

The parameters that will be used when running the action.

​
meta
object
required

Metadata about the AI action.

​
needs
object[] | null
Run a stored actionCreate stored action