Upload file to batch

Upload a file to a batch or update the contents of a previously uploaded file in a batch.

Files can be uploaded one at a time and the suggested max size for each file is 10 MB. For larger files, see Multipart file upload.

If you upload a password-protected PDF, provide the password when you process the PDF with an AI Hub app. See instructions for configuring the settings.runtime_config.instabase.pdf.passwords property for the Run deployment or Run app operations.

Upload a file to a batch or update the contents of a previously uploaded file in a batch. <Info>Files can be uploaded one at a time and the suggested max size for each file is 10 MB. For larger files, see [Multipart file upload](/api-sdk/api-reference/batches/create-multipart-upload-session).</Info> <Note>If you upload a password-protected PDF, provide the password when you process the PDF with an AI Hub app. See instructions for configuring the `settings.runtime_config.instabase.pdf.passwords` property for the [Run deployment](/api-sdk/api-reference/runs/run-deployment#request.body.settings.runtime_config.instabase.pdf.passwords) or [Run app](/api-sdk/api-reference/runs/run-app#request.body.settings.runtime_config.instabase.pdf.passwords) operations.</Note>

Authentication

AuthorizationBearer

Bearer HTTP authentication.

Path parameters

batch_idintegerRequired

The batch ID.

filenamestringRequired

A user-defined name for the file on the Instabase filesystem. Include the file extension. This doesn’t need to be the same as its name on your local filesystem.

Headers

IB-ContextstringOptional

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See Authorization and context identification for details.

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.

1	from aihub import AIHub
2
3	client = AIHub(api_root="https://aihub.instabase.com/api",
4	api_key="abcdefghijklmnopqrst1234567890",
5	ib_context="john.doe_acme.com")
6
7	local_filepath = "/local/path/to/file1.pdf"
8
9	# returns None
10	with open(local_filepath, "rb") as local_file:
11	client.batches.add_file(batch_id=12345,
12	file_name="MyFile1.pdf", # AI Hub filesystem
13	file=local_file) # local filesystem

Authentication

Path parameters

Headers

Request

Response

Errors