Load an URL

Reference documentation on loading URLs for sending, using Mindee client libraries.

This is reference documentation.

Code samples shown are only examples, and will not work as-is. You'll need to copy-paste and modify according to your requirements.

Looking full code samples?

You can also use the "Ask" button at the top of any page in the documentation.

Overview

Overall, the steps to sending an URL are:

1. Load the URL, this does not download anything locally.
2. Optional: adjust the source file before sending.
3. Use the Mindee client instance to send the file.

Requirements

In most cases you'll be loading a source file for use in the Mindee Client, take a look at the Client Configuration section for more info.

However, you don't actually need the client initialized to use these features, only the client library installed.

All accepted files may be used, if they adhere to the API file limits.

In addition, the source URL must adhere to the following rules:

• Secured using TLS (HTTPS).
• Publicly available using only the URL, no authentication headers.
• Authentication may be provided in the URL as query parameters: username+password or token. For example, Amazon S3 signed URLs will work.
• Contents must be a binary file (raw bytes, not base64-encoded).
• File contents cannot be encrypted.
• The Mindee server will not follow redirections (HTTP 3xx).

Load the URL

Python

Use the URLInputSource class.

from mindee import UrlInputSource

input_source = UrlInputSource(
    "https://example.com/file.ext"
)

Node.js

Use the URLInput class.

const inputSource = new mindee.UrlInput({
  url: "https://example.com/file.ext"
});

PHP

Use the URLInputSource class.

use Mindee\Input\URLInputSource;

$inputSource = new URLInputSource(
  url: "https://example.com/file.ext"
);

Ruby

require 'mindee'

input_source = Mindee::Input::Source::URLInputSource.new(
  'https://example.com/file.ext'
)

Java

Use the URLInputSource class.

import com.mindee.input.URLInputSource;

URLInputSource inputSource = URLInputSource
    .builder("https://example.com/file.ext")
    .build();

.NET

Use the URLInputSource class.

var inputSource = new UrlInputSource(
    "https://example.com/file.ext");