List the capabilities and their config schemas

GET

/v1/actions/catalog

GET

/v1/actions/catalog

$ curl https://api.cloudraker.com/v1/actions/catalog \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "object": "list",
3   "data": [
4     {
5       "capability": "extract",
6       "name": "Text Extraction",
7       "description": "Extract text content from documents and images using OCR and layout analysis.",
8       "slugs": [
9         "ocr",
10         "layout-analysis"
11       ],
12       "actions": [
13         {
14           "slug": "ocr",
15           "name": "Optical Character Recognition",
16           "description": "Extracts text from scanned documents and images.",
17           "configSchema": {
18             "language": {
19               "type": "string",
20               "enum": [
21                 "en",
22                 "es",
23                 "fr",
24                 "de",
25                 "zh"
26               ],
27               "description": "Language of the text to extract."
28             },
29             "detectOrientation": {
30               "type": "boolean",
31               "description": "Automatically detect and correct text orientation."
32             },
33             "outputFormat": {
34               "type": "string",
35               "enum": [
36                 "plain_text",
37                 "hocr",
38                 "pdf"
39               ],
40               "description": "Format of the extracted text output."
41             }
42           }
43         }
44       ]
45     },
46     {
47       "capability": "redact",
48       "name": "Content Redaction",
49       "description": "Redact sensitive information from documents or audio files.",
50       "slugs": [
51         "document-redact",
52         "audio-redact"
53       ],
54       "actions": [
55         {
56           "slug": "document-redact",
57           "name": "Document Redaction",
58           "description": "Redacts sensitive text and images from documents.",
59           "configSchema": {
60             "fieldsToRedact": {
61               "type": "array",
62               "items": {
63                 "type": "string"
64               },
65               "description": "List of field names or patterns to redact."
66             },
67             "redactionColor": {
68               "type": "string",
69               "description": "Hex color code used for redaction overlays.",
70               "pattern": "^#([A-Fa-f0-9]{6})$"
71             },
72             "mimeType": {
73               "type": "string",
74               "enum": [
75                 "application/pdf",
76                 "application/msword",
77                 "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
78               ],
79               "description": "MIME type of the document to determine redaction method."
80             }
81           }
82         },
83         {
84           "slug": "audio-redact",
85           "name": "Audio Redaction",
86           "description": "Redacts sensitive audio segments by muting or beeping.",
87           "configSchema": {
88             "keywords": {
89               "type": "array",
90               "items": {
91                 "type": "string"
92               },
93               "description": "List of keywords to detect and redact in audio."
94             },
95             "redactionMethod": {
96               "type": "string",
97               "enum": [
98                 "mute",
99                 "beep"
100               ],
101               "description": "Method used to redact detected audio segments."
102             },
103             "mimeType": {
104               "type": "string",
105               "enum": [
106                 "audio/wav",
107                 "audio/mpeg",
108                 "audio/mp4"
109               ],
110               "description": "MIME type of the audio file."
111             }
112           }
113         }
114       ]
115     },
116     {
117       "capability": "fill",
118       "name": "Form Filling",
119       "description": "Automatically fill forms and templates with provided data.",
120       "slugs": [
121         "pdf-fill",
122         "html-fill"
123       ],
124       "actions": [
125         {
126           "slug": "pdf-fill",
127           "name": "PDF Form Filling",
128           "description": "Fill PDF forms with key-value pairs.",
129           "configSchema": {
130             "fields": {
131               "type": "object",
132               "additionalProperties": {
133                 "type": "string"
134               },
135               "description": "Mapping of form field names to values."
136             },
137             "flatten": {
138               "type": "boolean",
139               "description": "Whether to flatten the PDF after filling."
140             }
141           }
142         }
143       ]
144     },
145     {
146       "capability": "sign",
147       "name": "Digital Signing",
148       "description": "Apply digital signatures to documents for authentication and integrity.",
149       "slugs": [
150         "pdf-sign"
151       ],
152       "actions": [
153         {
154           "slug": "pdf-sign",
155           "name": "PDF Digital Signature",
156           "description": "Digitally sign PDF documents with a certificate.",
157           "configSchema": {
158             "certificateId": {
159               "type": "string",
160               "description": "Identifier of the signing certificate."
161             },
162             "signatureReason": {
163               "type": "string",
164               "description": "Reason for signing the document."
165             },
166             "signatureLocation": {
167               "type": "string",
168               "description": "Location where the signature is applied."
169             },
170             "visible": {
171               "type": "boolean",
172               "description": "Whether the signature is visible on the document."
173             }
174           }
175         }
176       ]
177     }
178   ]
179 }

Discovery: every capability you can save an action for, and exactly what its config accepts.

Each entry lists the slugs behind a capability and the JSON Schema of each slug’s config — enough to build a form, validate input, or decide what to send to POST /v1/actions.

redact covers two variants, documents and audio, with different config shapes. Pass mimeType when saving a redaction action so the right one is chosen.

Learn more: Pipeline guide

Discovery: every capability you can save an action for, and exactly what its config accepts. Each entry lists the slugs behind a capability and the JSON Schema of each slug's `config` — enough to build a form, validate input, or decide what to send to [POST /v1/actions](https://docs.cloudraker.com/api/cloud-raker-api/actions/create-action). <Note> `redact` covers two variants, documents and audio, with different config shapes. Pass `mimeType` when saving a redaction action so the right one is chosen. </Note> **Learn more:** [Pipeline guide](https://docs.cloudraker.com/capabilities/pipeline)

Authentication

AuthorizationBearer

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

Response

The capabilities.

object"list"

datalist of objects

Errors

429

Too Many Requests Error