---
title: "Get the state of a process"
method: GET
path: "/api/v3/process/{id}/state"
tags: ["v16.7.2"]
---

# Get the state of a process

`GET /api/v3/process/{id}/state`

Get the state and progress data of a process.

## Path parameters

- `id` string, required

## Response `200`

OK

- ApiProcessState
  - `command` string[]
  - `cpu_usage` number
  - `exec` string
  - `last_logline` string
  - `memory_bytes` integer
  - `order` string
  - `progress` ApiProgress
    - `bitrate_kbit` number — kbit/s
    - `drop` integer
    - `dup` integer
    - `fps` number
    - `frame` integer
    - `inputs` ApiProgressIO[]
      - `address` string
      - `avstream` ApiAVstream
        - `aqueue` integer
        - `drop` integer
        - `dup` integer
        - `duplicating` boolean
        - `enc` integer
        - `gop` string
        - `input` ApiAVstreamIO
          - `packet` integer
          - `size_kb` integer
          - `state` 'running' | 'idle'
          - `time` integer
        - `looping` boolean
        - `looping_runtime` integer
        - `output` ApiAVstreamIO
          - `packet` integer
          - `size_kb` integer
          - `state` 'running' | 'idle'
          - `time` integer
        - `queue` integer
      - `bitrate_kbit` number — kbit/s
      - `channels` integer
      - `codec` string
      - `coder` string
      - `extradata_size_bytes` integer — bytes
      - `format` string
      - `fps` number
      - `frame` integer
      - `framerate` ApiProgressIOFramerate
        - `avg` number
        - `max` number
        - `min` number
      - `height` integer
      - `id` string
      - `index` integer — General
      - `keyframe` integer
      - `layout` string
      - `packet` integer
      - `pix_fmt` string — Video
      - `pps` number
      - `q` number
      - `sampling_hz` integer — Audio
      - `size_kb` integer — kbytes
      - `stream` integer
      - `type` string
      - `width` integer
    - `outputs` ApiProgressIO[]
      - `address` string
      - `avstream` ApiAVstream
        - `aqueue` integer
        - `drop` integer
        - `dup` integer
        - `duplicating` boolean
        - `enc` integer
        - `gop` string
        - `input` ApiAVstreamIO
          - `packet` integer
          - `size_kb` integer
          - `state` 'running' | 'idle'
          - `time` integer
        - `looping` boolean
        - `looping_runtime` integer
        - `output` ApiAVstreamIO
          - `packet` integer
          - `size_kb` integer
          - `state` 'running' | 'idle'
          - `time` integer
        - `queue` integer
      - `bitrate_kbit` number — kbit/s
      - `channels` integer
      - `codec` string
      - `coder` string
      - `extradata_size_bytes` integer — bytes
      - `format` string
      - `fps` number
      - `frame` integer
      - `framerate` ApiProgressIOFramerate
        - `avg` number
        - `max` number
        - `min` number
      - `height` integer
      - `id` string
      - `index` integer — General
      - `keyframe` integer
      - `layout` string
      - `packet` integer
      - `pix_fmt` string — Video
      - `pps` number
      - `q` number
      - `sampling_hz` integer — Audio
      - `size_kb` integer — kbytes
      - `stream` integer
      - `type` string
      - `width` integer
    - `packet` integer
    - `q` number
    - `size_kb` integer — kbytes
    - `speed` number
    - `time` number
  - `reconnect_seconds` integer
  - `runtime_seconds` integer

## Other responses

- `400` — Bad Request
- `404` — Not Found

## Changes

- **2022-10-13** `37e2216cc6a2` — 1 info
  - api tag `v16.7.2` added
- **2022-07-29** `44bcbc1544e1` — 1 info
  - api operation id `restream-3-get-state` removed and replaced with `process-3-get-state`
- **2022-05-13** `d0614126abfa` — 2 info
  - api operation id `process-3-get-state` removed and replaced with `restream-3-get-state`
  - api tag `v16.7.2` removed

[Change history](https://skmtc.dev/datarhei/apis/datarhei-core-api/changes/api/v3/process/:id/state/get.md)

---

[API](https://skmtc.dev/datarhei/apis/datarhei-core-api.md) · [All operations](https://skmtc.dev/datarhei/apis/datarhei-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/datarhei/datarhei-core-api/revisions/0197dcdcdd5a/schema)