> 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. # Get a file GET https://api.cloudraker.com/v1/files/{id} Returns a file's metadata and where it is in the pipeline. `status` walks `uploading` → `processing` → `ready`, or lands on `failed` with an `error`. Poll this route after [registering a file](https://docs.cloudraker.com/api/cloud-raker-api/files/create-file) until it reads `ready`. Once `ready`, `urls` carries signed links valid for about an hour: - `content` — the original bytes. - `markdown` and `json` — the parsed forms, present when the file was parsed. **Learn more:** [Working with files](https://docs.cloudraker.com/developers/files) Reference: https://docs.cloudraker.com/api/cloud-raker-api/files/get-file ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: CloudRaker API version: 1.0.0 paths: /v1/files/{id}: get: operationId: get-file summary: Get a file description: >- Returns a file's metadata and where it is in the pipeline. `status` walks `uploading` → `processing` → `ready`, or lands on `failed` with an `error`. Poll this route after [registering a file](https://docs.cloudraker.com/api/cloud-raker-api/files/create-file) until it reads `ready`. Once `ready`, `urls` carries signed links valid for about an hour: - `content` — the original bytes. - `markdown` and `json` — the parsed forms, present when the file was parsed. **Learn more:** [Working with files](https://docs.cloudraker.com/developers/files) tags: - files parameters: - name: id in: path required: true schema: type: string - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: The file. content: application/json: schema: $ref: '#/components/schemas/V1File' '404': description: Unknown file id (or a file outside the API workspace). content: application/json: schema: description: Any type '429': description: >- Rate limited. The `/v1` API allows at least **67 requests per minute per organization** (about 1,000 requests per 15 minutes) — a guaranteed floor, enforced per edge location, so a geographically spread caller may get more. Wait for the `Retry-After` interval and retry — the error is `retryable`. content: application/json: schema: $ref: '#/components/schemas/GetFileRequestTooManyRequestsError' 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: V1FileStatus: type: string enum: - uploading - processing - ready - failed title: V1FileStatus V1FileUrls: type: object properties: content: type: string markdown: type: string json: type: string title: V1FileUrls V1File: type: object properties: object: type: string enum: - file id: type: string name: type: string mimeType: type: string status: $ref: '#/components/schemas/V1FileStatus' createdAt: type: string error: type: string uploadUrl: type: string uploadExpiresAt: type: string urls: $ref: '#/components/schemas/V1FileUrls' required: - object - id - name - mimeType - status - createdAt title: V1File V1FilesIdGetResponsesContentApplicationJsonSchemaCode: type: string enum: - rate_limited title: V1FilesIdGetResponsesContentApplicationJsonSchemaCode GetFileRequestTooManyRequestsError: type: object properties: code: $ref: >- #/components/schemas/V1FilesIdGetResponsesContentApplicationJsonSchemaCode message: type: string retryable: type: boolean requestId: type: string docUrl: type: string required: - code - message - retryable - requestId title: GetFileRequestTooManyRequestsError securitySchemes: bearerAuth: type: http scheme: bearer ``` ## Examples **Request** ```json {} ``` **Response** ```json { "object": "file", "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "name": "project-proposal.pdf", "mimeType": "application/pdf", "status": "ready", "createdAt": "2024-06-10T09:15:30Z", "error": null, "uploadUrl": null, "uploadExpiresAt": null, "urls": { "content": "https://signed.cloudraker.com/files/f47ac10b-58cc-4372-a567-0e02b2c3d479/content?signature=abc123&expires=1718200000", "markdown": "https://signed.cloudraker.com/files/f47ac10b-58cc-4372-a567-0e02b2c3d479/markdown?signature=def456&expires=1718200000", "json": "https://signed.cloudraker.com/files/f47ac10b-58cc-4372-a567-0e02b2c3d479/json?signature=ghi789&expires=1718200000" } } ``` **SDK Code** ```python import requests url = "https://api.cloudraker.com/v1/files/id" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.cloudraker.com/v1/files/id'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; 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/v1/files/id" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", 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/v1/files/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.cloudraker.com/v1/files/id") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.cloudraker.com/v1/files/id', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.cloudraker.com/v1/files/id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/v1/files/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" 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() ```