GET
/
{workspaceId}
/
files
/
extract
/
structuredData
/
{operationId}
/
result
import { IntunedClient } from "@intuned/client";

const intunedClient = new IntunedClient({
  apiKey: "<YOUR_API_KEY_HERE>",
  workspaceId: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
});

async function run() {
  const result = await intunedClient.files.extractStructuredData.result("aaaabbbCCCCdddd");
  
  // Handle the result
  console.log(result)
}

run();
{
  "operationId": "aaaabbbCCCCdddd",
  "result": {
    "firstName": "John",
    "jobTitle": "Manager",
    "lastName": "Doe"
  },
  "status": "completed"
}

Authorizations

​
x-api-key
string
header
required

API Key used to authenticate your requests. How to create one.

Path Parameters

​
workspaceId
string
required

Your workspace ID. How to find it?

​
operationId
string
required

The ID for the requested file operation. This is obtained from the start request.

Response

200
application/json
Result of the operation. Can be pending, completed or failed.

Successful file extraction result

​
result
any
required

The extracted data formatted according to the input dataSchema

​
operationId
string
required

Operation ID.

​
status
enum<string>
required

Operation status.

Available options:
completed