Create Parse Job

curl --request POST \
  --url https://api.example.com/v1/projects/{project_id}/parse \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>' \
  --data '
{
  "source_document_id": "<string>",
  "parameters": {
    "options": {
      "chunking": {
        "chunk_mode": "variable",
        "chunk_size": 123
      }
    },
    "engine": "reducto",
    "chunking_options": {
      "strategy": "token_size",
      "chunk_size": 512,
      "chunk_overlap": 50,
      "encoding_name": "cl100k_base"
    },
    "vector_store_metadata": {},
    "advanced_options": {},
    "experimental_options": {},
    "priority": false
  }
}
'

import requests

url = "https://api.example.com/v1/projects/{project_id}/parse"

payload = {
    "source_document_id": "<string>",
    "parameters": {
        "options": { "chunking": {
                "chunk_mode": "variable",
                "chunk_size": 123
            } },
        "engine": "reducto",
        "chunking_options": {
            "strategy": "token_size",
            "chunk_size": 512,
            "chunk_overlap": 50,
            "encoding_name": "cl100k_base"
        },
        "vector_store_metadata": {},
        "advanced_options": {},
        "experimental_options": {},
        "priority": False
    }
}
headers = {
    "x-api-key": "<api-key>",
    "x-selected-account-id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-selected-account-id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    source_document_id: '<string>',
    parameters: {
      options: {chunking: {chunk_mode: 'variable', chunk_size: 123}},
      engine: 'reducto',
      chunking_options: {
        strategy: 'token_size',
        chunk_size: 512,
        chunk_overlap: 50,
        encoding_name: 'cl100k_base'
      },
      vector_store_metadata: {},
      advanced_options: {},
      experimental_options: {},
      priority: false
    }
  })
};

fetch('https://api.example.com/v1/projects/{project_id}/parse', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/projects/{project_id}/parse",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source_document_id' => '<string>',
    'parameters' => [
        'options' => [
                'chunking' => [
                                'chunk_mode' => 'variable',
                                'chunk_size' => 123
                ]
        ],
        'engine' => 'reducto',
        'chunking_options' => [
                'strategy' => 'token_size',
                'chunk_size' => 512,
                'chunk_overlap' => 50,
                'encoding_name' => 'cl100k_base'
        ],
        'vector_store_metadata' => [
                
        ],
        'advanced_options' => [
                
        ],
        'experimental_options' => [
                
        ],
        'priority' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-selected-account-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/projects/{project_id}/parse"

	payload := strings.NewReader("{\n  \"source_document_id\": \"<string>\",\n  \"parameters\": {\n    \"options\": {\n      \"chunking\": {\n        \"chunk_mode\": \"variable\",\n        \"chunk_size\": 123\n      }\n    },\n    \"engine\": \"reducto\",\n    \"chunking_options\": {\n      \"strategy\": \"token_size\",\n      \"chunk_size\": 512,\n      \"chunk_overlap\": 50,\n      \"encoding_name\": \"cl100k_base\"\n    },\n    \"vector_store_metadata\": {},\n    \"advanced_options\": {},\n    \"experimental_options\": {},\n    \"priority\": false\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-selected-account-id", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/projects/{project_id}/parse")
  .header("x-api-key", "<api-key>")
  .header("x-selected-account-id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_document_id\": \"<string>\",\n  \"parameters\": {\n    \"options\": {\n      \"chunking\": {\n        \"chunk_mode\": \"variable\",\n        \"chunk_size\": 123\n      }\n    },\n    \"engine\": \"reducto\",\n    \"chunking_options\": {\n      \"strategy\": \"token_size\",\n      \"chunk_size\": 512,\n      \"chunk_overlap\": 50,\n      \"encoding_name\": \"cl100k_base\"\n    },\n    \"vector_store_metadata\": {},\n    \"advanced_options\": {},\n    \"experimental_options\": {},\n    \"priority\": false\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/projects/{project_id}/parse")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-selected-account-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source_document_id\": \"<string>\",\n  \"parameters\": {\n    \"options\": {\n      \"chunking\": {\n        \"chunk_mode\": \"variable\",\n        \"chunk_size\": 123\n      }\n    },\n    \"engine\": \"reducto\",\n    \"chunking_options\": {\n      \"strategy\": \"token_size\",\n      \"chunk_size\": 512,\n      \"chunk_overlap\": 50,\n      \"encoding_name\": \"cl100k_base\"\n    },\n    \"vector_store_metadata\": {},\n    \"advanced_options\": {},\n    \"experimental_options\": {},\n    \"priority\": false\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "project_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "object": "job",
  "source_id": "<string>",
  "correlation_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "result": {},
  "progress": {
    "total": 123,
    "succeeded": 123,
    "failed": 123,
    "cancelled": 123,
    "pending": 123,
    "child_jobs": [
      {
        "source_document_id": "<string>",
        "job_id": "<string>",
        "parse_result_id": "<string>",
        "error": "<string>"
      }
    ]
  },
  "error": "<string>",
  "history": [
    {
      "step": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "status": "<string>",
      "details": {}
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

projects

{project_id}

parse

Create Parse Job

curl --request POST \
  --url https://api.example.com/v1/projects/{project_id}/parse \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>' \
  --data '
{
  "source_document_id": "<string>",
  "parameters": {
    "options": {
      "chunking": {
        "chunk_mode": "variable",
        "chunk_size": 123
      }
    },
    "engine": "reducto",
    "chunking_options": {
      "strategy": "token_size",
      "chunk_size": 512,
      "chunk_overlap": 50,
      "encoding_name": "cl100k_base"
    },
    "vector_store_metadata": {},
    "advanced_options": {},
    "experimental_options": {},
    "priority": false
  }
}
'

import requests

url = "https://api.example.com/v1/projects/{project_id}/parse"

payload = {
    "source_document_id": "<string>",
    "parameters": {
        "options": { "chunking": {
                "chunk_mode": "variable",
                "chunk_size": 123
            } },
        "engine": "reducto",
        "chunking_options": {
            "strategy": "token_size",
            "chunk_size": 512,
            "chunk_overlap": 50,
            "encoding_name": "cl100k_base"
        },
        "vector_store_metadata": {},
        "advanced_options": {},
        "experimental_options": {},
        "priority": False
    }
}
headers = {
    "x-api-key": "<api-key>",
    "x-selected-account-id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-selected-account-id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    source_document_id: '<string>',
    parameters: {
      options: {chunking: {chunk_mode: 'variable', chunk_size: 123}},
      engine: 'reducto',
      chunking_options: {
        strategy: 'token_size',
        chunk_size: 512,
        chunk_overlap: 50,
        encoding_name: 'cl100k_base'
      },
      vector_store_metadata: {},
      advanced_options: {},
      experimental_options: {},
      priority: false
    }
  })
};

fetch('https://api.example.com/v1/projects/{project_id}/parse', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/projects/{project_id}/parse",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source_document_id' => '<string>',
    'parameters' => [
        'options' => [
                'chunking' => [
                                'chunk_mode' => 'variable',
                                'chunk_size' => 123
                ]
        ],
        'engine' => 'reducto',
        'chunking_options' => [
                'strategy' => 'token_size',
                'chunk_size' => 512,
                'chunk_overlap' => 50,
                'encoding_name' => 'cl100k_base'
        ],
        'vector_store_metadata' => [
                
        ],
        'advanced_options' => [
                
        ],
        'experimental_options' => [
                
        ],
        'priority' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-selected-account-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/projects/{project_id}/parse"

	payload := strings.NewReader("{\n  \"source_document_id\": \"<string>\",\n  \"parameters\": {\n    \"options\": {\n      \"chunking\": {\n        \"chunk_mode\": \"variable\",\n        \"chunk_size\": 123\n      }\n    },\n    \"engine\": \"reducto\",\n    \"chunking_options\": {\n      \"strategy\": \"token_size\",\n      \"chunk_size\": 512,\n      \"chunk_overlap\": 50,\n      \"encoding_name\": \"cl100k_base\"\n    },\n    \"vector_store_metadata\": {},\n    \"advanced_options\": {},\n    \"experimental_options\": {},\n    \"priority\": false\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-selected-account-id", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/projects/{project_id}/parse")
  .header("x-api-key", "<api-key>")
  .header("x-selected-account-id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_document_id\": \"<string>\",\n  \"parameters\": {\n    \"options\": {\n      \"chunking\": {\n        \"chunk_mode\": \"variable\",\n        \"chunk_size\": 123\n      }\n    },\n    \"engine\": \"reducto\",\n    \"chunking_options\": {\n      \"strategy\": \"token_size\",\n      \"chunk_size\": 512,\n      \"chunk_overlap\": 50,\n      \"encoding_name\": \"cl100k_base\"\n    },\n    \"vector_store_metadata\": {},\n    \"advanced_options\": {},\n    \"experimental_options\": {},\n    \"priority\": false\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/projects/{project_id}/parse")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-selected-account-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source_document_id\": \"<string>\",\n  \"parameters\": {\n    \"options\": {\n      \"chunking\": {\n        \"chunk_mode\": \"variable\",\n        \"chunk_size\": 123\n      }\n    },\n    \"engine\": \"reducto\",\n    \"chunking_options\": {\n      \"strategy\": \"token_size\",\n      \"chunk_size\": 512,\n      \"chunk_overlap\": 50,\n      \"encoding_name\": \"cl100k_base\"\n    },\n    \"vector_store_metadata\": {},\n    \"advanced_options\": {},\n    \"experimental_options\": {},\n    \"priority\": false\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "project_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "object": "job",
  "source_id": "<string>",
  "correlation_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "result": {},
  "progress": {
    "total": 123,
    "succeeded": 123,
    "failed": 123,
    "cancelled": 123,
    "pending": 123,
    "child_jobs": [
      {
        "source_document_id": "<string>",
        "job_id": "<string>",
        "parse_result_id": "<string>",
        "error": "<string>"
      }
    ]
  },
  "error": "<string>",
  "history": [
    {
      "step": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "status": "<string>",
      "details": {}
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

x-api-key

string

header

required

API key for authentication

x-selected-account-id

string

header

required

Selected Account ID

Path Parameters

project_id

string

required

Query Parameters

beta_enable_iris2

boolean

default:true

Enable Iris2 engine for beta testing

Body

application/json

Request model for creating a parse job.

source_document_id

string

required

The ID of the file to be processed

parameters

ReductoParseJobParams · object

required

Parameters for creating a parse job.

ReductoParseJobParams
IrisParseJobParams

Show child attributes

Response

Successful Response

Job response model representing an asynchronous operation.

string

required

ID of the entity

project_id

string

required

ID of the project

operation

enum<string>

required

Operation type (e.g., 'parse')

Available options:

parse,

batch_parse,

extract,

research,

vector_store,

chunk,

summarization,

create_index,

update_index

status

enum<string>

required

Current job status

Available options:

pending,

running,

succeeded,

partially_succeeded,

failed,

cancelled

created_at

string<date-time>

required

When the job was created

object

string

default:job

Allowed value: "job"

source_id

string | null

Source document/file ID

correlation_id

string | null

Request correlation ID for tracing

started_at

string<date-time> | null

When the job started processing

completed_at

string<date-time> | null

When the job completed

result

Result · object | null

Job result payload when completed

progress

BatchParseProgress · object | null

Live progress payload (used by batch jobs)

Show child attributes

error

string | null

Error message if job failed

history

JobHistoryEvent · object[] | null

Timeline of job execution events

Show child attributes

Stream File Content Create Batch Parse Job

⌘I

Projects

Files

Parse

Vector Stores

Extract

Research

Jobs

Indexes

Create Parse Job

Authorizations

Path Parameters

Query Parameters

Body

Response