Response object
The following API operations return a response of type PipesResponse:
POST https://api.pipe0.com/v1/pipes/run(create an enrichment task)GET https://api.pipe0.com/v1/pipes/check/{run_id}(check the processing state)POST https://api.pipe0.com/v1/pipes/run/sync(create an enrichment task and return the result)
Responses are designed for building rich data tables like Clay, node-based workflow builders like Zapier, and plain automation code (think n8n as code).
By default, responses contain enriched data only. Enable widgets and field definitions for additional metadata, for example which providers were used in a waterfall.
The raw response object
Response object properties
id
The task id. During and after processing you can use this id to look up
your processing result. We store tasks for up to three days after processing is completed.
status
The status of the response object.
Status 'pending'
Your request has been validated and an enrichment task has been created. Processing has not yet begun.
Status 'processing'
Your request has been validated and processing has begun. During processing, the status of your record fields is continuously updated.
Status 'completed'
Processing has finished without global errors. Individual fields may still have failed to process.
Status 'failed'
Pipeline validation or processing has failed. See the global errors property for more information on why
the failure occurred.
order
We transform the list of input data into an object called records. The records object has keys
that match the ids of your input data, but it does not preserve the order of your input.
The order property preserves it for you: an ordered list of input data ids.
field_definitions
Metadata for all fields that exist in your pipeline.
Think of each input object as a row of a table. If input data are the rows, then field_definitions
are the columns.
The field_definitions object contains all fields that
exist in your pipeline. This includes pipe output fields and fields derived from input objects.
The keys are field names, the values field properties.
errors
Global task errors. If your response contains errors at the top level, your task failed. Use this error array to understand why. Individual fields can fail too; in that case, the field contains a local error.
records
Each input object is transformed into a record object during processing.
record.id
The id you provided in your input object.
record.fields
If your original request contained an input array of the shape [{id: 1, foo: "bar"}, {id: 2, "bar": "baz"}],
all output records will have the fields id, foo, and bar.
The fields are normalized: all output records have the same fields. If any input object contains a property, it is added to all output records.
In addition to fields derived from input objects, record.fields contains pipe output fields.
It is guaranteed that field_definitions and record.fields have the same keys.
record.field.value
The value of the field. If the value was provided as part of your input data it is copied over. If the value was generated from an enrichment operation, it is added.
record.field.status
The status of the field. Possible values are completed, failed, pending, queued, processing, skipped, or no_result.
The status is no_result if processing completed without yielding a meaningful
result, failed if the pipe failed due to errors, and skipped if processing was skipped due to an unmet condition
or missing input.
record.field.type
The type of the provided or generated value. Possible values are string, number, boolean, json, or unknown.
The type is unknown if the field was derived from input data but no input object provided a value and
the field is not an output field of a pipe.
record.field.reason
Guaranteed to exist if the field status is failed or no_result. Of type null | {code: string; summary: string; message: string}.
Contains additional information about pipe failure.
record.field.claimed_by
Each field is assigned to an entity that is responsible for resolving it. Resolvers can be input data or pipes.
A pipe "claims" each field it is responsible for. A pipe claiming a field does not mean it will
resolve it:
if your input object already contains a valid value, the field is claimed by a pipe but resolved by input.
Use this field to render fields as columns ordered by pipe.
record.field.resolved_by
Guaranteed to exist if the status of the field is completed, and guaranteed to be null otherwise. The resolved_by field tells you whether a field was processed by a pipe or copied over from input data.
record.field.meta
Contains metadata about the field processing. For waterfall enrichments, this includes all the providers that were tried for this field.
record.field.ui
Additional information for rendering the field value.