Zapier

Zapier Natural Language Actions (NLA) API - Beta

Hi, there! Welcome to the Zapier Natural Language Actions API docs. You are currently viewing the root API. The endpoints of this root API are static and…

Developer tools#openapi#developer-tools

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Hi, there!

Welcome to the Zapier Natural Language Actions API docs. You are currently viewing the root API.

The endpoints of this root API are static and useful for reference. To see the live playground with dynamic API endpoints that match up to your own actions, log in first, then go here:

NLA Dynamic API.

Overview

Zapier is an integration platform with over 5,000+ apps and 50,000+ actions. You can view the full list here. Zapier is used by millions of users, most of whom are non-technical builders -- but often savvy with software. Zapier offers several no code products to connect together the various apps on our platform. NLA exposes the same integrations Zapier uses to build our products, to you, to plug-in the capabilties of Zapier's platform into your own products.

For example, you can use the NLA API to:

  • Send messages in Slack
  • Add a row to a Google Sheet
  • Draft a new email in Gmail
  • ... and thousands more, with one universal natural language API

The typical use-case for NLA is to expose our ecosystem of thousands of apps/actions within your own product. NLA is optimized for products that receive user input in natural language (eg. chat, assistant, or other large language model based experience) -- that said, it can also be used to power _any_ product that needs integrations. In this case, think of NLA as a more friendly, human API.

NLA contains a decade of experience with API shenanigans, so you don't have to. Common API complexity, automatically handled:

  • Every type of auth (Basic, Session, API Key, OAuth v1, Oauth v2, Digest, ...), Zapier securely handles and signs requests for you
  • Support for create, update, and search actions, endpoints optimized for natural language usage
  • Support for custom fields, Spreadsheet, CRM, and Mailing List friendly!
  • Reference by name, not ID, humans use natural language names, not IDs, to reference things in their apps, so NLA does too
  • Smart, human defaults, APIs sometimes have 100 options. Zapier's platform data helps us make NLA simpler for users out of the box

Two Usage Modes

NLA handles all the underlying API auth and translation from natural language --> underlying API call --> return simplified output. The key idea is you (the developer), or your users, expose a set of actions via an oauth-like setup window, which you can then query and execute via a REST API. NLA offers both API Key and OAuth for signing NLA API requests.

  1. Server-side only (API Key): for quickly getting started, testing, and production scenarios where your app will only use actions exposed in the developer's Zapier account (and will use the developer's connected accounts on Zapier.com)
  1. User-facing (Oauth): for production scenarios where you are deploying an end-user facing application and your app needs access to end-user's exposed actions and connected accounts on Zapier.com

Why Natural Language?

Simply, it makes the API easier to use for both developers and users (and also for large language models!)

We designed NLA to expose the power of Zapier's platform without passing along the complexity. A few design choices:

Using the API is then simple:

curl -v \
    -d '{"instructions": "Add Bryan Helmig at Zapier to my NLA test sheet, oh and he loves guitars!"}' \
    -H "Authorization: Bearer  " \
    -H "Content-Type: application/json" \
    'https://nla.zapier.com/api/v1/dynamic/exposed/ /execute/'

Or mix in some fixed values:

curl -v \
    -d '{"instructions": "Send a short poem about automation to slack", "channel": "#fun-zapier"}' \
    -H "Authorization: Bearer  " \
    -H "Content-Type: application/json" \
    'https://nla.zapier.com/api/v1/dynamic/exposed/ /execute/'

Auth

For Quickly Exploring

It's best to take advantage of session auth built into the OpenAPI docs.

  1. [Log…

Endpoints 4

  • GETCheck/api/v1/check/Test that the API and auth are working.
  • GETGet Configuration Link/api/v1/configuration-link/If the user wants to execute actions that are not exposed, they can go here to configure and expose more.
  • GETList Exposed Actions/api/v1/exposed/List all the currently exposed actions for the given account.
  • POSTExecute App Action Endpoint/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…

API details

Base URL
https://nla.zapier.com
Authentication
An API key in the X-API-Key header
An API key in the api_key query parameter
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the sessionid cookie
Operations
4 operations on 4 pathsGET 3POST 1
Response formats
application/json
Description format
OpenAPI 3.0.2, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Zapier Natural Language Actions (NLA) API - Beta in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Zapier Natural Language Actions (NLA) API - Beta collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Check” (GET /api/v1/check/), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Zapier Natural Language Actions (NLA) API - Beta?

Hi, there! Welcome to the Zapier Natural Language Actions API docs. You are currently viewing the root API. The endpoints of this root API are static and… It is listed under Developer tools and has 4 endpoints.

Who publishes the Zapier Natural Language Actions (NLA) API - Beta?

It is listed from Zapier's public API description (an OpenAPI document), not published by Zapier on Swastik Codes. Anyone who controls zapier.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Zapier Natural Language Actions (NLA) API - Beta?

Requests go to https://nla.zapier.com. Endpoint paths are added to this base URL.

How do I authenticate with the Zapier Natural Language Actions (NLA) API - Beta?

It accepts 4 methods: an API key in the X-API-Key header; an API key in the api_key query parameter; OAuth 2.0 (authorization code flow) with 1 scope; an API key in the sessionid cookie.

How many endpoints does the Zapier Natural Language Actions (NLA) API - Beta have?

4 operations on 4 paths (3 GET, 1 POST).

Is forking the Zapier Natural Language Actions (NLA) API - Beta free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.