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

# Fill a form from source documents

POST https://api.cloudraker.com/v1/spaces/{spaceId}/fill
Content-Type: application/json

Drafts a form PDF's field values from the supplied source documents and returns the completed file.

**Pick the form** with `template`, either shape:

* `{ "id": "…" }` — a saved [template](https://docs.cloudraker.com/api/cloud-raker-api/templates/get-template), or any file you own.
* `{ "url": "…" }` — fetched fresh for this run and purged with it.

**Human review.** `review: "required"` parks the run in `needs_input` with one task per document instead of finishing it. From there you can read the drafted values at [GET /v1/runs/\{id}/task](https://docs.cloudraker.com/api/cloud-raker-api/runs/get-run-task), submit corrections to [POST /v1/runs/\{id}/task](https://docs.cloudraker.com/api/cloud-raker-api/runs/submit-run-task), or send a person to the ready-made page at `tasks[].url`.

**Shape the output** with `output`: `flattened` (default) bakes the values in, `editable` leaves the form fillable.

```json
{
  "files": [{ "id": "a04d6597-4e34-4a99-94ea-964c289a4c68" }],
  "template": { "id": "23e0a865-0be9-45b1-a491-f1b6bd58a31a" },
  "review": "required"
}
```

### Waiting for the result

Sync by default: the call holds open until the run finishes, up to `?wait=` seconds (default `60`, max `120`, `0` returns immediately).

| Outcome                    | Response                                                 |
| -------------------------- | -------------------------------------------------------- |
| Finished inside the window | `200` with the full run                                  |
| Still running at the cap   | `202` with `{object, id, status, statusUrl}`             |
| Parked for a human         | `202` right away, `status: "needs_input"` plus `tasks[]` |

The `202` is a graceful degrade, never an error — poll [the run](https://docs.cloudraker.com/api/cloud-raker-api/runs/get-run) or wait for a [webhook](https://docs.cloudraker.com/api/cloud-raker-api/webhooks/create-webhook-endpoint). Replaying an `idempotency-key` returns the original run alongside an `idempotent-replay: true` response header.

**Learn more:** [Form filling guide](https://docs.cloudraker.com/capabilities/fill)

Reference: https://docs.cloudraker.com/api/cloud-raker-api/spaces/space-fill

## Authentication

- `Authorization` header (bearer token, required)

## Request

### Path parameters

- `spaceId` (string, required)

### Query parameters

- `wait` (integer, optional, default: 60) — How many seconds to hold the request open waiting for the run to finish. Finishing inside the window returns `200` with the full run; running past it returns `202` with a `statusUrl` to poll. Send `0` to skip waiting entirely and always get the `202`.

### Body (application/json)

- `template` (object or object, required) — The blank form to fill, given one of two ways. * `{ "id": "…" }` — a saved template from `POST /v1/templates`, or any file you own. * `{ "url": "…", "name"?: "…" }` — fetched for this run only and purged with it.
  - object
    - `id` (string, required)
  - object
    - `url` (string, required)
    - `name` (string, optional)
- `files` (list of object or object, required)
  - object
    - `url` (string, required)
    - `name` (string, optional)
    - `processing` (enum, optional)
      - Allowed values: `auto`, `ocr`, `simple`, `transcribe`, `transcribe_diarize`
  - object
    - `id` (string, required)
- `instructions` (string, optional) — Free-form guidance for the drafting pass — which source document wins a conflict, how to format dates, which fields to leave blank.
- `review` (enum, optional) — Whether a person checks the drafted values before the form is produced. `none` (the default) fills and finishes. `required` parks the run at `needs_input` with one task per document — read it at `GET /v1/runs/{id}/task`, submit corrections to `POST /v1/runs/{id}/task`, or send someone to the ready-made page at `tasks[].url`.
  - Allowed values: `none`, `required`
- `output` (enum, optional) — What the produced PDF looks like. `flattened` (the default) bakes the values in so nothing can be changed; `editable` leaves the form fillable.
  - Allowed values: `flattened`, `editable`
- `action` (string, optional) — A saved fill action to run, by id or slug. Config you send inline is merged over the saved config.
- `metadata` (map from string to any, optional) — Arbitrary JSON you attach to the run and get back on every read of it. Use it to carry your own identifiers — an order number, a customer id — so a webhook or a polled run reconciles without a lookup table. Capped at 10 KB serialized.
- `webhook` (object or object, optional) — Where to deliver this run's events, given one of two ways. * `{ "url": "…" }` — a one-off https endpoint for this run only. * `{ "id": "whe_…" }` — a saved endpoint from `POST /v1/webhooks`. Runs hold the reference, so pausing or re-pointing that endpoint applies to this run too. Deliveries are at-least-once and signed — dedupe on `eventId` and verify against `GET /v1/webhooks/jwks.json`.
  - object
    - `url` (string, required)
  - object
    - `id` (string, required)
- `ttl` (integer, optional, default: 86400) — How long, in seconds, to keep this run and its files before purging them automatically. The maximum is 604800 (7 days). The deadline comes back as `expiresAt` on every read of the run. Call `POST /v1/runs/{id}/keep` before then to clear the TTL and move the results into a space permanently. E-signature runs are exempt — an envelope waits for its signers however long that takes.

## Response

### 200

The finished run.

- `object` ("fill_run", required)
- `id` (string, required)
- `status` (enum, required) — Where the run is in its life. | Status | Meaning | | --- | --- | | `queued` | Accepted, not started | | `processing` | Work in flight | | `needs_input` | Parked for a person — see `tasks[]` | | `processed` | Finished; `output` is populated | | `failed` | Finished unsuccessfully | | `cancelled` | Stopped on request | | `expired` | TTL elapsed and the data was purged | The last four are terminal.
  - Allowed values: `queued`, `processing`, `processed`, `failed`, `cancelled`, `expired`, `needs_input`
- `expiresAt` (string, required, nullable)
- `statusUrl` (string, required)
- `files` (list of object, required)
  - `id` (string, required)
  - `name` (string, required)
  - `status` (string, required)
  - `error` (string, optional)
- `file` (object, optional)
  - `id` (string, required)
  - `name` (string, required)
  - `status` (string, required)
  - `error` (string, optional)
- `error` (object, optional) — Why the run failed. Present whenever `status` is `failed`, and only then. `code` is the stable, snake_case reason (`input_unavailable`, `parse_failed`, …); `message` is the human-readable detail. Per-file and per-step failures are also reported in `files[].error` and, for a pipeline, `steps[].error`.
  - `code` (string, required)
  - `message` (string, required)
- `metadata` (map from string to any, optional)
- `tasks` (list of object, optional) — The human steps currently blocking the run. Present while `status` is `needs_input`. Each task has a `url` — a ready-made page you can send a person to — or you can drive it yourself through `GET` and `POST /v1/runs/{id}/task`. E-signature runs never carry `tasks[]`: their signing links are signer-held secrets, so use `envelopeUrl` instead.
  - `id` (string, required)
  - `title` (string, required)
  - `url` (string, required)
- `output` (object, optional) — The completed form. Present once `status` is `processed`. `file` is the filled PDF with a signed download link; `fields` reports the values that were written into it, keyed by field name.
  - `files` (list of object, required)
    - `id` (string, required)
    - `name` (string, required)
    - `url` (string, optional)
  - `file` (object, optional)
    - `id` (string, required)
    - `name` (string, required)
    - `url` (string, optional)
  - `fields` (map from string to any, optional)

### 202

Accepted — still running, or awaiting human input.

- `object` (string, required)
- `id` (string, required)
- `status` (enum, required) — Where the run is in its life. | Status | Meaning | | --- | --- | | `queued` | Accepted, not started | | `processing` | Work in flight | | `needs_input` | Parked for a person — see `tasks[]` | | `processed` | Finished; `output` is populated | | `failed` | Finished unsuccessfully | | `cancelled` | Stopped on request | | `expired` | TTL elapsed and the data was purged | The last four are terminal.
  - Allowed values: `queued`, `processing`, `processed`, `failed`, `cancelled`, `expired`, `needs_input`
- `statusUrl` (string, required)
- `envelopeUrl` (string, optional)
- `tasks` (list of object, optional)
  - `id` (string, required)
  - `title` (string, required)
  - `url` (string, required)

## Examples

### Example 1

**Request**

```json
{
  "template": {
    "id": "string"
  },
  "files": [
    {
      "url": "string"
    }
  ]
}
```

**Response**

```json
{
  "object": "string",
  "id": "string",
  "status": "queued",
  "expiresAt": "string",
  "statusUrl": "string",
  "files": [
    {
      "id": "string",
      "name": "string",
      "status": "string",
      "error": "string"
    }
  ],
  "file": {
    "id": "string",
    "name": "string",
    "status": "string",
    "error": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "metadata": {},
  "tasks": [
    {
      "id": "string",
      "title": "string",
      "url": "string"
    }
  ],
  "output": {
    "files": [
      {
        "id": "string",
        "name": "string",
        "url": "string"
      }
    ],
    "file": {
      "id": "string",
      "name": "string",
      "url": "string"
    },
    "fields": {}
  }
}
```

**SDK Code**

```typescript
import { CloudRakerClient } from "@cloudraker/api";

async function main() {
    const client = new CloudRakerClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.spaces.spaceFill({
        spaceId: "spaceId",
        body: {
            template: {
                id: "string",
            },
            files: [
                {
                    url: "string",
                },
            ],
        },
    });
}
main();

```

```python
from cloudraker import CloudRaker, V1FillBodyTemplateId, V1FillBodyFilesItemName

client = CloudRaker(
    token="YOUR_TOKEN_HERE",
)

client.spaces.space_fill(
    space_id="spaceId",
    template=V1FillBodyTemplateId(
        id="string",
    ),
    files=[
        V1FillBodyFilesItemName(
            url="string",
        )
    ],
)

```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudraker.com/v1/spaces/spaceId/fill"

	payload := strings.NewReader("{\n  \"template\": {\n    \"id\": \"string\"\n  },\n  \"files\": [\n    {\n      \"url\": \"string\"\n    }\n  ]\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/spaces/spaceId/fill")

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  \"template\": {\n    \"id\": \"string\"\n  },\n  \"files\": [\n    {\n      \"url\": \"string\"\n    }\n  ]\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/spaces/spaceId/fill")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"template\": {\n    \"id\": \"string\"\n  },\n  \"files\": [\n    {\n      \"url\": \"string\"\n    }\n  ]\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

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

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "template": ["id": "string"],
  "files": [["url": "string"]]
] as [String : Any]

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

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

### Example 2

**Request**

```json
{
  "template": {
    "id": "string"
  },
  "files": [
    {
      "url": "string"
    }
  ]
}
```

**Response**

```json
{
  "object": "string",
  "id": "string",
  "status": "queued",
  "expiresAt": "string",
  "statusUrl": "string",
  "files": [
    {
      "id": "string",
      "name": "string",
      "status": "string",
      "error": "string"
    }
  ],
  "file": {
    "id": "string",
    "name": "string",
    "status": "string",
    "error": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "metadata": {},
  "tasks": [
    {
      "id": "string",
      "title": "string",
      "url": "string"
    }
  ],
  "output": {
    "files": [
      {
        "id": "string",
        "name": "string",
        "url": "string"
      }
    ],
    "file": {
      "id": "string",
      "name": "string",
      "url": "string"
    },
    "fields": {}
  }
}
```

**SDK Code**

```typescript
import { CloudRakerClient } from "@cloudraker/api";

async function main() {
    const client = new CloudRakerClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.spaces.spaceFill({
        spaceId: "spaceId",
        body: {
            template: {
                id: "string",
            },
            files: [
                {
                    url: "string",
                },
            ],
        },
    });
}
main();

```

```python
from cloudraker import CloudRaker, V1FillBodyTemplateId, V1FillBodyFilesItemName

client = CloudRaker(
    token="YOUR_TOKEN_HERE",
)

client.spaces.space_fill(
    space_id="spaceId",
    template=V1FillBodyTemplateId(
        id="string",
    ),
    files=[
        V1FillBodyFilesItemName(
            url="string",
        )
    ],
)

```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudraker.com/v1/spaces/spaceId/fill"

	payload := strings.NewReader("{\n  \"template\": {\n    \"id\": \"string\"\n  },\n  \"files\": [\n    {\n      \"url\": \"string\"\n    }\n  ]\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/spaces/spaceId/fill")

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  \"template\": {\n    \"id\": \"string\"\n  },\n  \"files\": [\n    {\n      \"url\": \"string\"\n    }\n  ]\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/spaces/spaceId/fill")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"template\": {\n    \"id\": \"string\"\n  },\n  \"files\": [\n    {\n      \"url\": \"string\"\n    }\n  ]\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

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

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "template": ["id": "string"],
  "files": [["url": "string"]]
] as [String : Any]

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

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