Skip to navigation

Save an action

Deprecated
View as Markdown

Saves a reusable, named configuration for a capability so calls stop repeating themselves.

Pass a saved action to any run as action: "<id or slug>". Inline config on the call is deep-merged over the saved config, and inline wins — so one saved action can be nudged per call without being redefined.

{
"capability": "extract",
"name": "W-9 basics",
"config": {
"schema": {
"type": "object",
"properties": {
"business_name": { "type": ["string", "null"] },
"tax_classification": { "type": ["string", "null"] }
}
}
}
}

Saved actions are also what governance, record-type binding and stable configuration under keep hang off. Check the catalog for the config schema of the capability you are saving.

Learn more: Pipeline guide

Deprecated: saved actions are becoming per-capability configs — use POST/GET/PATCH/DELETE /v1/{capability}/configs instead (/v1/extract/configs, /v1/redact/configs, /v1/fill/configs). Signing keeps using POST /v1/sign.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
capabilityenumRequired
namestringRequired1-200 characters
configmap from strings to anyOptional
mimeTypestringOptional>=1 character

Response

The saved action.
object"action"
idstring
slugstring
namestring
capabilityenum
configmap from strings to any

Errors

400
Bad Request Error
429
Too Many Requests Error