---
title: "execute an RPC of a workflow"
method: POST
path: "/api/v1/workflow/rpc"
---

# execute an RPC of a workflow

`POST /api/v1/workflow/rpc`

## Request body

- WorkflowRpcRequest
  - `workflowId` string, required
  - `workflowRunId` string
  - `rpcName` string, required
  - `input` EncodedObject
    - `extStoreId` string
    - `extPath` string
    - `encoding` string
    - `data` string
  - `searchAttributesLoadingPolicy` PersistenceLoadingPolicy
    - `persistenceLoadingType` 'LOAD_ALL_WITHOUT_LOCKING' | 'LOAD_PARTIAL_WITHOUT_LOCKING' | 'LOAD_PARTIAL_WITH_EXCLUSIVE_LOCK' | 'LOAD_NONE' | 'LOAD_ALL_WITH_PARTIAL_LOCK'
    - `partialLoadingKeys` string[]
    - `lockingKeys` string[]
    - `useKeyAsPrefix` boolean
    - `lazyLoadingLargeDataAttributes` boolean
  - `dataAttributesLoadingPolicy` PersistenceLoadingPolicy
    - `persistenceLoadingType` 'LOAD_ALL_WITHOUT_LOCKING' | 'LOAD_PARTIAL_WITHOUT_LOCKING' | 'LOAD_PARTIAL_WITH_EXCLUSIVE_LOCK' | 'LOAD_NONE' | 'LOAD_ALL_WITH_PARTIAL_LOCK'
    - `partialLoadingKeys` string[]
    - `lockingKeys` string[]
    - `useKeyAsPrefix` boolean
    - `lazyLoadingLargeDataAttributes` boolean
  - `timeoutSeconds` integer
  - `useMemoForDataAttributes` boolean
  - `searchAttributes` SearchAttributeKeyAndType[]
    - `key` string
    - `valueType` 'KEYWORD' | 'TEXT' | 'DATETIME' | 'INT' | 'DOUBLE' | 'BOOL' | 'KEYWORD_ARRAY'

## Response `200`

successful operation

- WorkflowRpcResponse
  - `output` EncodedObject
    - `extStoreId` string
    - `extPath` string
    - `encoding` string
    - `data` string

## Other responses

- `400` — Invalid input
- `420` — RPC execution error
- `450` — RPC acquire locking failure

---

[API](https://skmtc.net/indeedeng/apis/workflow-apis.md) · [All operations](https://skmtc.net/indeedeng/apis/workflow-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/indeedeng/workflow-apis/versions/fe9c7606824c/schema)