POST
/
{workspaceId}
/
files
/
extract
/
markdown
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({
    type: "pdf",
    source: {
      type: "url",
      data: "http://unconscious-margin.name",
    },
  });
  
  // Handle the result
  console.log(result)
}

run();
{
  "operationId": "aaaabbbCCCCdddd",
  "result": "# Title\\n\\n This is a paragraph",
  "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?

Body

application/json
file
object
required

Image file data to extract from

Response

200
application/json
The extracted markdown

Successful file extraction result

result
string
required

The extracted markdown

operationId
string
required

Operation ID.

status
enum<string>
required

Operation status.

Available options:
completed