Pipe0

https://pipe0.com/docs
Admin
Pipe0 is a data enrichment framework that provides flexible APIs for prospecting, enrichment, and...
Tokens:54,417
Snippets:244
Trust Score:6.1
Update:7 months ago
Show doc for...
Tokens:
Raw
### Basic Pipe0 Client SDK Usage (TypeScript)

Source: https://pipe0.com/docs/examples/examples-workflows/signup-alerts

Demonstrates the basic usage of the Pipe0 client SDK in TypeScript. This snippet shows how to check the status of pipes runs using a GET request. It requires the Pipe0 client library to be installed and configured.

```typescript
// Basic Script (TypeScript)
// Pipe0 offers a client SDK
// Check pipes run GET
```

--------------------------------

### POST /v1/pipes/run

Source: https://pipe0.com/docs/pipes

Executes enrichment pipes on input data asynchronously. This request initiates a task that can be checked later for completion.

```APIDOC
## POST /v1/pipes/run

### Description
Executes enrichment pipes on input data asynchronously. This request initiates a task that can be checked later for completion.

### Method
POST

### Endpoint
https://api.pipe0.com/v1/pipes/run

### Parameters
#### Request Body
- **config** (object) - Required - Configuration for the enrichment task.
  - **environemnt** (string) - Required - The environment to run the task in (e.g., "production").
- **pipes** (array) - Required - An array of pipe objects to execute.
  - **pipe_id** (string) - Required - The unique identifier of the pipe to run.
- **input** (array) - Required - An array of input objects to be enriched.
  - **id** (number) - Required - A unique identifier for the input object.
  - **name** (string) - Required - The name of the entity to enrich.
  - **company_website_url** (string) - Required - The website URL of the company.

### Request Example
```json
{
    "config": {
        "environemnt": "production"
    },
    "pipes": [
        {
            "pipe_id": "people:workemail:waterfall@1"
        }
    ],
    "input": [
        {
            "id": 1,
            "name": "John Doe",
            "company_website_url": "https://pipe0.com"
        }
    ]
}
```

### Response
#### Success Response (200)
- **id** (number) - The ID of the enrichment task.
- **status** (string) - The current status of the task (e.g., "pending", "completed", "failed").

#### Response Example
```json
{
    "task_id": "some_task_id"
}
```
```

--------------------------------

### POST /v1/pipes/run/sync

Source: https://pipe0.com/docs/pipes

Executes enrichment pipes on input data synchronously. This endpoint attempts to return the completed result in a single round-trip.

```APIDOC
## POST /v1/pipes/run/sync

### Description
Executes enrichment pipes on input data synchronously. This endpoint attempts to return the completed result in a single round-trip.

### Method
POST

### Endpoint
https://api.pipe0.com/v1/pipes/run/sync

### Parameters
#### Request Body
- **config** (object) - Required - Configuration for the enrichment task.
  - **environemnt** (string) - Required - The environment to run the task in (e.g., "production").
- **pipes** (array) - Required - An array of pipe objects to execute.
  - **pipe_id** (string) - Required - The unique identifier of the pipe to run.
- **input** (array) - Required - An array of input objects to be enriched.
  - **id** (number) - Required - A unique identifier for the input object.
  - **name** (string) - Required - The name of the entity to enrich.
  - **company_website_url** (string) - Required - The website URL of the company.

### Request Example
```json
{
    "config": {
        "environemnt": "production"
    },
    "pipes": [
        {
            "pipe_id": "people:workemail:waterfall@1"
        }
    ],
    "input": [
        {
            "id": 1,
            "name": "John Doe",
            "company_website_url": "https://pipe0.com"
        }
    ]
}
```

### Response
#### Success Response (200)
- **result** (array) - The enriched data.

#### Response Example
```json
[
    {
        "id": 1,
        "name": "John Doe",
        "company_website_url": "https://pipe0.com",
        "work_email": "john@pipe0.com"
    }
]
```
```

--------------------------------

### Template Example for LLM Integration - JSON

Source: https://pipe0.com/docs/pipes/pipes-concepts

An example JSON configuration for a template, likely used with Large Language Models (LLMs). It defines input and output fields using template tags, including type, schema, and description for each.

```json
{
  "prompt": {
    "template": "Determine if company {{ input company_name type=\"string\" }} is a good customer for my magic wand 🪄 business. {{ output reason type=\"json\" schema=\"reason\" description=\"Explain why the customer is a good prospect\" }} {{ output is_good_customer type=\"boolean\" format=\"int\" description=\"a flag that summarized the overall assessment of the customers fit\" }}",
    "json_schemas": {
      "reason": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "description": "A summary of why the customer is or isn't a good prospect for my business."
          }
        }
      }
    }
  }
}
```

--------------------------------

### GET /v1/pipes/check/{task_id}

Source: https://pipe0.com/docs/pipes

Polls for the result of an asynchronous enrichment task. Continue polling until the task status is 'completed'.

```APIDOC
## GET /v1/pipes/check/{task_id}

### Description
Polls for the result of an asynchronous enrichment task. Continue polling until the task status is 'completed'.

### Method
GET

### Endpoint
https://api.pipe0.com/v1/pipes/check/${taskId}

### Parameters
#### Path Parameters
- **task_id** (string) - Required - The ID of the task to check.

### Response
#### Success Response (200)
- **id** (number) - The ID of the enrichment task.
- **status** (string) - The current status of the task (e.g., "pending", "completed", "failed").
- **result** (array) - The enriched data, if the task is completed.

#### Response Example
```json
{
    "id": 1,
    "status": "completed",
    "result": [
        {
            "id": 1,
            "name": "John Doe",
            "company_website_url": "https://pipe0.com",
            "work_email": "john@pipe0.com"
        }
    ]
}
```
```

--------------------------------

### Input Expansion Example - JSON

Source: https://pipe0.com/docs/pipes/pipes-inputs

This JSON shows an example of input expansion. Instead of a plain value, the 'name' field is represented as an object with 'value', 'status', 'type', and other metadata, providing more control over data states.

```json
{
  "id": 2,
  "name": {
      "value": "emma@amazon.com",
      "status": "completed",
      "type": "string",
      "reason": null,
      "meta": null,
      "ui": {
        "severity": "none"
      }
  }
}
```

--------------------------------

### Run Search (Asynchronous)

Source: https://pipe0.com/docs/searches

Initiates a search task to find companies or people based on specified datasets and filters. The response will contain a task ID that can be used to poll for the results.

```APIDOC
## POST /v1/searches/run

### Description
Initiates a search task to find companies or people using specified datasets and filters. This is an asynchronous operation.

### Method
POST

### Endpoint
/v1/searches/run

### Parameters
#### Request Body
- **config** (object) - Required - Configuration for the search, including environment and deduplication strategy.
  - **environment** (string) - Required - The environment to run the search in (e.g., "production").
  - **dedup** (object) - Optional - Deduplication strategy.
    - **strategy** (string) - Required - The deduplication strategy (e.g., "default").
- **searches** (array) - Required - An array of search objects to execute.
  - **search_id** (string) - Required - The ID of the search dataset (e.g., "people:profiles:icypeas@1").
  - **config** (object) - Optional - Configuration for the specific search.
    - **limit** (integer) - Optional - The maximum number of results to return.
    - **filters** (object) - Optional - Filters to apply to the search.
      - **industry** (object) - Optional - Filter by industry.
        - **include** (array) - Optional - List of industries to include.

### Request Example
```json
{
    "config": {
        "environment": "production",
        "dedup": {
            "strategy": "default"
        }
    },
    "searches": [
        {
            "search_id": "people:profiles:icypeas@1",
            "config": {
                "limit": 100,
                "filters": {
                    "industry": {
                        "include": ["Software Development"]
                    }
                }
            }
        }
    ]
}
```

### Response
#### Success Response (200)
- **task_id** (string) - The ID of the created search task.

#### Response Example
(Note: The actual response for a successful POST request to `/v1/searches/run` is typically a task ID, not the search results directly. The example below shows the structure of the *results* obtained after polling.)
```json
{
	"results": [
		{
			"name": {
				"value": "Gayle Pouros",
                "type": "string",
				"format": "text",
				"status": "completed",
				"ui": {}
			},
			"job_title": {
				"value": "Product Intranet Manager",
                "type": "string",
				"format": "text",
				"status": "completed",
				"ui": {}
			}
		}
	]
}
```
```

--------------------------------

### Run Search (Synchronous)

Source: https://pipe0.com/docs/searches

Executes a search task and attempts to return the completed results in a single round-trip. This is useful for immediate result retrieval.

```APIDOC
## POST /v1/searches/run/sync

### Description
Executes a search task and attempts to return the completed results in a single round-trip. Use the same payload as the asynchronous `/v1/searches/run` endpoint.

### Method
POST

### Endpoint
/v1/searches/run/sync

### Parameters
#### Request Body
- **config** (object) - Required - Configuration for the search, including environment and deduplication strategy.
  - **environment** (string) - Required - The environment to run the search in (e.g., "production").
  - **dedup** (object) - Optional - Deduplication strategy.
    - **strategy** (string) - Required - The deduplication strategy (e.g., "default").
- **searches** (array) - Required - An array of search objects to execute.
  - **search_id** (string) - Required - The ID of the search dataset (e.g., "people:profiles:icypeas@1").
  - **config** (object) - Optional - Configuration for the specific search.
    - **limit** (integer) - Optional - The maximum number of results to return.
    - **filters** (object) - Optional - Filters to apply to the search.
      - **industry** (object) - Optional - Filter by industry.
        - **include** (array) - Optional - List of industries to include.

### Request Example
```json
{
    "config": {
        "environment": "production",
        "dedup": {
            "strategy": "default"
        }
    },
    "searches": [
        {
            "search_id": "people:profiles:icypeas@1",
            "config": {
                "limit": 100,
                "filters": {
                    "industry": {
                        "include": ["Software Development"]
                    }
                }
            }
        }
    ]
}
```

### Response
#### Success Response (200)
- **results** (array) - An array of search result objects. The structure of each object depends on the dataset searched.
  - **name** (object) - Information about the name found.
    - **value** (string) - The name value.
    - **type** (string) - The data type.
    - **format** (string) - The data format.
    - **status** (string) - The status of this field (e.g., "completed").
    - **ui** (object) - UI specific information.
  - **job_title** (object) - Information about the job title found.
    - **value** (string) - The job title value.
    - **type** (string) - The data type.
    - **format** (string) - The data format.
    - **status** (string) - The status of this field (e.g., "completed").
    - **ui** (object) - UI specific information.

#### Response Example
```json
{
	"results": [
		{
			"name": {
				"value": "Gayle Pouros",
                "type": "string",
				"format": "text",
				"status": "completed",
				"ui": {}
			},
			"job_title": {
				"value": "Product Intranet Manager",
                "type": "string",
				"format": "text",
				"status": "completed",
				"ui": {}
			}
		}
	]
}
```
```

--------------------------------

### Run Pipe Enrichment Request (TypeScript)

Source: https://pipe0.com/docs/pipes

Makes a POST request to the Pipe0 API to enrich input objects using a specified pipe. It requires an API key for authentication and returns enriched data.

```typescript
const result = await fetch("https://api.pipe0.com/v1/pipes/run", {
    method: "POST",
    headers: {
        "Authorization": `Bearer ${API_KEY}`,
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        config: {
            environemnt: "production",
        },
        pipes: [
        {
            pipe_id: "people:workemail:waterfall@1"
        },
        ],
        input: [
            {
                id: 1,
                name: "John Doe",
                company_website_url: "https://pipe0.com"
            }
        ]
    })
});
```

--------------------------------

### POST /v1/pipes/run

Source: https://pipe0.com/docs/pipes/pipes-response-object

Initiates the asynchronous execution of a pipeline. This endpoint is used to start a processing task that will be completed in the background.

```APIDOC
## POST /v1/pipes/run

### Description
Starts an asynchronous pipeline execution.

### Method
POST

### Endpoint
https://api.pipe0.com/v1/pipes/run

### Parameters
#### Query Parameters
None

#### Request Body
(Details about the expected request body structure would go here, e.g., input data, pipeline configuration)

### Request Example
```json
{
  "input": [
    {"id": 1, "data": "example data 1"},
    {"id": 2, "data": "example data 2"}
  ],
  "config": {
    "some_setting": "value"
  }
}
```

### Response
#### Success Response (200)
Returns a response object containing task details and metadata.

- **id** (string) - The unique identifier for the processing task.
- **status** (string) - The current status of the task (e.g., 'pending', 'processing', 'completed', 'failed').
- **order** (array) - An ordered list of input data IDs, preserving the original input order.
- **field_definitions** (object) - Metadata for all fields in the pipeline.
- **errors** (array) - Global task errors, if any.
- **records** (array) - Processed data records.

#### Response Example
```json
{
  "id": "task_abc123",
  "status": "pending",
  "order": [1, 2],
  "field_definitions": {
    "data": {
      "type": "string"
    }
  },
  "errors": [],
  "records": [
    {
      "id": 1,
      "fields": {
        "data": {
          "value": "example data 1",
          "status": "completed",
          "type": "string"
        }
      }
    },
    {
      "id": 2,
      "fields": {
        "data": {
          "value": "example data 2",
          "status": "completed",
          "type": "string"
        }
      }
    }
  ]
}
```
```

--------------------------------

### Example Trigger Configuration

Source: https://pipe0.com/docs/pipes/pipes-concepts

This JSON object demonstrates how to configure a trigger to run a specific pipe based on conditions. It includes the pipe ID, trigger action, and a set of conditions to evaluate.

```json
{
	"pipes": [
		{
			"pipe_id": "people:name:split@1",
			"trigger": {
				"action": "run",
				"when": {
					"logic": "and",
					"conditions": [
						{
							"field_name": "name",
							"property": "value",
							"operator": "contains",
							"value": "Tom"
						}
					]
				}
			}
		}
	],
  "input": [...] 
}
```

--------------------------------

### Run Search (Sync) Response - JSON

Source: https://pipe0.com/docs/v1_searches_run

Example of a successful synchronous search response in JSON format. It includes the status of the search, results for requested properties, and detailed statuses for individual searches, including metadata about providers.

```json
{
  "id": "string",
  "status": "completed",
  "results": [
    {
      "property1": {
        "value": "string",
        "status": "completed",
        "type": "string",
        "format": "json_object",
        "resolved_by": {
          "ref": "prompt:run@1",
          "environment": "production",
          "config_hash": "string",
          "input_hash": "string"
        },
        "widgets": {
          "display_value": {
            "label": "string"
          },
          "entity_logo": {
            "image_url": "http://example.com",
            "entity": "string"
          },
          "location_indicator": {
            "emoji": "string"
          },
          "avatar": {
            "image_url": "http://example.com",
            "name": "string"
          },
          "waterfall": {
            "attempted_providers": [
              {
                "provider": "pipe0"
              }
            ],
            "available_providers": [
              "pipe0"
            ],
            "successful_provider": "pipe0"
          },
          "icon": {
            "key": "linkedin"
          },
          "action_summary": {
            "result_status": "completed"
          },
          "sources": {
            "list": [
              {
                "source": "string",
                "description": "string",
                "url": "string"
              }
            ]
          },
          "confidence": {
            "numeric": 1
          }
        }
      },
      "property2": {
        "value": "string",
        "status": "completed",
        "type": "string",
        "format": "json_object",
        "resolved_by": {
          "ref": "prompt:run@1",
          "environment": "production",
          "config_hash": "string",
          "input_hash": "string"
        },
        "widgets": {
          "display_value": {
            "label": "string"
          },
          "entity_logo": {
            "image_url": "http://example.com",
            "entity": "string"
          },
          "location_indicator": {
            "emoji": "string"
          },
          "avatar": {
            "image_url": "http://example.com",
            "name": "string"
          },
          "waterfall": {
            "attempted_providers": [
              {
                "provider": "pipe0"
              }
            ],
            "available_providers": [
              "pipe0"
            ],
            "successful_provider": "pipe0"
          },
          "icon": {
            "key": "linkedin"
          },
          "action_summary": {
            "result_status": "completed"
          },
          "sources": {
            "list": [
              {
                "source": "string",
                "description": "string",
                "url": "string"
              }
            ]
          },
          "confidence": {
            "numeric": 1
          }
        }
      }
    }
  ],
  "search_statuses": [
    {
      "search": {
        "ref": "people:profiles:icypeas@1"
      },
      "status": "pending",
      "errors": [
        {
          "code": "string",
          "message": "string",
          "path": "string"
        }
      ],
      "meta": {
        "providers": {
          "clado": {
            "pagination": {
              "search_id": "string",
              "offset": 0
            }
          },
          "crustdata": {
            "pagination": {
              "cursor": "string"
            }
          }
        }
      }
    }
  ],
  "organizationId": "string"
}
```

--------------------------------

### POST /v1/pipes/run

Source: https://pipe0.com/docs/pipes/pipes-catalog/company:overview/2

This endpoint allows you to run a pipe to get company overview data. You need to provide either a company website URL or a company profile URL as input.

```APIDOC
## POST /v1/pipes/run

### Description
This endpoint allows you to run a pipe to get company overview data. You need to provide either a company website URL or a company profile URL as input.

### Method
POST

### Endpoint
https://api.pipe0.com/v1/pipes/run

### Parameters
#### Request Body
- **config** (object) - Required - Configuration for the pipe run.
  - **environment** (string) - Required - The environment to run the pipe in (e.g., "production").
- **pipes** (array) - Required - An array of pipes to run.
  - **pipe_id** (string) - Required - The ID of the pipe to run (e.g., "company:overview@2").
- **input** (array) - Required - An array of input objects for the pipe.
  - **id** (string) - Required - A unique identifier for the input.
  - **company_website_url** (string) - Required - The URL of the company's website. (At least one of company_website_url or company_profile_url is required).
  - **company_profile_url** (string) - Optional - The URL of the company's profile. (At least one of company_website_url or company_profile_url is required).

### Request Example
```json
{
  "config": {
    "environment": "production"
  },
  "pipes": [
    {
      "pipe_id": "company:overview@2"
    }
  ],
  "input": [
    {
      "id": "1",
      "company_website_url": "Pipe0"
    }
  ]
}
```

### Response
#### Success Response (200)
- **company_description** (string) - Description of the company.
- **company_industry** (string) - Industry the company operates in.
- **company_region** (string) - Region where the company is located.
- **estimated_revenue** (string) - Estimated revenue of the company.
- **founded_year** (string) - The year the company was founded.
- **headcount** (string) - The number of employees.
- **company_name** (string) - The name of the company.

#### Response Example
```json
{
  "company_description": "Example description",
  "company_industry": "Technology",
  "company_region": "USA",
  "estimated_revenue": "$10M - $50M",
  "founded_year": "2010",
  "headcount": "50-100",
  "company_name": "Example Corp"
}
```
```

--------------------------------

### POST /v1/pipes/run/sync

Source: https://pipe0.com/docs/examples/examples-workflows/signup-alerts

Executes a synchronous workflow defined by a sequence of pipes. This endpoint is used to trigger complex data processing and notification pipelines, such as sending alerts for high-value user signups.

```APIDOC
## POST /v1/pipes/run/sync

### Description
Executes a synchronous workflow defined by a sequence of pipes. This endpoint is used to trigger complex data processing and notification pipelines, such as sending alerts for high-value user signups.

### Method
POST

### Endpoint
/v1/pipes/run/sync

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **config** (object) - Required - Configuration for the workflow execution, including the environment.
  - **environment** (string) - Required - The environment to run the workflow in (e.g., "production").
- **pipes** (array) - Required - An array of pipe configurations to be executed in sequence.
  - **pipe_id** (string) - Required - The unique identifier for the pipe.
  - **trigger** (object) - Optional - Defines the conditions under which the pipe should be triggered.
    - **action** (string) - Required - The action to perform (e.g., "run").
    - **when** (object) - Required - The conditions for triggering the pipe.
      - **logic** (string) - Required - The logical operator for combining conditions (e.g., "and", "or").
      - **conditions** (array) - Required - An array of condition objects.
        - **field_name** (string) - Required - The name of the field to evaluate.
        - **operator** (string) - Required - The comparison operator (e.g., "eq", "gt", "lt").
        - **property** (string) - Optional - The property of the field to use for comparison.
        - **value** (any) - Required - The value to compare against.
  - **config** (object) - Optional - Configuration specific to the pipe, such as prompt templates.
    - **prompt** (object) - Optional - Configuration for prompt-based pipes.
      - **template** (string) - Required - The prompt template string, potentially using input variables.
- **input** (array) - Required - An array of input objects for the workflow.
  - **id** (number) - Required - The identifier for the input object.
  - **name** (string) - Required - The name associated with the input.
  - **email** (string) - Required - The email associated with the input.

### Request Example
```json
{
  "config": {
    "environment": "production"
  },
  "pipes": [
    { "pipe_id": "people:email:iswork@1" },
    {
      "pipe_id": "company:websiteurl:email@1",
      "trigger": {
        "action": "run",
        "when": {
          "logic": "and",
          "conditions": [
            {
              "field_name": "is_work_email",
              "operator": "eq",
              "property": "value",
              "value": true
            }
          ]
        }
      }
    },
    {
      "pipe_id": "company:overview@1"
    },
    {
      "pipe_id": "prompt:run@1",
      "config": {
        "prompt": {
          "template": "Your task is to determine if the user's current employer aligns with the ideal customer profile for our business, pipe0.\n\n[Business Description]\npipe0 is an enrichment framework designed to help businesses add features around data enrichment into their own software applications.\n\n[Ideal Customer Attributes]\n\nThe company either offers or is involved in developing products that can benefit from data enrichment.\n\nSuch companies often target use cases around: as AI agents, customer celationship management, applicant tracking, account research, investor intelligence, or\nworkflow automation.\n\nAlternatively, the user can be a go-to-market professional using workflow enrichment in their own workflows for automating \ngo-to-market workflows.\n\nThe user's employer should have a need for prospecting, lead generation, or sales intelligence tools.\n\n[Available Information]\nTo make your assessment, use the the following information:\nCompany description: {{ input company_description type=\"string\" }} \nCompany industry: {{ input company_industry type=\"string\" }}\nCompany headcount: {{ input headcount type=\"string\" }}\nEstimated revenue: {{ input estimated_revenue type=\"string\" }}\n\n[Output]\n{{ output is_icp_fit type=\"boolean\" description=\"A boolean flag indicating if the latest employer matches the ICP profile of the business. If no information is found or the user has no current employer, set to false.\" }} \n{{ output reason type=\"string\" description=\"An explanation of how you arrived at your conclusion.\" }}"
        }
      }
    },
    {
      "pipe_id": "message:write@1",
      "trigger": {
        "action": "run",
        "when": {
          "logic": "and",
          "conditions": [
            {
              "field_name": "is_icp_fit",
              "property": "value",
              "operator": "eq",
              "value": true
            }
          ]
        }
      },
      "config": {
        "prompt": {
          "template": "Notify the pipe0 team that a high value customer signed up to the platform.\n\nGive the team the following information:\nName of the user: {{ input name type=\"string\" }} \nCompany the user works for {{ input company_website_url type=\"string\" }}\nReason why it is a high value customer: {{ input reason type=\"string\" }}"
        }
      }
    },
    {
      "pipe_id": "message:send:slack@1",
      "connector": {
        "strategy": "first",
        "connections": [
          {
            "type": "vault",
            "connection": "<ADD_YOUR_CONNECTION>"
          }
        ]
      },
      "config": {
        "channel_id": "<ADD_SLACK_CHANNEL_ID>"
      }
    }
  ],
  "input": [
    {
      "id": 1,
      "name": "<NAME>",
      "email": "<EMAIL>"
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success status of the workflow execution.
- **results** (array) - An array containing the results of each executed pipe.

#### Response Example
```json
{
  "status": "success",
  "results": [
    { "pipe_id": "people:email:iswork@1", "output": { "is_work_email": true } },
    { "pipe_id": "company:websiteurl:email@1", "output": { "company_website_url": "example.com" } },
    { "pipe_id": "company:overview@1", "output": { "company_description": "A description of the company." } },
    { "pipe_id": "prompt:run@1", "output": { "is_icp_fit": true, "reason": "The company aligns with the ICP." } },
    { "pipe_id": "message:write@1", "output": { "message_sent": true } },
    { "pipe_id": "message:send:slack@1", "output": { "slack_message_id": "12345" } }
  ]
}
```
```

--------------------------------

### Reference Vault Connections

Source: https://pipe0.com/docs/connections

This example demonstrates how to reference a custom connection stored in Pipe0's Vault when running a pipe. The `connector` object specifies the strategy and the connection details.

```APIDOC
## POST /v1/pipes/run

### Description
Executes a pipe using specified connections, including custom connections stored in Vault.

### Method
POST

### Endpoint
/v1/pipes/run

### Parameters
#### Request Body
- **pipes** (array) - Required - An array of pipe objects to execute.
  - **pipe_id** (string) - Required - The ID of the pipe to run.
  - **connector** (object) - Optional - Defines the connections to use for the pipe.
    - **strategy** (string) - Required - The strategy for selecting connections (e.g., "first").
    - **connections** (array) - Required - A list of connection objects.
      - **type** (string) - Required - The type of connection (e.g., "vault").
      - **connection** (string) - Required - The ID of the connection in Vault.
- **input** (array) - Required - An array of input objects for the pipe.

### Request Example
```json
{
  "pipes": [
    {
      "pipe_id": "email:send:resend@1",
      "connector": {
        "strategy": "first",
        "connections": [
          {
            "type": "vault",
            "connection": "resend_abcd123"
          }
        ]
      }
    }
  ],
  "input": [
    {
      "id": "1",
      "email_subject": "Test email",
      "email_markdown": "Test email content.",
      "email": "receiver@pipe0.com"
    }
  ]
}
```

### Response
#### Success Response (200)
- **results** (array) - The results of the executed pipes.

#### Response Example
```json
{
  "results": [
    {
      "id": "1",
      "status": "success",
      "data": { ... }
    }
  ]
}
```
```

--------------------------------

### Check Task Status and Get Result

Source: https://pipe0.com/docs/searches

Polls the status of a search task using its task ID. Continues to return results once the task status is 'completed'.

```APIDOC
## GET /v1/searches/check/{task_id}

### Description
Polls the status of a search task. Continue polling until the task status is 'completed' to retrieve the search results.

### Method
GET

### Endpoint
/v1/searches/check/{task_id}

### Parameters
#### Path Parameters
- **task_id** (string) - Required - The ID of the search task to check.

### Response
#### Success Response (200)
- **results** (array) - An array of search result objects. The structure of each object depends on the dataset searched.
  - **name** (object) - Information about the name found.
    - **value** (string) - The name value.
    - **type** (string) - The data type.
    - **format** (string) - The data format.
    - **status** (string) - The status of this field (e.g., "completed").
    - **ui** (object) - UI specific information.
  - **job_title** (object) - Information about the job title found.
    - **value** (string) - The job title value.
    - **type** (string) - The data type.
    - **format** (string) - The data format.
    - **status** (string) - The status of this field (e.g., "completed").
    - **ui** (object) - UI specific information.

#### Response Example
```json
{
	"results": [
		{
			"name": {
				"value": "Gayle Pouros",
                "type": "string",
				"format": "text",
				"status": "completed",
				"ui": {}
			},
			"job_title": {
				"value": "Product Intranet Manager",
                "type": "string",
				"format": "text",
				"status": "completed",
				"ui": {}
			}
		}
	]
}
```
```

--------------------------------

### Run a Company Search Request (TypeScript)

Source: https://pipe0.com/docs/searches

This code snippet demonstrates how to make a POST request to the `/v1/searches/run` endpoint to find companies using the `people:profiles:icypeas@1` dataset with an industry filter. It requires an API key for authorization and a JSON payload specifying the search configuration and filters.

```typescript
const result = await fetch("https://api.pipe0.com/v1/searches/run", {
    method: "POST",
    headers: {
        "Authorization": `Bearer ${API_KEY}`,
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        config: {
            environment: "production",
            dedup: {
                strategy: "default"
            }
        },
        searches: [
            {
                search_id: "people:profiles:icypeas@1",
                config: {
                    limit: 100,
                    filters: {
                        industry: {
                            include: ["Software Development"]
                        }
                    }
                }
            },
        ],
    })
});
```

--------------------------------

### Check Search Task Status (TypeScript)

Source: https://pipe0.com/docs/searches

This code snippet shows how to poll the `/v1/searches/check/{task_id}` endpoint to get the status and results of a previously initiated search task. It requires the `taskId` obtained from the initial search request and the API key for authentication.

```typescript
const result = await fetch("https://api.pipe0.com/v1/searches/check/${taskId}", {
    method: "POST",
    headers: {
        "Authorization": `Bearer ${API_KEY}`
    }
});
```

--------------------------------

### Run a Company Search Request Synchronously (TypeScript)

Source: https://pipe0.com/docs/searches

This code snippet demonstrates how to make a POST request to the `/v1/searches/run/sync` endpoint to find companies and receive the completed result in a single round-trip. It uses the same payload structure as the asynchronous `/v1/searches/run` endpoint but avoids the need for polling.

```typescript
const result = await fetch("https://api.pipe0.com/v1/searches/run/sync", {
    method: "POST",
    headers: {
        "Authorization": `Bearer ${API_KEY}`,
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        config: {
            environment: "production",
            dedup: {
                strategy: "default"
            }
        },
        searches: [
            {
                search_id: "people:profiles:icypeas@1",
                config: {
                    limit: 100,
                    filters: {
                        industry: {
                            include: ["Software Development"]
                        }
                    }
                }
            },
        ],
    })
});
```

--------------------------------

### Check Searches Run - GET Request

Source: https://pipe0.com/docs/v1_pipes_run

This describes a GET request for checking searches that have been run. The response structure includes a 'status' field, typically indicating 'completed'. It also contains nested objects for 'property2', which mirrors the structure of the 'run pipes' request, including details about 'value', 'status', 'type', 'reason', 'claimed_by', 'resolved_by', and various 'widgets'.

```json
{
  "property2": {
    "value": "string",
    "status": "completed",
    "type": "string",
    "reason": {
      "code": "string",
      "summary": "string",
      "message": "string"
    },
    "claimed_by": {
      "ref": "prompt:run@1",
      "config_hash": "string"
    },
    "resolved_by": {
      "ref": "prompt:run@1",
      "environment": "production",
      "config_hash": "string",
      "input_hash": "string"
    },
    "widgets": {
      "display_value": {
        "label": "string"
      },
      "entity_logo": {
        "image_url": "http://example.com",
        "entity": "string"
      },
      "location_indicator": {
        "emoji": "string"
      },
      "avatar": {
        "image_url": "http://example.com",
        "name": "string"
      },
      "waterfall": {
        "attempted_providers": [
          {
            "provider": "pipe0"
          }
        ],
        "available_providers": [
          "pipe0"
        ],
        "successful_provider": "pipe0"
      },
      "icon": {
        "key": "linkedin"
      },
      "action_summary": {
        "result_status": "completed"
      },
      "sources": {
        "list": [
          {
            "source": "string",
            "description": "string",
            "url": "string"
          }
        ]
      },
      "confidence": {
        "numeric": 1
      }
    },
    "format": "json_object"
  },
  "status": "completed"
}
```

--------------------------------

### Run Pipe Enrichment Request Synchronously (TypeScript)

Source: https://pipe0.com/docs/pipes

Makes a POST request to the Pipe0 API's synchronous endpoint to enrich input objects and receive the result in a single round-trip. This is an alternative to the asynchronous `/run` endpoint.

```typescript
const result = await fetch("https://api.pipe0.com/v1/pipes/run/sync", {
    method: "POST",
    headers: {
        "Authorization": `Bearer ${API_KEY}`,
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        config: {
            environemnt: "production",
        },
        pipes: [
        {
            pipe_id: "people:workemail:waterfall@1"
        },
        ],
        input: [
            {
                id: 1,
                name: "John Doe",
                company_website_url: "https://pipe0.com"
            }
        ]
    })
});
```

--------------------------------

### GET /v1/pipes/check/{task_id}

Source: https://pipe0.com/docs/pipes/pipes-response-object

Checks the processing state of a previously submitted pipeline task using its unique task ID.

```APIDOC
## GET /v1/pipes/check/{task_id}

### Description
Checks the status and retrieves results for a specific pipeline task.

### Method
GET

### Endpoint
https://api.pipe0.com/v1/pipes/check/{task_id}

### Parameters
#### Path Parameters
- **task_id** (string) - Required - The unique identifier of the task to check.

#### Query Parameters
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
Returns the response object for the specified task ID, including its current status and results.

- **id** (string) - The unique identifier for the processing task.
- **status** (string) - The current status of the task (e.g., 'pending', 'processing', 'completed', 'failed').
- **order** (array) - An ordered list of input data IDs, preserving the original input order.
- **field_definitions** (object) - Metadata for all fields in the pipeline.
- **errors** (array) - Global task errors, if any.
- **records** (array) - Processed data records.

#### Response Example
```json
{
  "id": "task_abc123",
  "status": "completed",
  "order": [1, 2],
  "field_definitions": {
    "data": {
      "type": "string"
    }
  },
  "errors": [],
  "records": [
    {
      "id": 1,
      "fields": {
        "data": {
          "value": "processed data 1",
          "status": "completed",
          "type": "string"
        }
      }
    },
    {
      "id": 2,
      "fields": {
        "data": {
          "value": "processed data 2",
          "status": "completed",
          "type": "string"
        }
      }
    }
  ]
}
```
```

--------------------------------

### GET /v1/pipes/check/{run_id}

Source: https://pipe0.com/docs/v1_pipes_check_run_id

Check the status of an enrichment task. Poll this endpoint until the status becomes 'completed'. Recommended polling intervals are between 1-3 seconds.

```APIDOC
## GET /v1/pipes/check/{run_id}

### Description
Check the status of an enrichment task. Poll this endpoint until the status becomes 'completed'. Recommended polling intervals are between 1-3 seconds.

### Method
GET

### Endpoint
https://api.pipe0.com/v1/pipes/check/{run_id}

### Parameters
#### Path Parameters
- **run_id** (string) - Required - The ID of the run to check.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - The current status of the enrichment task.
- **result** (object) - The result of the enrichment task if completed.

#### Error Response (400, 401, 403)
- **error** (string) - A message describing the error.

#### Response Example
```json
{
  "status": "completed",
  "result": {
    "data": "some data"
  }
}
```
```
Tokens:
Raw