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

# clients

# `prefect.server.api.clients`

## Classes

### `BaseClient` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L30](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L30)</sup>

### `OrchestrationClient` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L66](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L66)</sup>

**Methods:**

#### `create_flow_run` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L85)</sup>

```python theme={null}
create_flow_run(self, deployment_id: UUID, flow_run_create: DeploymentFlowRunCreate) -> Response
```

#### `delete_flow_run` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L96](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L96)</sup>

```python theme={null}
delete_flow_run(self, flow_run_id: UUID) -> Response
```

#### `pause_deployment` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L109](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L109)</sup>

```python theme={null}
pause_deployment(self, deployment_id: UUID) -> Response
```

#### `pause_work_pool` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L130](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L130)</sup>

```python theme={null}
pause_work_pool(self, work_pool_name: str) -> Response
```

#### `pause_work_queue` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L159](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L159)</sup>

```python theme={null}
pause_work_queue(self, work_queue_id: UUID) -> Response
```

#### `read_block_document_raw` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L171](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L171)</sup>

```python theme={null}
read_block_document_raw(self, block_document_id: UUID, include_secrets: bool = True) -> Response
```

#### `read_concurrency_limit_v2_raw` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L221](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L221)</sup>

```python theme={null}
read_concurrency_limit_v2_raw(self, concurrency_limit_id: UUID) -> Response
```

#### `read_deployment` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L70)</sup>

```python theme={null}
read_deployment(self, deployment_id: UUID) -> Optional[DeploymentResponse]
```

#### `read_deployment_raw` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L67](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L67)</sup>

```python theme={null}
read_deployment_raw(self, deployment_id: UUID) -> Response
```

#### `read_flow_raw` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L82](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L82)</sup>

```python theme={null}
read_flow_raw(self, flow_id: UUID) -> Response
```

#### `read_flow_run_raw` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L93](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L93)</sup>

```python theme={null}
read_flow_run_raw(self, flow_run_id: UUID) -> Response
```

#### `read_task_run_raw` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L99](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L99)</sup>

```python theme={null}
read_task_run_raw(self, task_run_id: UUID) -> Response
```

#### `read_work_pool` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L146](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L146)</sup>

```python theme={null}
read_work_pool(self, work_pool_id: UUID) -> Optional[WorkPool]
```

#### `read_work_pool_raw` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L140](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L140)</sup>

```python theme={null}
read_work_pool_raw(self, work_pool_id: UUID) -> Response
```

#### `read_work_queue_raw` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L153](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L153)</sup>

```python theme={null}
read_work_queue_raw(self, work_queue_id: UUID) -> Response
```

#### `read_work_queue_status_raw` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L156](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L156)</sup>

```python theme={null}
read_work_queue_status_raw(self, work_queue_id: UUID) -> Response
```

#### `read_workspace_variables` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L184](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L184)</sup>

```python theme={null}
read_workspace_variables(self, names: Optional[List[str]] = None) -> Dict[str, StrictVariableValue]
```

#### `request` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/orchestration/base.py#L22](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/orchestration/base.py#L22)</sup>

```python theme={null}
request(self, method: HTTP_METHODS, path: 'ServerRoutes', params: dict[str, Any] | None = None, path_params: dict[str, Any] | None = None, **kwargs: Any) -> 'Response'
```

#### `resume_deployment` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L114](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L114)</sup>

```python theme={null}
resume_deployment(self, deployment_id: UUID) -> Response
```

#### `resume_flow_run` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L102](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L102)</sup>

```python theme={null}
resume_flow_run(self, flow_run_id: UUID) -> OrchestrationResult
```

#### `resume_work_pool` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L135](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L135)</sup>

```python theme={null}
resume_work_pool(self, work_pool_name: str) -> Response
```

#### `resume_work_queue` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L165](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L165)</sup>

```python theme={null}
resume_work_queue(self, work_queue_id: UUID) -> Response
```

#### `set_flow_run_state` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L119](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L119)</sup>

```python theme={null}
set_flow_run_state(self, flow_run_id: UUID, state: StateCreate, force: bool = False) -> Response
```

### `WorkPoolsOrchestrationClient` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L229](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L229)</sup>

**Methods:**

#### `read_work_pool` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L233](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/clients.py#L233)</sup>

```python theme={null}
read_work_pool(self, work_pool_name: str) -> WorkPool
```

Reads information for a given work pool
Args:
work\_pool\_name: The name of the work pool to for which to get
information.
Returns:
Information about the requested work pool.

#### `request` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/orchestration/base.py#L22](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/orchestration/base.py#L22)</sup>

```python theme={null}
request(self, method: HTTP_METHODS, path: 'ServerRoutes', params: dict[str, Any] | None = None, path_params: dict[str, Any] | None = None, **kwargs: Any) -> 'Response'
```