Get a file

GET

/v1/files/:id

GET

/v1/files/:id

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

1 {
2   "object": "file",
3   "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
4   "name": "project-proposal.pdf",
5   "mimeType": "application/pdf",
6   "status": "ready",
7   "createdAt": "2024-06-10T09:15:30Z",
8   "error": null,
9   "uploadUrl": null,
10   "uploadExpiresAt": null,
11   "urls": {
12     "content": "https://signed.cloudraker.com/files/f47ac10b-58cc-4372-a567-0e02b2c3d479/content?signature=abc123&expires=1718200000",
13     "markdown": "https://signed.cloudraker.com/files/f47ac10b-58cc-4372-a567-0e02b2c3d479/markdown?signature=def456&expires=1718200000",
14     "json": "https://signed.cloudraker.com/files/f47ac10b-58cc-4372-a567-0e02b2c3d479/json?signature=ghi789&expires=1718200000"
15   }
16 }

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 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

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)

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired>=1 character

Response

The file.

object"file"

idstring

namestring

mimeTypestring

statusenum

createdAtstring

errorstring

uploadUrlstring

uploadExpiresAtstring

urlsobject

Errors

404

Not Found Error

429

Too Many Requests Error