POST
/
api
/
v2
/
ai-actions
curl --request POST \
  --url https://actions.zapier.com/api/v2/ai-actions/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "app": "<string>",
  "action": "<string>",
  "action_type": "read",
  "params": {},
  "meta": {
    "params": {},
    "app_label": "<string>",
    "action_label": "<string>",
    "authentication_label": "<string>",
    "app_needs_auth": true
  }
}'
{
  "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
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
account_id
integer | null

The Zapier account ID to use.

Account IDs available to the user can be listed using the Get Account List endpoint

​
authentication_id
integer | null

ID of the authentication to use for the app.

Authentications available to the user can be listed using the List Authentications For App endpoint.

Body

application/json
​
app
string
required
​
action
string
required
​
action_type
enum<string>
required
Available options:
read,
write,
search,
read_bulk
​
params
object
required

Dictionary of need to value or list of possible values.

If this is a single string, then it will be used to guess the actual value of the need when running the action.

If this is a list of strings, it's expected that it will be IDs of possible values for the AI to choose from.

Needs that are omitted from this dictionary will be guessed by the AI at runtime based on instructions.

​
meta
object
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

Was this page helpful?

Get stored actionUpdate stored action