Zapier AI Actions

AI-powered automation actions

nla.zapier.com ↗
Version
1.0.0
OpenAPI
3.0.2
Endpoints
5
Schemas
5
Updated
3 days ago
Automation automation ai integration
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://actions.zapier.com

Authentication

apiKey apiKey apiKey oauth2

Endpoints

Action 2 endpoints

GET /api/v1/exposed

List all the currently exposed actions for the given account.

operationId: Action_listExposedActions

Responses

200 OK
GET /api/v1/exposed
POST /api/v1/exposed/{exposed_app_action_id}/execute

Give us a plain english description of exact action you want to do. There should be dynamically generated documentation for this endpoint for each action that is exposed.

operationId: Action_executeAppAction

Parameters

Name In Required Type Description
exposed_app_action_id path required string

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ExecuteRequest"
      }
    }
  },
  "required": true
}

Responses

200 OK
400 Bad Request
POST /api/v1/exposed/{exposed_app_action_id}/execute

Check 1 endpoints

GET /api/v1/check

Test that the API and auth are working.

operationId: Check_authTestGet

Responses

200 OK
GET /api/v1/check

Configuration 1 endpoints

GET /api/v1/configuration-link

Provides a link to configure more actions. Alternatively, searching through apps and actions will provide more specific configuration links.

operationId: Configuration_getConfigurationLink

Responses

200 OK
GET /api/v1/configuration-link

Log 1 endpoints

GET /api/v1/execution-log/{execution_log_id}

Get the execution log for a given execution log id.

operationId: Log_getExecutionLog

Parameters

Name In Required Type Description
execution_log_id path required string

Responses

200 OK
400 Bad Request
GET /api/v1/execution-log/{execution_log_id}

Schemas

object ErrorResponse
{
  "type": "object",
  "title": "ErrorResponse",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "string",
      "title": "Error",
      "description": "Error message."
    }
  }
}
object ExecuteRequest
{
  "type": "object",
  "title": "ExecuteRequest",
  "required": [
    "instructions"
  ],
  "properties": {
    "instructions": {
      "type": "string",
      "title": "Instructions",
      "description": "Plain english instructions. Provide as much detail as possible, even if other fields are present."
    },
    "preview_only": {
      "type": "boolean",
      "title": "Preview Only",
      "default": false,
      "description": "If true, we will not execute the action, but will return the params of the preview."
    }
  },
  "description": "This extends from ExecuteRequestBase to add the preview_only option.\n\n(1) Providers who allow side effects or (2) actions that do not have a side effect should use this class."
}
object ExecuteResponse
{
  "type": "object",
  "title": "ExecuteResponse",
  "required": [
    "id",
    "action_used",
    "input_params",
    "review_url",
    "additional_results"
  ],
  "properties": {
    "id": {
      "type": "string",
      "title": "Id",
      "description": "The id of the execution log."
    },
    "error": {
      "type": "string",
      "title": "Error",
      "description": "The error message if the execution failed."
    },
    "result": {
      "type": "object",
      "title": "Result",
      "description": "A trimmed down result of the first item of the full results. Ideal for humans and language models!"
    },
    "status": {
      "enum": [
        "success",
        "error",
        "empty",
        "preview"
      ],
      "type": "string",
      "title": "Status",
      "default": "success",
      "description": "The status of the execution."
    },
    "review_url": {
      "type": "string",
      "title": "Review Url",
      "description": "The URL to run the action or review the AI choices the AI made for input_params given instructions."
    },
    "action_used": {
      "type": "string",
      "title": "Action Used",
      "description": "The name of the action that was executed."
    },
    "input_params": {
      "type": "object",
      "title": "Input Params",
      "description": "The params we used / will use to execute the action."
    },
    "assistant_hint": {
      "type": "string",
      "title": "Assistant Hint",
      "description": "A hint for the assistant on what to do next."
    },
    "additional_results": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "title": "Additional Results",
      "description": "The rest of the full results. Always returns an array of objects"
    },
    "result_field_labels": {
      "type": "object",
      "title": "Result Field Labels",
      "description": "Human readable labels for some of the keys in the result."
    }
  },
  "description": "This is a summary of the results given the action that was executed."
}
object ExposedActionResponseSchema
{
  "type": "object",
  "title": "ExposedActionResponseSchema",
  "required": [
    "results",
    "configuration_link"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ExposedActionSchema"
      },
      "title": "Results"
    },
    "configuration_link": {
      "type": "string",
      "title": "Configuration Link",
      "description": "URL to configure and expose more actions."
    }
  }
}
object ExposedActionSchema
{
  "type": "object",
  "title": "ExposedActionSchema",
  "required": [
    "id",
    "operation_id",
    "description",
    "params"
  ],
  "properties": {
    "id": {
      "type": "string",
      "title": "Id",
      "description": "The unique ID of the exposed action."
    },
    "params": {
      "type": "object",
      "title": "Params",
      "description": "Available hint fields for the action."
    },
    "description": {
      "type": "string",
      "title": "Description",
      "description": "Description of the action."
    },
    "operation_id": {
      "type": "string",
      "title": "Operation Id",
      "description": "The operation ID of the exposed action."
    }
  }
}