Quickstart

Before making your first request, the following is required:

👾 Create an account
🔑 Go to “settings” → “api keys” and “create” a key
💳 Buy a subscription to make requests in production mode

Pipeline request

Pipeline requests are how data is enriched.

The request below enriches one input object with workEmailAddress and companyDescription fields.

const result = await fetch("https://pipe0.com/api/v1/run", {
method: "POST",
headers: {
    "Authorization": `Bearer ${YOUR_API_TOKEN}`,
    "X-Test-Mode": "true" // Remove this header for production requests
},
body: JSON.stringify({
    pipes: [
    {
        name: "PeopleBusinessEmailWaterfallV1"
    },
    {
        name: "CompanyDescriptionGoogleMapsV1"
    }
    ],
    input: [
        {
            name: "John Doe",
            companyName: "Google LLC"
        }
    ]
})
});

First, we find John Doe’s work email address and use it to infer the company domain (URL). We then use this URL to query the company description.

Request validation

When you send a request, it is validated before it is processed. If validation fails the server responds with a 400 Bad Request  status code.

Pipeline response

Pipeline requests are processed asynchronously. The pipeline response contains the current processing state. Most importantly, it contains an id and a status property.

Poll the endpoint https://pipe0.com/api/v1/check until the status of the task is set to completed.

The response you receive for a valid pipeline request is identical in shape to responses returned from the /check endpoint.

Test Mode

Running pipelines in production incurs usage costs. This is why all pipes offer a test mode. Making requests in test mode is always free.

Do not expect data returned in test mode to make sense. However, expect the data returned in test mode to be structurally correct in regards to type, content length, and format.

To send requests in test mode, include the X-Test-Mode: true header.