> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.cloudraker.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server. # Start a processing pipeline POST https://api.cloudraker.com/process Content-Type: multipart/form-data Multipart upload of one or more files plus a JSON `options` part (declared files, actions, webhook URL, TTL). Files are sent as repeated parts named `files` (matched to `options.files[].field` by filename; undeclared ones get default processing), or — outside the generated SDKs — as one part per `options.files[].field`. The platform parses the files, runs the requested actions, emits signed webhooks, and holds the result until the TTL expires. Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/process/start-process ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: CloudRaker API version: 1.0.0 paths: /process: post: operationId: start-process summary: Start a processing pipeline description: >- Multipart upload of one or more files plus a JSON `options` part (declared files, actions, webhook URL, TTL). Files are sent as repeated parts named `files` (matched to `options.files[].field` by filename; undeclared ones get default processing), or — outside the generated SDKs — as one part per `options.files[].field`. The platform parses the files, runs the requested actions, emits signed webhooks, and holds the result until the TTL expires. tags: - process parameters: - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '201': description: Pipeline accepted. content: application/json: schema: $ref: '#/components/schemas/CreateProcessResponse' '400': description: Malformed multipart body or options. content: application/json: schema: description: Any type '403': description: Caller is neither an org admin nor an org API key. content: application/json: schema: description: Any type requestBody: content: multipart/form-data: schema: type: object properties: options: $ref: >- #/components/schemas/ProcessPostRequestBodyContentMultipartFormDataSchemaOptions description: The JSON-encoded `options` multipart part. files: type: array items: type: string format: binary description: >- The files to process, one multipart part each (part name `files`). required: - options - files servers: - url: https://api.cloudraker.com description: Production - url: https://api.staging.raker.one description: Staging - url: https://api.dev.raker.one description: Development components: schemas: ProcessPostRequestBodyContentMultipartFormDataSchemaOptionsFilesItemsProcessingKind: type: string enum: - doc-simple - doc-ocr - doc-auto - audio-transcribe - audio-transcribe-and-diarize description: How to preprocess this file; omitted = automatic by mime type. title: >- ProcessPostRequestBodyContentMultipartFormDataSchemaOptionsFilesItemsProcessingKind ProcessPostRequestBodyContentMultipartFormDataSchemaOptionsFilesItems: type: object properties: field: type: string description: >- Multipart part name of the file (named-part layout), or its filename when the file is sent as a repeated `files` part. processingKind: $ref: >- #/components/schemas/ProcessPostRequestBodyContentMultipartFormDataSchemaOptionsFilesItemsProcessingKind description: How to preprocess this file; omitted = automatic by mime type. required: - field title: ProcessPostRequestBodyContentMultipartFormDataSchemaOptionsFilesItems ProcessPostRequestBodyContentMultipartFormDataSchemaOptions: type: object properties: files: type: array items: $ref: >- #/components/schemas/ProcessPostRequestBodyContentMultipartFormDataSchemaOptionsFilesItems description: >- Per-file processing declarations. Optional when every file is sent as a repeated `files` part and default processing is fine. actions: type: array items: type: string description: Installed-action slugs (or ids) to run once preprocessing completes. callbackUrl: type: string format: uri description: >- Webhook URL. Deliveries are signed: `x-rk1-signature` is a compact ES256 JWT (claims processingId, eventId, type, bodySha256) verifiable against GET /process/jwks.json. durationSeconds: type: integer description: >- Retention TTL in seconds before auto-purge. Default 86400 (24h), max 604800 (7d). description: The JSON-encoded `options` multipart part. title: ProcessPostRequestBodyContentMultipartFormDataSchemaOptions CreateProcessResponse: type: object properties: processingId: type: string expiresAt: type: string format: date-time statusUrl: type: string required: - processingId - expiresAt - statusUrl title: CreateProcessResponse securitySchemes: bearerAuth: type: http scheme: bearer ``` ## Examples **Request** ```json { "options": {}, "files": [ "" ] } ``` **Response** ```json { "processingId": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "expiresAt": "2024-01-15T09:30:00Z", "statusUrl": "/process/f47ac10b-58cc-4372-a567-0e02b2c3d479" } ``` **SDK Code** ```python import requests url = "https://api.cloudraker.com/process" files = { "files": "open('invoice_2024-06-01.pdf', 'rb')" } payload = { "options": "{}" } headers = {"Authorization": "Bearer "} response = requests.post(url, data=payload, files=files, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.cloudraker.com/process'; const form = new FormData(); form.append('options', '{}'); form.append('files', 'invoice_2024-06-01.pdf'); const options = {method: 'POST', headers: {Authorization: 'Bearer '}}; options.body = form; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.cloudraker.com/process" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"options\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"invoice_2024-06-01.pdf\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001--\r\n") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.cloudraker.com/process") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"options\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"invoice_2024-06-01.pdf\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001--\r\n" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.cloudraker.com/process") .header("Authorization", "Bearer ") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"options\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"invoice_2024-06-01.pdf\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://api.cloudraker.com/process', [ 'multipart' => [ [ 'name' => 'options', 'contents' => '{}' ], [ 'name' => 'files', 'filename' => 'invoice_2024-06-01.pdf', 'contents' => null ] ] 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.cloudraker.com/process"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"options\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"invoice_2024-06-01.pdf\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let parameters = [ [ "name": "options", "value": "{}" ], [ "name": "files", "fileName": "invoice_2024-06-01.pdf" ] ] let boundary = "---011000010111000001101001" var body = "" var error: NSError? = nil for param in parameters { let paramName = param["name"]! body += "--\(boundary)\r\n" body += "Content-Disposition:form-data; name=\"\(paramName)\"" if let filename = param["fileName"] { let contentType = param["content-type"]! let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8) if (error != nil) { print(error as Any) } body += "; filename=\"\(filename)\"\r\n" body += "Content-Type: \(contentType)\r\n\r\n" body += fileContent } else if let paramValue = param["value"] { body += "\r\n\r\n\(paramValue)" } } let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/process")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```