Skip to the content

Read a Process instance

GET /v1/processes/{process_id}

Property	Value
Operation	`get_process`
Group	Processes
Scope	`processes:read`
Scopes of `include` values	`content` needs `processes:content`
Route class	`read`
Idempotency	No `Idempotency-Key`
Audit	An audited content read `processes.process.read`, when the request names an `include` value
Released in	1.62.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Answers an instance (1.62.0); its inputs, variables and outputs only when the read names include=content, which needs processes:content and is an audited content read.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the processes:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/processes/prc_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/processes/prc_...`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/processes/prc_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`process_id`	path	ProcessInstanceId	yes	The id of a Process instance: `prc_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`include`	query	array of ProcessInclude	no	`content` adds the content (`processes:content`).

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	ProcessInstance
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`
`404`	`application/json`	ErrorEnvelope	`not_found`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is ProcessInstance.

Field	Type	Required	Description
`compliance_profile_version`	integer or null	yes	The Compliance profile version pinned at the start (section 10, rule 3).
`correlated`	boolean	yes	True when the instance has a correlation key, which Process events match on; the key is kept as a keyed hash and never answered.
`current_nodes`	array of WorkflowNodeId	yes	The nodes the instance is at; empty once it ended.
`ended_at`	Timestamp or null	yes
`environment`	Environment	yes
`error_code`	string or null	yes	Why a `failed` instance failed, such as `max_steps_reached`, `max_lifetime_reached` or the failure code of the node that ended it `failed`; null otherwise.
`id`	ProcessInstanceId	yes
`inputs`	object or null	yes	The start inputs. Content; null unless the read names `include=content`.
`interpreter_version`	string	yes	The version of Vocal's interpreter the instance pinned at its start, kept by the runner until the instance ends.
`object`	`"process"`	yes
`organization_id`	OrganizationId	yes
`outputs`	object or null	yes	The declared outputs, once the instance ended on an `end` node. Content; null unless the read names `include=content`.
`project_id`	ProjectId or null	yes	The instance's Project: the default Project until Projects ship.
`started_at`	Timestamp	yes
`started_by`	ProcessStartedBy	yes
`status`	ProcessInstanceStatus	yes
`updated_at`	Timestamp	yes
`vars`	object or null	yes	The working data. Content; null unless the read names `include=content`.
`waiting_on`	ProcessWaitingOn or null	yes
`wake_at`	Timestamp or null	yes	The next timer of a waiting instance, mirrored from the runner; null when none.
`workflow_id`	WorkflowId	yes
`workflow_version`	integer	yes	The process-scope Workflow version the instance runs to its end (section 10).