---
title: "Start pipeline tap"
method: POST
path: "/pipeline/{pipeline_id}/tap/{component_id}"
tags: ["Sampling and Simulation"]
---

# Start pipeline tap

`POST /pipeline/{pipeline_id}/tap/{component_id}`

## Request

- Base URL: `https://api.mezmo.com/v3`
- URL: `https://api.mezmo.com/v3/pipeline/{pipeline_id}/tap/{component_id}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/mezmo/apis/pipeline-api/docs/pipeline/:pipeline_id/tap/:component_id/post.ts> (a function with typed inputs; its response is checked against the schema)

Start a tap operation to view data as it flows through the pipeline.

## Path parameters

- `pipeline_id` string, uuid, required
- `component_id` string, required

## Request body

- object
  - `limit` integer: The maximum number of events to return
  - `timeout` integer: The amount of time, in seconds, to wait for `limit` events to return before timing out
  - `edge_id` string: Specific edge_id instance to tap
  - `filter` unknown

## Response `200`

Default Response

---

[API](https://skmtc.dev/mezmo/apis/pipeline-api.md) - [All operations](https://skmtc.dev/mezmo/apis/pipeline-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mezmo/apis/pipeline-api/revisions/fb2535545d90?raw)