REST

Send REST requests with the REST built-in.

Request
Perform a request against a REST resource.
typescript
Copied
1
import airplane from "airplane";
2


3
export default airplane.task(
4
  {
5
    slug: "get_user_profiles",
6
    // Attach REST resource to task
7
    resources: ["profile_api"],
8
  },
9
  async (params) => {
10
    const run = await airplane.rest.request<{ userId: string; avatar: string }>(
11
      // Slug of the REST resource to query
12
      "profile_api",
13
      // REST method to execute
14
      "GET",
15
      // URL path
16
      "/profile"
17
    );
18
    return run.output.response;
19
  }
20
);
API
PrivacyTermsSupport