---
title: "Create a new preview pipeline"
---

> Documentation Index
> Fetch the complete documentation index at: https://www.arroyo.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a new preview pipeline

Path: Arroyo REST API › pipelines

`POST /v1/pipelines/preview`

URL: `http://localhost:5115/api/v1/pipelines/preview`

## Request body

_Required._

- `query` (`create_preview_pipeline.query`; string, required)
- `enable_sinks` (`create_preview_pipeline.enable_sinks`; boolean, optional)
- `udfs` (`create_preview_pipeline.udfs`; array of object, optional, nullable)
  - `definition` (`create_preview_pipeline.udfs.definition`; string, required)
  - `language` (`create_preview_pipeline.udfs.language`; string, optional)
    - one of `"python"`, `"rust"`

## Example request

```json
{
  "enable_sinks": true,
  "query": "string",
  "udfs": [
    {
      "definition": "string",
      "language": "python"
    }
  ]
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url http://localhost:5115/api/v1/pipelines/preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "enable_sinks": true,
  "query": "string",
  "udfs": [
    {
      "definition": "string",
      "language": "python"
    }
  ]
}
'
```

### TypeScript

```typescript
const url = 'http://localhost:5115/api/v1/pipelines/preview';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    enable_sinks: true,
    query: 'string',
    udfs: [{definition: 'string', language: 'python'}]
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "http://localhost:5115/api/v1/pipelines/preview"

payload = {
    "enable_sinks": True,
    "query": "string",
    "udfs": [
        {
            "definition": "string",
            "language": "python"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Created pipeline and job

#### Example

```json
{
  "action": "none",
  "action_in_progress": true,
  "action_text": "string",
  "checkpoint_interval_micros": 0,
  "created_at": 0,
  "graph": {
    "edges": [
      {
        "dest_id": 0,
        "edge_type": "string",
        "key_type": "string",
        "src_id": 0,
        "value_type": "string"
      }
    ],
    "nodes": [
      {
        "description": "string",
        "node_id": 0,
        "operator": "string",
        "parallelism": 0
      }
    ]
  },
  "id": "string",
  "name": "string",
  "preview": true,
  "query": "string",
  "state_url": "string",
  "stop": "none",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "udfs": [
    {
      "definition": "string",
      "language": "python"
    }
  ]
}
```

- `action_in_progress` (`create_preview_pipeline.response.200.action_in_progress`; boolean, required)
- `action_text` (`create_preview_pipeline.response.200.action_text`; string, required)
- `checkpoint_interval_micros` (`create_preview_pipeline.response.200.checkpoint_interval_micros`; integer, required)
  - format: `int64` · minimum: `0`
- `created_at` (`create_preview_pipeline.response.200.created_at`; integer, required)
  - format: `int64` · minimum: `0`
- `graph` (`create_preview_pipeline.response.200.graph`; object, required)
  - `edges` (`create_preview_pipeline.response.200.graph.edges`; array of object, required)
    - `dest_id` (`create_preview_pipeline.response.200.graph.edges.dest_id`; integer, required)
      - format: `int32` · minimum: `0`
    - `edge_type` (`create_preview_pipeline.response.200.graph.edges.edge_type`; string, required)
    - `key_type` (`create_preview_pipeline.response.200.graph.edges.key_type`; string, required)
    - `src_id` (`create_preview_pipeline.response.200.graph.edges.src_id`; integer, required)
      - format: `int32` · minimum: `0`
    - `value_type` (`create_preview_pipeline.response.200.graph.edges.value_type`; string, required)
  - `nodes` (`create_preview_pipeline.response.200.graph.nodes`; array of object, required)
    - `description` (`create_preview_pipeline.response.200.graph.nodes.description`; string, required)
    - `node_id` (`create_preview_pipeline.response.200.graph.nodes.node_id`; integer, required)
      - format: `int32` · minimum: `0`
    - `operator` (`create_preview_pipeline.response.200.graph.nodes.operator`; string, required)
    - `parallelism` (`create_preview_pipeline.response.200.graph.nodes.parallelism`; integer, required)
      - format: `int32` · minimum: `0`
- `id` (`create_preview_pipeline.response.200.id`; string, required)
- `name` (`create_preview_pipeline.response.200.name`; string, required)
- `preview` (`create_preview_pipeline.response.200.preview`; boolean, required)
- `query` (`create_preview_pipeline.response.200.query`; string, required)
- `stop` (`create_preview_pipeline.response.200.stop`; string, required)
  - one of `"none"`, `"checkpoint"`, `"graceful"`, `"immediate"`, `"force"`
- `tags` (`create_preview_pipeline.response.200.tags`; map of string, required) — User-defined key/value tags associated with the pipeline.
- `udfs` (`create_preview_pipeline.response.200.udfs`; array of object, required)
  - `definition` (`create_preview_pipeline.response.200.udfs.definition`; string, required)
  - `language` (`create_preview_pipeline.response.200.udfs.language`; string, optional)
    - one of `"python"`, `"rust"`
- `action` (`create_preview_pipeline.response.200.action`; string, optional, nullable)
  - one of `"none"`, `"checkpoint"`, `"graceful"`, `"immediate"`, `"force"`
- `state_url` (`create_preview_pipeline.response.200.state_url`; string, optional, nullable) — Optional URL pointing to the state the pipeline was started from.

### 400

Bad request

#### Example

```json
{
  "error": "string"
}
```

- `error` (`create_preview_pipeline.response.400.error`; string, required)


Source: https://www.arroyo.dev/docs/api/create-preview-pipeline/index.md
