POST
/
{workspaceId}
/
files
/
extract
/
markdown
fileExtractMarkdownSync
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.extractMarkdown.sync({
    file: {
      type: "pdf",
      source: {
        type: "url",
        data: "https://intuned.io/example.pdf",
      },
    },
  });

  // Handle the result
  console.log(result);
}

run();
{
"operationId": "aaaabbbCCCCdddd",
"status": "completed",
"result": "# Title\\n\\n This is a paragraph"
}

Authorizations

x-api-key
string
header
required

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

Path Parameters

workspaceId
string<uuid>
required

Your workspace ID. How to find it?

Body

application/json
file
object
required

Image file data to extract from

Response

The extracted markdown

Markdown extraction result Successful file extraction result

result
string
required

The extracted markdown

operationId
string
required

Operation ID.

status
enum<string>
required

Operation status.

Available options:
completed