> 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 by URL, or get a presigned upload URL

POST https://api.cloudraker.com/v1/files
Content-Type: application/json

Adds a file to your reusable corpus, either by URL or by uploading the bytes yourself.

Two request shapes, both pure JSON — send one or the other, never both.

**By URL.** `{ url, name?, processing? }` registers the file and fetches it over http(s). The media type is sniffed from the response, so any `mimeType` you send is ignored. You get the file back with `status: "processing"`.

```json
{ "url": "https://www.irs.gov/pub/irs-pdf/fw9.pdf", "name": "fw9.pdf" }
```

**By upload.** `{ name, mimeType, processing? }` reserves the record and returns `uploadUrl` plus `uploadExpiresAt` (15 minutes). `PUT` the bytes to that URL with a `Content-Type` header exactly equal to the `mimeType` you sent; parsing starts the moment they land.

```json
{ "name": "recording.mp3", "mimeType": "audio/mpeg" }
```

**Parsing engine** — `processing` accepts `auto` (the default, self-upgrades to OCR on scans), `ocr`, `simple`, `transcribe` and `transcribe_diarize`. Audio and video default to `transcribe_diarize`.

<Note>
Files registered here are persistent — no TTL — and reusable across any number of runs as `file: { "id": "…" }`. That is what makes parse-once-run-many work: pass the same id to [extract](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/extract), [redact](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/redact) and [pipeline](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/pipeline) without re-parsing.
</Note>

**Learn more:** [Working with files](https://docs.cloudraker.com/developers/files)

Reference: https://docs.cloudraker.com/api/cloud-raker-api/files/create-file

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: CloudRaker API
  version: 1.0.0
paths:
  /v1/files:
    post:
      operationId: create-file
      summary: Register a file by URL, or get a presigned upload URL
      description: >-
        Adds a file to your reusable corpus, either by URL or by uploading the
        bytes yourself.


        Two request shapes, both pure JSON — send one or the other, never both.


        **By URL.** `{ url, name?, processing? }` registers the file and fetches
        it over http(s). The media type is sniffed from the response, so any
        `mimeType` you send is ignored. You get the file back with `status:
        "processing"`.


        ```json

        { "url": "https://www.irs.gov/pub/irs-pdf/fw9.pdf", "name": "fw9.pdf" }

        ```


        **By upload.** `{ name, mimeType, processing? }` reserves the record and
        returns `uploadUrl` plus `uploadExpiresAt` (15 minutes). `PUT` the bytes
        to that URL with a `Content-Type` header exactly equal to the `mimeType`
        you sent; parsing starts the moment they land.


        ```json

        { "name": "recording.mp3", "mimeType": "audio/mpeg" }

        ```


        **Parsing engine** — `processing` accepts `auto` (the default,
        self-upgrades to OCR on scans), `ocr`, `simple`, `transcribe` and
        `transcribe_diarize`. Audio and video default to `transcribe_diarize`.


        <Note>

        Files registered here are persistent — no TTL — and reusable across any
        number of runs as `file: { "id": "…" }`. That is what makes
        parse-once-run-many work: pass the same id to
        [extract](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/extract),
        [redact](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/redact)
        and
        [pipeline](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/pipeline)
        without re-parsing.

        </Note>


        **Learn more:** [Working with
        files](https://docs.cloudraker.com/developers/files)
      tags:
        - files
      parameters:
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '201':
          description: The registered file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1File'
        '422':
          description: The URL could not be fetched (`file_fetch_failed`).
          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/CreateFileRequestTooManyRequestsError'
        '502':
          description: The fetched bytes could not be stored (`file_upload_failed`).
          content:
            application/json:
              schema:
                description: Any type
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1CreateFileBody'
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:
    V1CreateFileBodyOneOf0Processing:
      type: string
      enum:
        - auto
        - ocr
        - simple
        - transcribe
        - transcribe_diarize
      title: V1CreateFileBodyOneOf0Processing
    V1CreateFileBody0:
      type: object
      properties:
        url:
          type: string
          format: uri
        name:
          type: string
        processing:
          $ref: '#/components/schemas/V1CreateFileBodyOneOf0Processing'
      required:
        - url
      title: V1CreateFileBody0
    V1CreateFileBodyOneOf1Processing:
      type: string
      enum:
        - auto
        - ocr
        - simple
        - transcribe
        - transcribe_diarize
      title: V1CreateFileBodyOneOf1Processing
    V1CreateFileBody1:
      type: object
      properties:
        name:
          type: string
        mimeType:
          type: string
        processing:
          $ref: '#/components/schemas/V1CreateFileBodyOneOf1Processing'
      required:
        - name
        - mimeType
      title: V1CreateFileBody1
    V1CreateFileBody:
      oneOf:
        - $ref: '#/components/schemas/V1CreateFileBody0'
        - $ref: '#/components/schemas/V1CreateFileBody1'
      title: V1CreateFileBody
    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
    V1FilesPostResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
        - rate_limited
      title: V1FilesPostResponsesContentApplicationJsonSchemaCode
    CreateFileRequestTooManyRequestsError:
      type: object
      properties:
        code:
          $ref: >-
            #/components/schemas/V1FilesPostResponsesContentApplicationJsonSchemaCode
        message:
          type: string
        retryable:
          type: boolean
        requestId:
          type: string
        docUrl:
          type: string
      required:
        - code
        - message
        - retryable
        - requestId
      title: CreateFileRequestTooManyRequestsError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

## Examples



**Request**

```json
{
  "url": "https://example.com/invoice.pdf"
}
```

**Response**

```json
{
  "object": "file",
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "name": "invoice.pdf",
  "mimeType": "application/pdf",
  "status": "processing",
  "createdAt": "2024-06-01T12:00:00Z",
  "error": "",
  "uploadUrl": "",
  "uploadExpiresAt": "",
  "urls": {
    "content": "https://cdn.example.com/files/f47ac10b-58cc-4372-a567-0e02b2c3d479/content.pdf",
    "markdown": "https://cdn.example.com/files/f47ac10b-58cc-4372-a567-0e02b2c3d479/content.md",
    "json": "https://cdn.example.com/files/f47ac10b-58cc-4372-a567-0e02b2c3d479/content.json"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/v1/files"

payload = { "url": "https://example.com/invoice.pdf" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/v1/files';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"url":"https://example.com/invoice.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/v1/files"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/invoice.pdf\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/invoice.pdf\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.cloudraker.com/v1/files")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/invoice.pdf\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.cloudraker.com/v1/files', [
  'body' => '{
  "url": "https://example.com/invoice.pdf"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/v1/files");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"url\": \"https://example.com/invoice.pdf\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["url": "https://example.com/invoice.pdf"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/v1/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()
```