List Batches

GET https://api.cloud.llamaindex.ai/api/v1/beta/batches

List Batches

Request

Query Parameters

limit Limit

Default value: 20

offset Offset

Default value: 0

project_id any

organization_id any

Cookie Parameters

session any

Responses

Successful Response

application/json

Schema
Example (auto)

Schema

data object[]required

List of batches

Array [

toolTool (string)required

The tool to be used for all requests in the batch.

tool_data object

The data to be used for the tool.

anyOf

LlamaParseParameters
MOD2

priority object

languagesParserLanguages (string)[]

Possible values: [af, az, bs, cs, cy, da, de, en, es, et, fr, ga, hr, hu, id, is, it, ku, la, lt, lv, mi, ms, mt, nl, no, oc, pi, pl, pt, ro, rs_latin, sk, sl, sq, sv, sw, tl, tr, uz, vi, ar, fa, ug, ur, bn, as, mni, ru, rs_cyrillic, be, bg, uk, mn, abq, ady, kbd, ava, dar, inh, che, lbe, lez, tab, tjk, hi, mr, ne, bh, mai, ang, bho, mah, sck, new, gom, sa, bgc, th, ch_sim, ch_tra, ja, ko, ta, te, kn], >= 1

parsing_instruction object

disable_ocr object

annotate_links object

adaptive_long_table object

compact_markdown_table object

disable_reconstruction object

disable_image_extraction object

invalidate_cache object

outlined_table_extraction object

output_pdf_of_document object

do_not_cache object

fast_mode object

skip_diagonal_text object

preserve_layout_alignment_across_pages object

gpt4o_mode object

gpt4o_api_key object

do_not_unroll_columns object

extract_layout object

high_res_ocr object

html_make_all_elements_visible object

html_remove_navigation_elements object

html_remove_fixed_elements object

guess_xlsx_sheet_name object

page_separator object

bounding_box object

bbox_top object

bbox_right object

bbox_bottom object

bbox_left object

target_pages object

use_vendor_multimodal_model object

vendor_multimodal_model_name object

model object

vendor_multimodal_api_key object

page_prefix object

page_suffix object

webhook_url object

preset object

take_screenshot object

is_formatting_instruction object

premium_mode object

continuous_mode object

input_s3_path object

input_s3_region object

output_s3_path_prefix object

output_s3_region object

project_id object

azure_openai_deployment_name object

azure_openai_endpoint object

azure_openai_api_version object

azure_openai_key object

input_url object

http_proxy object

auto_mode object

auto_mode_trigger_on_regexp_in_page object

auto_mode_trigger_on_text_in_page object

auto_mode_trigger_on_table_in_page object

auto_mode_trigger_on_image_in_page object

auto_mode_configuration_json object

structured_output object

structured_output_json_schema object

structured_output_json_schema_name object

max_pages object

max_pages_enforced object

extract_charts object

formatting_instruction object

complemental_formatting_instruction object

content_guideline_instruction object

spreadsheet_extract_sub_tables object

job_timeout_in_seconds object

job_timeout_extra_time_per_page_in_seconds object

strict_mode_image_extraction object

strict_mode_image_ocr object

strict_mode_reconstruction object

strict_mode_buggy_font object

save_images object

ignore_document_elements_for_layout_detection object

output_tables_as_HTML object

internal_is_screenshot_job object

parse_mode object

system_prompt object

system_prompt_append object

user_prompt object

page_error_tolerance object

replace_failed_page_mode object

replace_failed_page_with_error_message_prefix object

replace_failed_page_with_error_message_suffix object

markdown_table_multiline_header_separator object

input_typeInput Type (string)required

The type of input file. Currently only 'datasource' is supported.

input_idInput Id (string)required

The ID of the input file for the batch.

output_type object

output_id object

idId (string)required

Unique identifier for the batch

project_idProject Id (string)required

The ID of the project to which the batch belongs

organization_idOrganization Id (string)required

The ID of the organization to which the batch belongs

user_idUser Id (string)required

The ID of the user who created the batch

external_id object

completion_windowCompletion Window (integer)required

The time frame within which the batch should be processed

pipeline_idPipeline Id (string)required

The ID of the pipeline to which the batch belongs

statusStatus (string)required

The current status of the batch

created_at object

updated_at object

]

limitLimit (integer)required

Pagination limit

offsetOffset (integer)required

Pagination offset

total_countTotal Count (integer)required

Total number of batches

{
  "data": [
    {
      "tool": "string",
      "tool_data": {
        "priority": "low",
        "languages": [
          "af"
        ],
        "parsing_instruction": "string",
        "disable_ocr": true,
        "annotate_links": true,
        "adaptive_long_table": true,
        "compact_markdown_table": true,
        "disable_reconstruction": true,
        "disable_image_extraction": true,
        "invalidate_cache": true,
        "outlined_table_extraction": true,
        "output_pdf_of_document": true,
        "do_not_cache": true,
        "fast_mode": true,
        "skip_diagonal_text": true,
        "preserve_layout_alignment_across_pages": true,
        "gpt4o_mode": true,
        "gpt4o_api_key": "string",
        "do_not_unroll_columns": true,
        "extract_layout": true,
        "high_res_ocr": true,
        "html_make_all_elements_visible": true,
        "html_remove_navigation_elements": true,
        "html_remove_fixed_elements": true,
        "guess_xlsx_sheet_name": true,
        "page_separator": "string",
        "bounding_box": "string",
        "bbox_top": 0,
        "bbox_right": 0,
        "bbox_bottom": 0,
        "bbox_left": 0,
        "target_pages": "string",
        "use_vendor_multimodal_model": true,
        "vendor_multimodal_model_name": "string",
        "model": "string",
        "vendor_multimodal_api_key": "string",
        "page_prefix": "string",
        "page_suffix": "string",
        "webhook_url": "string",
        "preset": "string",
        "take_screenshot": true,
        "is_formatting_instruction": true,
        "premium_mode": true,
        "continuous_mode": true,
        "input_s3_path": "string",
        "input_s3_region": "string",
        "output_s3_path_prefix": "string",
        "output_s3_region": "string",
        "project_id": "string",
        "azure_openai_deployment_name": "string",
        "azure_openai_endpoint": "string",
        "azure_openai_api_version": "string",
        "azure_openai_key": "string",
        "input_url": "string",
        "http_proxy": "string",
        "auto_mode": true,
        "auto_mode_trigger_on_regexp_in_page": "string",
        "auto_mode_trigger_on_text_in_page": "string",
        "auto_mode_trigger_on_table_in_page": true,
        "auto_mode_trigger_on_image_in_page": true,
        "auto_mode_configuration_json": "string",
        "structured_output": true,
        "structured_output_json_schema": "string",
        "structured_output_json_schema_name": "string",
        "max_pages": 0,
        "max_pages_enforced": 0,
        "extract_charts": true,
        "formatting_instruction": "string",
        "complemental_formatting_instruction": "string",
        "content_guideline_instruction": "string",
        "spreadsheet_extract_sub_tables": true,
        "job_timeout_in_seconds": 0,
        "job_timeout_extra_time_per_page_in_seconds": 0,
        "strict_mode_image_extraction": true,
        "strict_mode_image_ocr": true,
        "strict_mode_reconstruction": true,
        "strict_mode_buggy_font": true,
        "save_images": true,
        "ignore_document_elements_for_layout_detection": true,
        "output_tables_as_HTML": true,
        "internal_is_screenshot_job": true,
        "parse_mode": "parse_page_without_llm",
        "system_prompt": "string",
        "system_prompt_append": "string",
        "user_prompt": "string",
        "page_error_tolerance": 0,
        "replace_failed_page_mode": "raw_text",
        "replace_failed_page_with_error_message_prefix": "string",
        "replace_failed_page_with_error_message_suffix": "string",
        "markdown_table_multiline_header_separator": "string"
      },
      "input_type": "string",
      "input_id": "string",
      "output_type": "string",
      "output_id": "string",
      "id": "string",
      "project_id": "string",
      "organization_id": "string",
      "user_id": "string",
      "external_id": "string",
      "completion_window": 0,
      "pipeline_id": "string",
      "status": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total_count": 0
}

Validation Error

application/json

Schema
Example (auto)

Schema

detail object[]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Authorization: http

name: HTTPBearertype: httpscheme: bearer

name: HTTPBearertype: httpscheme: bearer

HTTPCLIENT
RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.cloud.llamaindex.ai/api/v1/beta/batches");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

ResponseClear

Click the Send API Request button above and see the response here!

List Batches

https://api.cloud.llamaindex.ai/api/v1/beta/batches

Request​

Query Parameters

Cookie Parameters

Responses​

Authorization: http

Request

Responses