> 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. # Extract a file into the ontology (doc + space + org levels) POST https://api.cloudraker.com/spaces/{spaceId}/ontology/ingest Content-Type: application/json Extracts entities and relations from a file once and populates the document, space, and organization graph levels together. JSON body: `fileId` (required, non-empty). The file must belong to `:spaceId` or the request returns 404. Returns `{ fileId, results }`, one `IngestNamespaceResult` per graph level with `status` (ok | error) and the `entities`/`mentions`/`edges` counts written. Idempotent — re-ingesting creates or enhances the existing graphs. Requires `space:contribute` on `:spaceId`; lacking write permission is a 403 (a missing `space:read` prerequisite would be a 404). Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/ontology/ingest-file-ontology ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: CloudRaker API version: 1.0.0 paths: /spaces/{spaceId}/ontology/ingest: post: operationId: ingest-file-ontology summary: Extract a file into the ontology (doc + space + org levels) description: >- Extracts entities and relations from a file once and populates the document, space, and organization graph levels together. JSON body: `fileId` (required, non-empty). The file must belong to `:spaceId` or the request returns 404. Returns `{ fileId, results }`, one `IngestNamespaceResult` per graph level with `status` (ok | error) and the `entities`/`mentions`/`edges` counts written. Idempotent — re-ingesting creates or enhances the existing graphs. Requires `space:contribute` on `:spaceId`; lacking write permission is a 403 (a missing `space:read` prerequisite would be a 404). tags: - ontology parameters: - name: spaceId in: path required: true schema: type: string - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: Per-level ingestion results with the counts written. content: application/json: schema: $ref: '#/components/schemas/OntologyIngestResult' requestBody: content: application/json: schema: type: object properties: fileId: type: string required: - fileId 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: OntologyIngestResultResultsItemsStatus: type: string enum: - ok - error title: OntologyIngestResultResultsItemsStatus OntologyIngestResultResultsItems: type: object properties: namespace: type: string description: The graph level written. status: $ref: '#/components/schemas/OntologyIngestResultResultsItemsStatus' entities: type: integer mentions: type: integer edges: type: integer error: type: string required: - namespace - status - entities - mentions - edges title: OntologyIngestResultResultsItems OntologyIngestResult: type: object properties: fileId: type: string results: type: array items: $ref: '#/components/schemas/OntologyIngestResultResultsItems' required: - fileId - results title: OntologyIngestResult securitySchemes: bearerAuth: type: http scheme: bearer ``` ## Examples **Request** ```json { "fileId": "4f6f1c1e-1b2a-4d3c-9e8f-7a6b5c4d3e2f" } ``` **Response** ```json { "fileId": "4f6f1c1e-1b2a-4d3c-9e8f-7a6b5c4d3e2f", "results": [ { "namespace": "document", "status": "ok", "entities": 45, "mentions": 120, "edges": 75, "error": "" }, { "namespace": "space", "status": "ok", "entities": 30, "mentions": 80, "edges": 50, "error": "" }, { "namespace": "organization", "status": "ok", "entities": 15, "mentions": 40, "edges": 25, "error": "" } ] } ``` **SDK Code** ```python import requests url = "https://api.cloudraker.com/spaces/spaceId/ontology/ingest" payload = { "fileId": "4f6f1c1e-1b2a-4d3c-9e8f-7a6b5c4d3e2f" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.cloudraker.com/spaces/spaceId/ontology/ingest'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"fileId":"4f6f1c1e-1b2a-4d3c-9e8f-7a6b5c4d3e2f"}' }; 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/ontology/ingest" payload := strings.NewReader("{\n \"fileId\": \"4f6f1c1e-1b2a-4d3c-9e8f-7a6b5c4d3e2f\"\n}") req, _ := http.NewRequest("POST", 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/spaces/spaceId/ontology/ingest") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"fileId\": \"4f6f1c1e-1b2a-4d3c-9e8f-7a6b5c4d3e2f\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.cloudraker.com/spaces/spaceId/ontology/ingest") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"fileId\": \"4f6f1c1e-1b2a-4d3c-9e8f-7a6b5c4d3e2f\"\n}") .asString(); ``` ```php request('POST', 'https://api.cloudraker.com/spaces/spaceId/ontology/ingest', [ 'body' => '{ "fileId": "4f6f1c1e-1b2a-4d3c-9e8f-7a6b5c4d3e2f" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.cloudraker.com/spaces/spaceId/ontology/ingest"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"fileId\": \"4f6f1c1e-1b2a-4d3c-9e8f-7a6b5c4d3e2f\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["fileId": "4f6f1c1e-1b2a-4d3c-9e8f-7a6b5c4d3e2f"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/spaces/spaceId/ontology/ingest")! 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() ```