POST
/
api
/
v2
/
ai-actions
curl --request POST \
  --url https://actions.zapier.com/api/v2/ai-actions/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --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

​
x-api-key
string
header
required

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

Response

200 - application/json

OK

The response is of type object.