Start an extraction run for a file

POST 
https://api.cloudsquid.io/api/datasources/:source_id/run

Start an extraction run for a file. The runs are asynchronous and the status can be checked with the run_id.

Request

Path Parameters

source_id uuidrequired

the ID of the datasource

application/json

Body

pipeline stringrequired

Possible values: [cloudsquid-pro, cloudsquid-flash]

file_id uuidrequired

File to start extraction

Responses

202

Extraction started successfully

application/json

Schema

Schema

run_id uuidrequired

The id of the run

Example (from schema)

{
  "run_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

400

Bad or malformed request

application/json

Schema

Schema

errorMessage stringrequired

Example (from schema)

{
  "errorMessage": "string"
}

401

Unauthorized

application/json

Schema

Schema

errorMessage stringrequired

Example (from schema)

{
  "errorMessage": "string"
}

500

Something unexpectedly went wrong internally

Authorization: X-API-Key

name: X-API-Keytype: apiKeyin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.cloudsquid.io/api/datasources/:source_id/run");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-Key", "<API_KEY_VALUE>");
var content = new StringContent("{\n  \"pipeline\": \"cloudsquid-pro\",\n  \"file_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.cloudsquid.io/api

Auth

api-key

Parameters

source_id — pathrequired

Body

{
  "pipeline": "cloudsquid-pro",
  "file_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

ResponseClear

Click the Send API Request button above and see the response here!