> 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. # Register a file in a space and get a presigned upload URL POST https://api.cloudraker.com/spaces/{spaceId}/files Content-Type: application/json Reserves a file metadata record in the space and returns { id, uploadUrl, uploadExpiresAt, file }. `uploadUrl` is a secure PUT URL valid for 15 minutes (see `uploadExpiresAt`, ISO 8601). Two-step upload: PUT the raw file bytes to `uploadUrl` with a `Content-Type` request header EXACTLY equal to the `mimeType` you sent at create (a mismatch rejects the PUT), then poll `getFile` until `status` reaches a terminal value — `stored` (uploaded, no processing requested), `processed` (processing succeeded), or `failed` (see `processingError`); `waiting`/`processing` mean keep polling. Request body: `fileName` (required), `mimeType` (required, drives both the record and the required PUT Content-Type), `size` (bytes, optional), optional `processingKind` — one of doc-simple | doc-ocr | doc-auto | audio-transcribe | audio-transcribe-and-diarize — selecting how the stored file is post-processed; `indexVectors` and `indexOntology` (both default true) are opt-out booleans for semantic and ontology indexing. `parentType`/`parentId` in the body are ignored: the API forces the parent to this :spaceId. Authorization: requires `space:contribute` on :spaceId (missing permission → 403; org admins bypass). An invalid body returns 422. Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/space-files/create-space-file ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: CloudRaker API version: 1.0.0 paths: /spaces/{spaceId}/files: post: operationId: create-space-file summary: Register a file in a space and get a presigned upload URL description: >- Reserves a file metadata record in the space and returns { id, uploadUrl, uploadExpiresAt, file }. `uploadUrl` is a secure PUT URL valid for 15 minutes (see `uploadExpiresAt`, ISO 8601). Two-step upload: PUT the raw file bytes to `uploadUrl` with a `Content-Type` request header EXACTLY equal to the `mimeType` you sent at create (a mismatch rejects the PUT), then poll `getFile` until `status` reaches a terminal value — `stored` (uploaded, no processing requested), `processed` (processing succeeded), or `failed` (see `processingError`); `waiting`/`processing` mean keep polling. Request body: `fileName` (required), `mimeType` (required, drives both the record and the required PUT Content-Type), `size` (bytes, optional), optional `processingKind` — one of doc-simple | doc-ocr | doc-auto | audio-transcribe | audio-transcribe-and-diarize — selecting how the stored file is post-processed; `indexVectors` and `indexOntology` (both default true) are opt-out booleans for semantic and ontology indexing. `parentType`/`parentId` in the body are ignored: the API forces the parent to this :spaceId. Authorization: requires `space:contribute` on :spaceId (missing permission → 403; org admins bypass). An invalid body returns 422. tags: - spaceFiles parameters: - name: spaceId in: path required: true schema: type: string - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '201': description: File record created, with its presigned upload URL. content: application/json: schema: $ref: '#/components/schemas/CreatedFile' requestBody: description: >- `parentType` / `parentId` are ignored: the parent is forced server-side from the route. content: application/json: schema: type: object properties: fileName: type: string mimeType: type: string description: >- Drives both the record and the required upload `Content-Type`. size: type: integer description: Size in bytes. processingKind: $ref: >- #/components/schemas/SpacesSpaceIdFilesPostRequestBodyContentApplicationJsonSchemaProcessingKind description: >- How the stored file is post-processed. Omit for automatic selection by mime. indexVectors: type: boolean description: Semantic indexing. Defaults to true. indexOntology: type: boolean description: Knowledge-graph indexing. Defaults to true. required: - fileName - mimeType 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: SpacesSpaceIdFilesPostRequestBodyContentApplicationJsonSchemaProcessingKind: type: string enum: - doc-simple - doc-ocr - doc-auto - audio-transcribe - audio-transcribe-and-diarize description: >- How the stored file is post-processed. Omit for automatic selection by mime. title: >- SpacesSpaceIdFilesPostRequestBodyContentApplicationJsonSchemaProcessingKind FileDocStatus: type: string enum: - waiting - stored - processing - processed - failed description: >- Terminal values are `stored` (uploaded, no processing requested), `processed` and `failed`; `waiting` and `processing` mean keep polling. title: FileDocStatus FileDocProcessingKind: type: string enum: - doc-simple - doc-ocr - doc-auto - audio-transcribe - audio-transcribe-and-diarize title: FileDocProcessingKind FileDocUrls: type: object properties: file: type: string description: The stored original. processedJson: type: string description: Structured/grounded JSON. processedMd: type: string description: Extracted markdown. previewPdf: type: string description: >- Minted download links, each valid ~1 hour. Present on single-file reads only — list responses mint none. title: FileDocUrls FileDoc: type: object properties: id: type: string fileName: type: string parentType: type: string parentId: type: string mimeType: type: string size: type: - number - 'null' format: double description: Size in bytes, null until stored. status: $ref: '#/components/schemas/FileDocStatus' description: >- Terminal values are `stored` (uploaded, no processing requested), `processed` and `failed`; `waiting` and `processing` mean keep polling. processingKind: oneOf: - $ref: '#/components/schemas/FileDocProcessingKind' - type: 'null' processingError: type: string artifacts: type: array items: type: string description: Parsing byproducts present, e.g. `structured`, `transcript`. indexVectors: type: boolean indexOntology: type: boolean createdAt: type: string format: date-time storedAt: type: string format: date-time processedAt: type: string format: date-time urls: $ref: '#/components/schemas/FileDocUrls' description: >- Minted download links, each valid ~1 hour. Present on single-file reads only — list responses mint none. required: - id - fileName - parentType - parentId - mimeType - size - status - processingKind - createdAt title: FileDoc CreatedFile: type: object properties: id: type: string uploadUrl: type: string description: >- Presigned upload URL, valid 15 minutes. PUT the raw bytes there with a `Content-Type` header EXACTLY equal to the `mimeType` sent at create. uploadExpiresAt: type: string format: date-time file: $ref: '#/components/schemas/FileDoc' required: - id - uploadUrl - uploadExpiresAt - file title: CreatedFile securitySchemes: bearerAuth: type: http scheme: bearer ``` ## Examples **Request** ```json { "fileName": "invoice_2024_04.pdf", "mimeType": "application/pdf" } ``` **Response** ```json { "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "uploadUrl": "https://storage.cloudraker.com/upload/f47ac10b-58cc-4372-a567-0e02b2c3d479?signature=abc123xyz&expires=1710605400", "uploadExpiresAt": "2024-04-15T10:45:00Z", "file": { "id": "a1b2c3d4e5f6g7h8", "fileName": "invoice_2024_04.pdf", "parentType": "space", "parentId": "space_987654321", "mimeType": "application/pdf", "size": 254321, "status": "waiting", "processingKind": "doc-simple", "createdAt": "2024-04-15T10:30:00Z", "processingError": "", "artifacts": [ "structured" ], "indexVectors": true, "indexOntology": true, "storedAt": "", "processedAt": "", "urls": { "file": "", "processedJson": "", "processedMd": "", "previewPdf": "" } } } ``` **SDK Code** ```python import requests url = "https://api.cloudraker.com/spaces/spaceId/files" payload = { "fileName": "invoice_2024_04.pdf", "mimeType": "application/pdf" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.cloudraker.com/spaces/spaceId/files'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"fileName":"invoice_2024_04.pdf","mimeType":"application/pdf"}' }; 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/spaces/spaceId/files" payload := strings.NewReader("{\n \"fileName\": \"invoice_2024_04.pdf\",\n \"mimeType\": \"application/pdf\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") 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/spaces/spaceId/files") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"fileName\": \"invoice_2024_04.pdf\",\n \"mimeType\": \"application/pdf\"\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/spaces/spaceId/files") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"fileName\": \"invoice_2024_04.pdf\",\n \"mimeType\": \"application/pdf\"\n}") .asString(); ``` ```php request('POST', 'https://api.cloudraker.com/spaces/spaceId/files', [ 'body' => '{ "fileName": "invoice_2024_04.pdf", "mimeType": "application/pdf" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.cloudraker.com/spaces/spaceId/files"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"fileName\": \"invoice_2024_04.pdf\",\n \"mimeType\": \"application/pdf\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "fileName": "invoice_2024_04.pdf", "mimeType": "application/pdf" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/spaces/spaceId/files")! 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() ```