Request Payload
The following API operations require a request payload of type PipelineRequest
:
POST https://api.pipe0.com/v1/run
(create an enrichment task)POST https://api.pipe0.com/v1/run/sync
(create an enrichment task and return the result)
Learn more about the difference between the two operations.
Here’s a sample payload:
{
"pipes": [
{
"pipe_id": "company:identity@1",
"config": {
"input_fields": {
"company_name": {
"alias": ""
}
}
}
},
],
"input": [
{
"id": 1,
"name": "Tom Schmidt",
"company_name": "Pipe0",
},
],
}
Request payload properties
pipes[]
An array of enrichment pipes alongside the pipe configuration. A full list of available pipes can be found in the pipe catalog.
pipe.pipe_id
The unique identifier of a pipe.
pipe.config
Pipe config object. The full config object can be found in the pipe catalog. Passing pipe configuration is optional. If no configuration is passed, the default config is used.
pipe.config.providers
Pipes with multiple providers allow you to choose which providers are processed and their order or processing. Learn more about waterfall pipes.
pipe.config.input_fields
Pipe configuration for the input fields of a pipe.
pipe.config.input_field.alias
Point the input field of a pipe to a custom field name.
Example: You want to use the property custom_company_name
for the input field comapny_name
. Point the pipe input field comapny_name
to your
custom field by providing the "alias": "custom_company_name"
in the pipe config.
The field you point to must have the correct type.
pipe.config.output_fields
Pipe configuration for the output fields of a pipe.
pipe.config.output_field.alias
Rename the pipe output field to a different field_name
. This can be useful if you have two pipes that output the same field (error).
To avoid a duplicate output field, rename the output field by using an alias
.
input[]
An array of input objects. This is the data you want to enrich.
input.id
Each input object must have a unique id
property. The id can be a string
or a number
. Id’s can be as simple as 1
, 2
, 3
, …
input[number]
Each object in the input
array represents an input object.
input[fieldName]
Each property of an input object represents an input field. Input fields are used as pipe input after input sanitation.
OpenAPI 3.1
When creating request payloads it is helpful to have autocomplete in your IDE. For this, you can generate a client from our open API file hosted at:
API clients wrap the HTTP API with language-native function calls.
Generator libraries
There are open-source tools that can generate clients in many languages: