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

# Start an action run in a space

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

Starts a new action run scoped to the space in the path. Requires `space:contribute` on that space (denied → 403). The space is taken from the path — a `spaceId` in the body never scopes the run. Body: `actionSlug` (installed action to run, required, non-empty), `fileIds` (1–100 file IDs from the space to feed the run, each non-empty), optional `params` (free-form object passed to the action). Returns 201 `{ data: ActionRun }`; the run starts in status `running` — poll `getRun` for `awaiting_input` / `done` / `failed` plus its `outputs` and `artifacts`.

Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/space-runs/create-run

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: CloudRaker API
  version: 1.0.0
paths:
  /spaces/{spaceId}/runs:
    post:
      operationId: create-run
      summary: Start an action run in a space
      description: >-
        Starts a new action run scoped to the space in the path. Requires
        `space:contribute` on that space (denied → 403). The space is taken from
        the path — a `spaceId` in the body never scopes the run. Body:
        `actionSlug` (installed action to run, required, non-empty), `fileIds`
        (1–100 file IDs from the space to feed the run, each non-empty),
        optional `params` (free-form object passed to the action). Returns 201
        `{ data: ActionRun }`; the run starts in status `running` — poll
        `getRun` for `awaiting_input` / `done` / `failed` plus its `outputs` and
        `artifacts`.
      tags:
        - spaceRuns
      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: The started run.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionRunEnvelope'
      requestBody:
        description: 'A `spaceId` in the body is ignored: the run is scoped by the path.'
        content:
          application/json:
            schema:
              type: object
              properties:
                actionSlug:
                  type: string
                  description: Installed action to run, by id or per-organization slug.
                fileIds:
                  type: array
                  items:
                    type: string
                  description: Files from this space to feed the run.
                params:
                  type: object
                  additionalProperties:
                    description: Any type
                  description: Per-run parameters for the action.
              required:
                - actionSlug
                - fileIds
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:
    ActionRunStatus:
      type: string
      enum:
        - running
        - awaiting_input
        - done
        - failed
      title: ActionRunStatus
    ActionRunArtifactsItemsOpen:
      type: string
      enum:
        - tab
        - embed
      title: ActionRunArtifactsItemsOpen
    ActionRunArtifactsItems:
      type: object
      properties:
        id:
          type: string
        kind:
          type: string
          enum:
            - link
        title:
          type: string
        url:
          type: string
        open:
          $ref: '#/components/schemas/ActionRunArtifactsItemsOpen'
      required:
        - id
        - kind
        - title
        - url
        - open
      title: ActionRunArtifactsItems
    ActionRunAwaitingInputItems:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        url:
          type: string
        resolved:
          type: boolean
      required:
        - id
        - title
        - url
        - resolved
      title: ActionRunAwaitingInputItems
    ActionRunDocumentsItems:
      type: object
      properties:
        fileId:
          type: string
        name:
          type: string
        contentType:
          type:
            - string
            - 'null'
      required:
        - fileId
        - name
        - contentType
      title: ActionRunDocumentsItems
    ActionRunOutputsItems:
      type: object
      properties:
        fileId:
          type: string
        kind:
          type: string
        key:
          type: string
        size:
          type: number
          format: double
      required:
        - fileId
        - kind
        - key
        - size
      title: ActionRunOutputsItems
    ActionRun:
      type: object
      properties:
        id:
          type: string
        spaceId:
          type: string
        actionSlug:
          type: string
        actionVersion:
          type: integer
        installedActionId:
          type: string
        playbookRunId:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/ActionRunStatus'
        error:
          type:
            - string
            - 'null'
        artifacts:
          type: array
          items:
            $ref: '#/components/schemas/ActionRunArtifactsItems'
          description: Rendered links. Redacted for callers without `space:contribute`.
        awaitingInput:
          type: array
          items:
            $ref: '#/components/schemas/ActionRunAwaitingInputItems'
          description: Open human steps while the run is `awaiting_input`.
        documents:
          type: array
          items:
            $ref: '#/components/schemas/ActionRunDocumentsItems'
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/ActionRunOutputsItems'
          description: Downloadable byproducts; stream each with the run-output route.
        timeoutSeconds:
          type: integer
        lastEventAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
        createdBy:
          type:
            - string
            - 'null'
        finishedAt:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - id
        - spaceId
        - actionSlug
        - actionVersion
        - installedActionId
        - playbookRunId
        - status
        - error
        - artifacts
        - awaitingInput
        - documents
        - outputs
        - timeoutSeconds
        - lastEventAt
        - createdAt
        - createdBy
        - finishedAt
      title: ActionRun
    ActionRunEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ActionRun'
      required:
        - data
      title: ActionRunEnvelope
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

## Examples



**Request**

```json
{
  "actionSlug": "contract-terms-extraction",
  "fileIds": [
    "file_9a8b7c6d5e4f3g2h1i0j"
  ]
}
```

**Response**

```json
{
  "data": {
    "id": "run_01J9K8L7M6N5O4P3Q2R1",
    "spaceId": "space_1234567890abcdef",
    "actionSlug": "contract-terms-extraction",
    "actionVersion": 3,
    "installedActionId": "action_9876543210fedcba",
    "playbookRunId": "playbook_1122334455aabbcc",
    "status": "running",
    "error": "",
    "artifacts": [
      {
        "id": "artifact_0011223344556677",
        "kind": "link",
        "title": "Extracted Contract Terms Summary",
        "url": "https://app.cloudraker.com/spaces/space_1234567890abcdef/artifacts/artifact_0011223344556677",
        "open": "tab"
      }
    ],
    "awaitingInput": [],
    "documents": [
      {
        "fileId": "file_9a8b7c6d5e4f3g2h1i0j",
        "name": "Contract_Agreement_2024.pdf",
        "contentType": "application/pdf"
      }
    ],
    "outputs": [
      {
        "fileId": "output_5566778899aabbcc",
        "kind": "json",
        "key": "extracted_terms.json",
        "size": 24567
      }
    ],
    "timeoutSeconds": 300,
    "lastEventAt": "2024-01-15T09:30:00Z",
    "createdAt": "2024-01-15T09:29:45Z",
    "createdBy": "user_42f1e3d7c9a8b6e5",
    "finishedAt": ""
  }
}
```

**SDK Code**

```python
import requests

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

payload = {
    "actionSlug": "contract-terms-extraction",
    "fileIds": ["file_9a8b7c6d5e4f3g2h1i0j"]
}
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/spaces/spaceId/runs';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"actionSlug":"contract-terms-extraction","fileIds":["file_9a8b7c6d5e4f3g2h1i0j"]}'
};

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/runs"

	payload := strings.NewReader("{\n  \"actionSlug\": \"contract-terms-extraction\",\n  \"fileIds\": [\n    \"file_9a8b7c6d5e4f3g2h1i0j\"\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/spaces/spaceId/runs")

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  \"actionSlug\": \"contract-terms-extraction\",\n  \"fileIds\": [\n    \"file_9a8b7c6d5e4f3g2h1i0j\"\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/spaces/spaceId/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actionSlug\": \"contract-terms-extraction\",\n  \"fileIds\": [\n    \"file_9a8b7c6d5e4f3g2h1i0j\"\n  ]\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.cloudraker.com/spaces/spaceId/runs', [
  'body' => '{
  "actionSlug": "contract-terms-extraction",
  "fileIds": [
    "file_9a8b7c6d5e4f3g2h1i0j"
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/spaces/spaceId/runs");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"actionSlug\": \"contract-terms-extraction\",\n  \"fileIds\": [\n    \"file_9a8b7c6d5e4f3g2h1i0j\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "actionSlug": "contract-terms-extraction",
  "fileIds": ["file_9a8b7c6d5e4f3g2h1i0j"]
] as [String : Any]

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

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