Enrich Data

curl --request POST \
  --url https://catalogapi.rastro.ai/api/public/enrich \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "",
  "items": [
    {}
  ],
  "output_schema": [
    {
      "name": "<string>",
      "description": "<string>",
      "type": "string",
      "array_element_type": "<string>",
      "unit": "<string>",
      "enum": [
        "<string>"
      ],
      "items_enum": [
        "<string>"
      ],
      "sample_values": [
        "<string>"
      ],
      "required": true,
      "merge": true,
      "pattern": "<string>",
      "pattern_message": "<string>",
      "min_length": 123,
      "max_length": 123,
      "minimum": 123,
      "maximum": 123,
      "unique": true,
      "semantic_type": "<string>"
    }
  ],
  "attribute_sets": {},
  "source_hint_sets": {},
  "allowed_domains": [
    "<string>"
  ],
  "blocked_domains": [
    "<string>"
  ],
  "speed": "deep",
  "web_search": true,
  "max_rows": 123,
  "taxonomy": {},
  "predict_taxonomy": false,
  "predict_taxonomy_attributes": true,
  "validate_semantics": false,
  "review_mode": true,
  "audit_decisions_enabled": true,
  "include_source_explanations": true,
  "low_confidence": {
    "enabled": false,
    "scopes": [
      "<string>"
    ],
    "placement": "tail",
    "max_candidates_per_item": 8
  },
  "catalog_id": "<string>",
  "template_id": "<string>",
  "async_mode": false,
  "staged_status": "pending",
  "source_activity_id": "<string>",
  "source_catalog_id": "<string>",
  "file_name": "<string>",
  "include_service_usage": false,
  "include_debug_log": false,
  "capture_source_artifacts": false,
  "reextract_from_activity_id": "<string>",
  "global_feedback": "<string>",
  "item_feedback": {},
  "source_row_indices": [
    123
  ],
  "webhook_url": "<string>",
  "knowledge_base_enabled": false,
  "knowledge_base_vector_store_id": "<string>",
  "knowledge_base_sources": {},
  "knowledge_base_metadata": {},
  "host_media": false,
  "strict_hosted_media": false,
  "image_processing": {
    "enabled": false,
    "make_square": true,
    "background_color": "#FFFFFF",
    "min_side_px": 500,
    "max_side_px": 1700,
    "output_format": "jpeg",
    "quality": 92,
    "force_reprocess_hosted": false,
    "fields": [
      "<string>"
    ]
  }
}
'

import requests

url = "https://catalogapi.rastro.ai/api/public/enrich"

payload = {
    "prompt": "",
    "items": [{}],
    "output_schema": [
        {
            "name": "<string>",
            "description": "<string>",
            "type": "string",
            "array_element_type": "<string>",
            "unit": "<string>",
            "enum": ["<string>"],
            "items_enum": ["<string>"],
            "sample_values": ["<string>"],
            "required": True,
            "merge": True,
            "pattern": "<string>",
            "pattern_message": "<string>",
            "min_length": 123,
            "max_length": 123,
            "minimum": 123,
            "maximum": 123,
            "unique": True,
            "semantic_type": "<string>"
        }
    ],
    "attribute_sets": {},
    "source_hint_sets": {},
    "allowed_domains": ["<string>"],
    "blocked_domains": ["<string>"],
    "speed": "deep",
    "web_search": True,
    "max_rows": 123,
    "taxonomy": {},
    "predict_taxonomy": False,
    "predict_taxonomy_attributes": True,
    "validate_semantics": False,
    "review_mode": True,
    "audit_decisions_enabled": True,
    "include_source_explanations": True,
    "low_confidence": {
        "enabled": False,
        "scopes": ["<string>"],
        "placement": "tail",
        "max_candidates_per_item": 8
    },
    "catalog_id": "<string>",
    "template_id": "<string>",
    "async_mode": False,
    "staged_status": "pending",
    "source_activity_id": "<string>",
    "source_catalog_id": "<string>",
    "file_name": "<string>",
    "include_service_usage": False,
    "include_debug_log": False,
    "capture_source_artifacts": False,
    "reextract_from_activity_id": "<string>",
    "global_feedback": "<string>",
    "item_feedback": {},
    "source_row_indices": [123],
    "webhook_url": "<string>",
    "knowledge_base_enabled": False,
    "knowledge_base_vector_store_id": "<string>",
    "knowledge_base_sources": {},
    "knowledge_base_metadata": {},
    "host_media": False,
    "strict_hosted_media": False,
    "image_processing": {
        "enabled": False,
        "make_square": True,
        "background_color": "#FFFFFF",
        "min_side_px": 500,
        "max_side_px": 1700,
        "output_format": "jpeg",
        "quality": 92,
        "force_reprocess_hosted": False,
        "fields": ["<string>"]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt: '',
    items: [{}],
    output_schema: [
      {
        name: '<string>',
        description: '<string>',
        type: 'string',
        array_element_type: '<string>',
        unit: '<string>',
        enum: ['<string>'],
        items_enum: ['<string>'],
        sample_values: ['<string>'],
        required: true,
        merge: true,
        pattern: '<string>',
        pattern_message: '<string>',
        min_length: 123,
        max_length: 123,
        minimum: 123,
        maximum: 123,
        unique: true,
        semantic_type: '<string>'
      }
    ],
    attribute_sets: {},
    source_hint_sets: {},
    allowed_domains: ['<string>'],
    blocked_domains: ['<string>'],
    speed: 'deep',
    web_search: true,
    max_rows: 123,
    taxonomy: {},
    predict_taxonomy: false,
    predict_taxonomy_attributes: true,
    validate_semantics: false,
    review_mode: true,
    audit_decisions_enabled: true,
    include_source_explanations: true,
    low_confidence: {
      enabled: false,
      scopes: ['<string>'],
      placement: 'tail',
      max_candidates_per_item: 8
    },
    catalog_id: '<string>',
    template_id: '<string>',
    async_mode: false,
    staged_status: 'pending',
    source_activity_id: '<string>',
    source_catalog_id: '<string>',
    file_name: '<string>',
    include_service_usage: false,
    include_debug_log: false,
    capture_source_artifacts: false,
    reextract_from_activity_id: '<string>',
    global_feedback: '<string>',
    item_feedback: {},
    source_row_indices: [123],
    webhook_url: '<string>',
    knowledge_base_enabled: false,
    knowledge_base_vector_store_id: '<string>',
    knowledge_base_sources: {},
    knowledge_base_metadata: {},
    host_media: false,
    strict_hosted_media: false,
    image_processing: {
      enabled: false,
      make_square: true,
      background_color: '#FFFFFF',
      min_side_px: 500,
      max_side_px: 1700,
      output_format: 'jpeg',
      quality: 92,
      force_reprocess_hosted: false,
      fields: ['<string>']
    }
  })
};

fetch('https://catalogapi.rastro.ai/api/public/enrich', 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://catalogapi.rastro.ai/api/public/enrich",
  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([
    'prompt' => '',
    'items' => [
        [
                
        ]
    ],
    'output_schema' => [
        [
                'name' => '<string>',
                'description' => '<string>',
                'type' => 'string',
                'array_element_type' => '<string>',
                'unit' => '<string>',
                'enum' => [
                                '<string>'
                ],
                'items_enum' => [
                                '<string>'
                ],
                'sample_values' => [
                                '<string>'
                ],
                'required' => true,
                'merge' => true,
                'pattern' => '<string>',
                'pattern_message' => '<string>',
                'min_length' => 123,
                'max_length' => 123,
                'minimum' => 123,
                'maximum' => 123,
                'unique' => true,
                'semantic_type' => '<string>'
        ]
    ],
    'attribute_sets' => [
        
    ],
    'source_hint_sets' => [
        
    ],
    'allowed_domains' => [
        '<string>'
    ],
    'blocked_domains' => [
        '<string>'
    ],
    'speed' => 'deep',
    'web_search' => true,
    'max_rows' => 123,
    'taxonomy' => [
        
    ],
    'predict_taxonomy' => false,
    'predict_taxonomy_attributes' => true,
    'validate_semantics' => false,
    'review_mode' => true,
    'audit_decisions_enabled' => true,
    'include_source_explanations' => true,
    'low_confidence' => [
        'enabled' => false,
        'scopes' => [
                '<string>'
        ],
        'placement' => 'tail',
        'max_candidates_per_item' => 8
    ],
    'catalog_id' => '<string>',
    'template_id' => '<string>',
    'async_mode' => false,
    'staged_status' => 'pending',
    'source_activity_id' => '<string>',
    'source_catalog_id' => '<string>',
    'file_name' => '<string>',
    'include_service_usage' => false,
    'include_debug_log' => false,
    'capture_source_artifacts' => false,
    'reextract_from_activity_id' => '<string>',
    'global_feedback' => '<string>',
    'item_feedback' => [
        
    ],
    'source_row_indices' => [
        123
    ],
    'webhook_url' => '<string>',
    'knowledge_base_enabled' => false,
    'knowledge_base_vector_store_id' => '<string>',
    'knowledge_base_sources' => [
        
    ],
    'knowledge_base_metadata' => [
        
    ],
    'host_media' => false,
    'strict_hosted_media' => false,
    'image_processing' => [
        'enabled' => false,
        'make_square' => true,
        'background_color' => '#FFFFFF',
        'min_side_px' => 500,
        'max_side_px' => 1700,
        'output_format' => 'jpeg',
        'quality' => 92,
        'force_reprocess_hosted' => false,
        'fields' => [
                '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://catalogapi.rastro.ai/api/public/enrich"

	payload := strings.NewReader("{\n  \"prompt\": \"\",\n  \"items\": [\n    {}\n  ],\n  \"output_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"type\": \"string\",\n      \"array_element_type\": \"<string>\",\n      \"unit\": \"<string>\",\n      \"enum\": [\n        \"<string>\"\n      ],\n      \"items_enum\": [\n        \"<string>\"\n      ],\n      \"sample_values\": [\n        \"<string>\"\n      ],\n      \"required\": true,\n      \"merge\": true,\n      \"pattern\": \"<string>\",\n      \"pattern_message\": \"<string>\",\n      \"min_length\": 123,\n      \"max_length\": 123,\n      \"minimum\": 123,\n      \"maximum\": 123,\n      \"unique\": true,\n      \"semantic_type\": \"<string>\"\n    }\n  ],\n  \"attribute_sets\": {},\n  \"source_hint_sets\": {},\n  \"allowed_domains\": [\n    \"<string>\"\n  ],\n  \"blocked_domains\": [\n    \"<string>\"\n  ],\n  \"speed\": \"deep\",\n  \"web_search\": true,\n  \"max_rows\": 123,\n  \"taxonomy\": {},\n  \"predict_taxonomy\": false,\n  \"predict_taxonomy_attributes\": true,\n  \"validate_semantics\": false,\n  \"review_mode\": true,\n  \"audit_decisions_enabled\": true,\n  \"include_source_explanations\": true,\n  \"low_confidence\": {\n    \"enabled\": false,\n    \"scopes\": [\n      \"<string>\"\n    ],\n    \"placement\": \"tail\",\n    \"max_candidates_per_item\": 8\n  },\n  \"catalog_id\": \"<string>\",\n  \"template_id\": \"<string>\",\n  \"async_mode\": false,\n  \"staged_status\": \"pending\",\n  \"source_activity_id\": \"<string>\",\n  \"source_catalog_id\": \"<string>\",\n  \"file_name\": \"<string>\",\n  \"include_service_usage\": false,\n  \"include_debug_log\": false,\n  \"capture_source_artifacts\": false,\n  \"reextract_from_activity_id\": \"<string>\",\n  \"global_feedback\": \"<string>\",\n  \"item_feedback\": {},\n  \"source_row_indices\": [\n    123\n  ],\n  \"webhook_url\": \"<string>\",\n  \"knowledge_base_enabled\": false,\n  \"knowledge_base_vector_store_id\": \"<string>\",\n  \"knowledge_base_sources\": {},\n  \"knowledge_base_metadata\": {},\n  \"host_media\": false,\n  \"strict_hosted_media\": false,\n  \"image_processing\": {\n    \"enabled\": false,\n    \"make_square\": true,\n    \"background_color\": \"#FFFFFF\",\n    \"min_side_px\": 500,\n    \"max_side_px\": 1700,\n    \"output_format\": \"jpeg\",\n    \"quality\": 92,\n    \"force_reprocess_hosted\": false,\n    \"fields\": [\n      \"<string>\"\n    ]\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://catalogapi.rastro.ai/api/public/enrich")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"\",\n  \"items\": [\n    {}\n  ],\n  \"output_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"type\": \"string\",\n      \"array_element_type\": \"<string>\",\n      \"unit\": \"<string>\",\n      \"enum\": [\n        \"<string>\"\n      ],\n      \"items_enum\": [\n        \"<string>\"\n      ],\n      \"sample_values\": [\n        \"<string>\"\n      ],\n      \"required\": true,\n      \"merge\": true,\n      \"pattern\": \"<string>\",\n      \"pattern_message\": \"<string>\",\n      \"min_length\": 123,\n      \"max_length\": 123,\n      \"minimum\": 123,\n      \"maximum\": 123,\n      \"unique\": true,\n      \"semantic_type\": \"<string>\"\n    }\n  ],\n  \"attribute_sets\": {},\n  \"source_hint_sets\": {},\n  \"allowed_domains\": [\n    \"<string>\"\n  ],\n  \"blocked_domains\": [\n    \"<string>\"\n  ],\n  \"speed\": \"deep\",\n  \"web_search\": true,\n  \"max_rows\": 123,\n  \"taxonomy\": {},\n  \"predict_taxonomy\": false,\n  \"predict_taxonomy_attributes\": true,\n  \"validate_semantics\": false,\n  \"review_mode\": true,\n  \"audit_decisions_enabled\": true,\n  \"include_source_explanations\": true,\n  \"low_confidence\": {\n    \"enabled\": false,\n    \"scopes\": [\n      \"<string>\"\n    ],\n    \"placement\": \"tail\",\n    \"max_candidates_per_item\": 8\n  },\n  \"catalog_id\": \"<string>\",\n  \"template_id\": \"<string>\",\n  \"async_mode\": false,\n  \"staged_status\": \"pending\",\n  \"source_activity_id\": \"<string>\",\n  \"source_catalog_id\": \"<string>\",\n  \"file_name\": \"<string>\",\n  \"include_service_usage\": false,\n  \"include_debug_log\": false,\n  \"capture_source_artifacts\": false,\n  \"reextract_from_activity_id\": \"<string>\",\n  \"global_feedback\": \"<string>\",\n  \"item_feedback\": {},\n  \"source_row_indices\": [\n    123\n  ],\n  \"webhook_url\": \"<string>\",\n  \"knowledge_base_enabled\": false,\n  \"knowledge_base_vector_store_id\": \"<string>\",\n  \"knowledge_base_sources\": {},\n  \"knowledge_base_metadata\": {},\n  \"host_media\": false,\n  \"strict_hosted_media\": false,\n  \"image_processing\": {\n    \"enabled\": false,\n    \"make_square\": true,\n    \"background_color\": \"#FFFFFF\",\n    \"min_side_px\": 500,\n    \"max_side_px\": 1700,\n    \"output_format\": \"jpeg\",\n    \"quality\": 92,\n    \"force_reprocess_hosted\": false,\n    \"fields\": [\n      \"<string>\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://catalogapi.rastro.ai/api/public/enrich")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"\",\n  \"items\": [\n    {}\n  ],\n  \"output_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"type\": \"string\",\n      \"array_element_type\": \"<string>\",\n      \"unit\": \"<string>\",\n      \"enum\": [\n        \"<string>\"\n      ],\n      \"items_enum\": [\n        \"<string>\"\n      ],\n      \"sample_values\": [\n        \"<string>\"\n      ],\n      \"required\": true,\n      \"merge\": true,\n      \"pattern\": \"<string>\",\n      \"pattern_message\": \"<string>\",\n      \"min_length\": 123,\n      \"max_length\": 123,\n      \"minimum\": 123,\n      \"maximum\": 123,\n      \"unique\": true,\n      \"semantic_type\": \"<string>\"\n    }\n  ],\n  \"attribute_sets\": {},\n  \"source_hint_sets\": {},\n  \"allowed_domains\": [\n    \"<string>\"\n  ],\n  \"blocked_domains\": [\n    \"<string>\"\n  ],\n  \"speed\": \"deep\",\n  \"web_search\": true,\n  \"max_rows\": 123,\n  \"taxonomy\": {},\n  \"predict_taxonomy\": false,\n  \"predict_taxonomy_attributes\": true,\n  \"validate_semantics\": false,\n  \"review_mode\": true,\n  \"audit_decisions_enabled\": true,\n  \"include_source_explanations\": true,\n  \"low_confidence\": {\n    \"enabled\": false,\n    \"scopes\": [\n      \"<string>\"\n    ],\n    \"placement\": \"tail\",\n    \"max_candidates_per_item\": 8\n  },\n  \"catalog_id\": \"<string>\",\n  \"template_id\": \"<string>\",\n  \"async_mode\": false,\n  \"staged_status\": \"pending\",\n  \"source_activity_id\": \"<string>\",\n  \"source_catalog_id\": \"<string>\",\n  \"file_name\": \"<string>\",\n  \"include_service_usage\": false,\n  \"include_debug_log\": false,\n  \"capture_source_artifacts\": false,\n  \"reextract_from_activity_id\": \"<string>\",\n  \"global_feedback\": \"<string>\",\n  \"item_feedback\": {},\n  \"source_row_indices\": [\n    123\n  ],\n  \"webhook_url\": \"<string>\",\n  \"knowledge_base_enabled\": false,\n  \"knowledge_base_vector_store_id\": \"<string>\",\n  \"knowledge_base_sources\": {},\n  \"knowledge_base_metadata\": {},\n  \"host_media\": false,\n  \"strict_hosted_media\": false,\n  \"image_processing\": {\n    \"enabled\": false,\n    \"make_square\": true,\n    \"background_color\": \"#FFFFFF\",\n    \"min_side_px\": 500,\n    \"max_side_px\": 1700,\n    \"output_format\": \"jpeg\",\n    \"quality\": 92,\n    \"force_reprocess_hosted\": false,\n    \"fields\": [\n      \"<string>\"\n    ]\n  }\n}"

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

{
  "total_items": 123,
  "job_id": "<string>",
  "results": [
    {
      "original_data": {},
      "after_data": {},
      "all_sources": [
        "<string>"
      ],
      "error": "<string>",
      "category_id": "<string>",
      "taxonomy_attributes": {},
      "taxonomy_attribute_sources": {},
      "taxonomy_attribute_explanations": {},
      "review_info": {},
      "low_confidence_candidates": [
        {
          "name": "<string>",
          "scope": "field",
          "candidate_value": "<string>",
          "confidence": "LOW",
          "reason": "<string>",
          "sources": [
            "<string>"
          ],
          "source_explanation": "<string>"
        }
      ],
      "low_confidence_fields": [
        "<string>"
      ],
      "staged_change_id": "<string>"
    }
  ],
  "total_rows": 123,
  "successful": 0,
  "credits_used": 0,
  "status": "completed",
  "service_usage": {},
  "pricing_estimates": {},
  "knowledge_base_enabled": true,
  "knowledge_base_sources": {},
  "page": 123,
  "page_size": 123,
  "total_pages": 123,
  "completed_items": 123
}

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

Enrich

Enrich Data

Enrich items using web research, with optional taxonomy prediction.

Accepts both application/json (plain JSON body) and multipart/form-data (with request_json field, optional items_file, and optional knowledge_base_files).

Two modes of operation:

Direct mode: Pass items and output_schema directly
Full-run mode: Pass source_activity_id from a previous run to process all stored items

Example: Direct enrichment

{
  "prompt": "Find product specifications",
  "items": [{"name": "iPhone 15 Pro"}],
  "output_schema": [
    {"name": "price", "type": "string", "description": "Current retail price"},
    {"name": "weight", "type": "string", "description": "Product weight"}
  ]
}

Example: Dry run (process first 10 items)

{
  "prompt": "Find product specifications",
  "items": [... all 1000 items ...],
  "output_schema": [...],
  "max_rows": 10
}

Example: Full run from previous activity

{
  "prompt": "Find product specifications",
  "source_activity_id": "abc123-previous-activity-id"
}

Large jobs: send multipart/form-data with a small request_json and one items_file JSON upload. items_file must be a JSON array, or an object with an items array. Do not send items_storage_url; it is internal.

All items are stored in the activity, so full runs can be triggered later using source_activity_id.

POST

public

enrich

Enrich Data

curl --request POST \
  --url https://catalogapi.rastro.ai/api/public/enrich \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "",
  "items": [
    {}
  ],
  "output_schema": [
    {
      "name": "<string>",
      "description": "<string>",
      "type": "string",
      "array_element_type": "<string>",
      "unit": "<string>",
      "enum": [
        "<string>"
      ],
      "items_enum": [
        "<string>"
      ],
      "sample_values": [
        "<string>"
      ],
      "required": true,
      "merge": true,
      "pattern": "<string>",
      "pattern_message": "<string>",
      "min_length": 123,
      "max_length": 123,
      "minimum": 123,
      "maximum": 123,
      "unique": true,
      "semantic_type": "<string>"
    }
  ],
  "attribute_sets": {},
  "source_hint_sets": {},
  "allowed_domains": [
    "<string>"
  ],
  "blocked_domains": [
    "<string>"
  ],
  "speed": "deep",
  "web_search": true,
  "max_rows": 123,
  "taxonomy": {},
  "predict_taxonomy": false,
  "predict_taxonomy_attributes": true,
  "validate_semantics": false,
  "review_mode": true,
  "audit_decisions_enabled": true,
  "include_source_explanations": true,
  "low_confidence": {
    "enabled": false,
    "scopes": [
      "<string>"
    ],
    "placement": "tail",
    "max_candidates_per_item": 8
  },
  "catalog_id": "<string>",
  "template_id": "<string>",
  "async_mode": false,
  "staged_status": "pending",
  "source_activity_id": "<string>",
  "source_catalog_id": "<string>",
  "file_name": "<string>",
  "include_service_usage": false,
  "include_debug_log": false,
  "capture_source_artifacts": false,
  "reextract_from_activity_id": "<string>",
  "global_feedback": "<string>",
  "item_feedback": {},
  "source_row_indices": [
    123
  ],
  "webhook_url": "<string>",
  "knowledge_base_enabled": false,
  "knowledge_base_vector_store_id": "<string>",
  "knowledge_base_sources": {},
  "knowledge_base_metadata": {},
  "host_media": false,
  "strict_hosted_media": false,
  "image_processing": {
    "enabled": false,
    "make_square": true,
    "background_color": "#FFFFFF",
    "min_side_px": 500,
    "max_side_px": 1700,
    "output_format": "jpeg",
    "quality": 92,
    "force_reprocess_hosted": false,
    "fields": [
      "<string>"
    ]
  }
}
'

import requests

url = "https://catalogapi.rastro.ai/api/public/enrich"

payload = {
    "prompt": "",
    "items": [{}],
    "output_schema": [
        {
            "name": "<string>",
            "description": "<string>",
            "type": "string",
            "array_element_type": "<string>",
            "unit": "<string>",
            "enum": ["<string>"],
            "items_enum": ["<string>"],
            "sample_values": ["<string>"],
            "required": True,
            "merge": True,
            "pattern": "<string>",
            "pattern_message": "<string>",
            "min_length": 123,
            "max_length": 123,
            "minimum": 123,
            "maximum": 123,
            "unique": True,
            "semantic_type": "<string>"
        }
    ],
    "attribute_sets": {},
    "source_hint_sets": {},
    "allowed_domains": ["<string>"],
    "blocked_domains": ["<string>"],
    "speed": "deep",
    "web_search": True,
    "max_rows": 123,
    "taxonomy": {},
    "predict_taxonomy": False,
    "predict_taxonomy_attributes": True,
    "validate_semantics": False,
    "review_mode": True,
    "audit_decisions_enabled": True,
    "include_source_explanations": True,
    "low_confidence": {
        "enabled": False,
        "scopes": ["<string>"],
        "placement": "tail",
        "max_candidates_per_item": 8
    },
    "catalog_id": "<string>",
    "template_id": "<string>",
    "async_mode": False,
    "staged_status": "pending",
    "source_activity_id": "<string>",
    "source_catalog_id": "<string>",
    "file_name": "<string>",
    "include_service_usage": False,
    "include_debug_log": False,
    "capture_source_artifacts": False,
    "reextract_from_activity_id": "<string>",
    "global_feedback": "<string>",
    "item_feedback": {},
    "source_row_indices": [123],
    "webhook_url": "<string>",
    "knowledge_base_enabled": False,
    "knowledge_base_vector_store_id": "<string>",
    "knowledge_base_sources": {},
    "knowledge_base_metadata": {},
    "host_media": False,
    "strict_hosted_media": False,
    "image_processing": {
        "enabled": False,
        "make_square": True,
        "background_color": "#FFFFFF",
        "min_side_px": 500,
        "max_side_px": 1700,
        "output_format": "jpeg",
        "quality": 92,
        "force_reprocess_hosted": False,
        "fields": ["<string>"]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt: '',
    items: [{}],
    output_schema: [
      {
        name: '<string>',
        description: '<string>',
        type: 'string',
        array_element_type: '<string>',
        unit: '<string>',
        enum: ['<string>'],
        items_enum: ['<string>'],
        sample_values: ['<string>'],
        required: true,
        merge: true,
        pattern: '<string>',
        pattern_message: '<string>',
        min_length: 123,
        max_length: 123,
        minimum: 123,
        maximum: 123,
        unique: true,
        semantic_type: '<string>'
      }
    ],
    attribute_sets: {},
    source_hint_sets: {},
    allowed_domains: ['<string>'],
    blocked_domains: ['<string>'],
    speed: 'deep',
    web_search: true,
    max_rows: 123,
    taxonomy: {},
    predict_taxonomy: false,
    predict_taxonomy_attributes: true,
    validate_semantics: false,
    review_mode: true,
    audit_decisions_enabled: true,
    include_source_explanations: true,
    low_confidence: {
      enabled: false,
      scopes: ['<string>'],
      placement: 'tail',
      max_candidates_per_item: 8
    },
    catalog_id: '<string>',
    template_id: '<string>',
    async_mode: false,
    staged_status: 'pending',
    source_activity_id: '<string>',
    source_catalog_id: '<string>',
    file_name: '<string>',
    include_service_usage: false,
    include_debug_log: false,
    capture_source_artifacts: false,
    reextract_from_activity_id: '<string>',
    global_feedback: '<string>',
    item_feedback: {},
    source_row_indices: [123],
    webhook_url: '<string>',
    knowledge_base_enabled: false,
    knowledge_base_vector_store_id: '<string>',
    knowledge_base_sources: {},
    knowledge_base_metadata: {},
    host_media: false,
    strict_hosted_media: false,
    image_processing: {
      enabled: false,
      make_square: true,
      background_color: '#FFFFFF',
      min_side_px: 500,
      max_side_px: 1700,
      output_format: 'jpeg',
      quality: 92,
      force_reprocess_hosted: false,
      fields: ['<string>']
    }
  })
};

fetch('https://catalogapi.rastro.ai/api/public/enrich', 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://catalogapi.rastro.ai/api/public/enrich",
  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([
    'prompt' => '',
    'items' => [
        [
                
        ]
    ],
    'output_schema' => [
        [
                'name' => '<string>',
                'description' => '<string>',
                'type' => 'string',
                'array_element_type' => '<string>',
                'unit' => '<string>',
                'enum' => [
                                '<string>'
                ],
                'items_enum' => [
                                '<string>'
                ],
                'sample_values' => [
                                '<string>'
                ],
                'required' => true,
                'merge' => true,
                'pattern' => '<string>',
                'pattern_message' => '<string>',
                'min_length' => 123,
                'max_length' => 123,
                'minimum' => 123,
                'maximum' => 123,
                'unique' => true,
                'semantic_type' => '<string>'
        ]
    ],
    'attribute_sets' => [
        
    ],
    'source_hint_sets' => [
        
    ],
    'allowed_domains' => [
        '<string>'
    ],
    'blocked_domains' => [
        '<string>'
    ],
    'speed' => 'deep',
    'web_search' => true,
    'max_rows' => 123,
    'taxonomy' => [
        
    ],
    'predict_taxonomy' => false,
    'predict_taxonomy_attributes' => true,
    'validate_semantics' => false,
    'review_mode' => true,
    'audit_decisions_enabled' => true,
    'include_source_explanations' => true,
    'low_confidence' => [
        'enabled' => false,
        'scopes' => [
                '<string>'
        ],
        'placement' => 'tail',
        'max_candidates_per_item' => 8
    ],
    'catalog_id' => '<string>',
    'template_id' => '<string>',
    'async_mode' => false,
    'staged_status' => 'pending',
    'source_activity_id' => '<string>',
    'source_catalog_id' => '<string>',
    'file_name' => '<string>',
    'include_service_usage' => false,
    'include_debug_log' => false,
    'capture_source_artifacts' => false,
    'reextract_from_activity_id' => '<string>',
    'global_feedback' => '<string>',
    'item_feedback' => [
        
    ],
    'source_row_indices' => [
        123
    ],
    'webhook_url' => '<string>',
    'knowledge_base_enabled' => false,
    'knowledge_base_vector_store_id' => '<string>',
    'knowledge_base_sources' => [
        
    ],
    'knowledge_base_metadata' => [
        
    ],
    'host_media' => false,
    'strict_hosted_media' => false,
    'image_processing' => [
        'enabled' => false,
        'make_square' => true,
        'background_color' => '#FFFFFF',
        'min_side_px' => 500,
        'max_side_px' => 1700,
        'output_format' => 'jpeg',
        'quality' => 92,
        'force_reprocess_hosted' => false,
        'fields' => [
                '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://catalogapi.rastro.ai/api/public/enrich"

	payload := strings.NewReader("{\n  \"prompt\": \"\",\n  \"items\": [\n    {}\n  ],\n  \"output_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"type\": \"string\",\n      \"array_element_type\": \"<string>\",\n      \"unit\": \"<string>\",\n      \"enum\": [\n        \"<string>\"\n      ],\n      \"items_enum\": [\n        \"<string>\"\n      ],\n      \"sample_values\": [\n        \"<string>\"\n      ],\n      \"required\": true,\n      \"merge\": true,\n      \"pattern\": \"<string>\",\n      \"pattern_message\": \"<string>\",\n      \"min_length\": 123,\n      \"max_length\": 123,\n      \"minimum\": 123,\n      \"maximum\": 123,\n      \"unique\": true,\n      \"semantic_type\": \"<string>\"\n    }\n  ],\n  \"attribute_sets\": {},\n  \"source_hint_sets\": {},\n  \"allowed_domains\": [\n    \"<string>\"\n  ],\n  \"blocked_domains\": [\n    \"<string>\"\n  ],\n  \"speed\": \"deep\",\n  \"web_search\": true,\n  \"max_rows\": 123,\n  \"taxonomy\": {},\n  \"predict_taxonomy\": false,\n  \"predict_taxonomy_attributes\": true,\n  \"validate_semantics\": false,\n  \"review_mode\": true,\n  \"audit_decisions_enabled\": true,\n  \"include_source_explanations\": true,\n  \"low_confidence\": {\n    \"enabled\": false,\n    \"scopes\": [\n      \"<string>\"\n    ],\n    \"placement\": \"tail\",\n    \"max_candidates_per_item\": 8\n  },\n  \"catalog_id\": \"<string>\",\n  \"template_id\": \"<string>\",\n  \"async_mode\": false,\n  \"staged_status\": \"pending\",\n  \"source_activity_id\": \"<string>\",\n  \"source_catalog_id\": \"<string>\",\n  \"file_name\": \"<string>\",\n  \"include_service_usage\": false,\n  \"include_debug_log\": false,\n  \"capture_source_artifacts\": false,\n  \"reextract_from_activity_id\": \"<string>\",\n  \"global_feedback\": \"<string>\",\n  \"item_feedback\": {},\n  \"source_row_indices\": [\n    123\n  ],\n  \"webhook_url\": \"<string>\",\n  \"knowledge_base_enabled\": false,\n  \"knowledge_base_vector_store_id\": \"<string>\",\n  \"knowledge_base_sources\": {},\n  \"knowledge_base_metadata\": {},\n  \"host_media\": false,\n  \"strict_hosted_media\": false,\n  \"image_processing\": {\n    \"enabled\": false,\n    \"make_square\": true,\n    \"background_color\": \"#FFFFFF\",\n    \"min_side_px\": 500,\n    \"max_side_px\": 1700,\n    \"output_format\": \"jpeg\",\n    \"quality\": 92,\n    \"force_reprocess_hosted\": false,\n    \"fields\": [\n      \"<string>\"\n    ]\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://catalogapi.rastro.ai/api/public/enrich")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"\",\n  \"items\": [\n    {}\n  ],\n  \"output_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"type\": \"string\",\n      \"array_element_type\": \"<string>\",\n      \"unit\": \"<string>\",\n      \"enum\": [\n        \"<string>\"\n      ],\n      \"items_enum\": [\n        \"<string>\"\n      ],\n      \"sample_values\": [\n        \"<string>\"\n      ],\n      \"required\": true,\n      \"merge\": true,\n      \"pattern\": \"<string>\",\n      \"pattern_message\": \"<string>\",\n      \"min_length\": 123,\n      \"max_length\": 123,\n      \"minimum\": 123,\n      \"maximum\": 123,\n      \"unique\": true,\n      \"semantic_type\": \"<string>\"\n    }\n  ],\n  \"attribute_sets\": {},\n  \"source_hint_sets\": {},\n  \"allowed_domains\": [\n    \"<string>\"\n  ],\n  \"blocked_domains\": [\n    \"<string>\"\n  ],\n  \"speed\": \"deep\",\n  \"web_search\": true,\n  \"max_rows\": 123,\n  \"taxonomy\": {},\n  \"predict_taxonomy\": false,\n  \"predict_taxonomy_attributes\": true,\n  \"validate_semantics\": false,\n  \"review_mode\": true,\n  \"audit_decisions_enabled\": true,\n  \"include_source_explanations\": true,\n  \"low_confidence\": {\n    \"enabled\": false,\n    \"scopes\": [\n      \"<string>\"\n    ],\n    \"placement\": \"tail\",\n    \"max_candidates_per_item\": 8\n  },\n  \"catalog_id\": \"<string>\",\n  \"template_id\": \"<string>\",\n  \"async_mode\": false,\n  \"staged_status\": \"pending\",\n  \"source_activity_id\": \"<string>\",\n  \"source_catalog_id\": \"<string>\",\n  \"file_name\": \"<string>\",\n  \"include_service_usage\": false,\n  \"include_debug_log\": false,\n  \"capture_source_artifacts\": false,\n  \"reextract_from_activity_id\": \"<string>\",\n  \"global_feedback\": \"<string>\",\n  \"item_feedback\": {},\n  \"source_row_indices\": [\n    123\n  ],\n  \"webhook_url\": \"<string>\",\n  \"knowledge_base_enabled\": false,\n  \"knowledge_base_vector_store_id\": \"<string>\",\n  \"knowledge_base_sources\": {},\n  \"knowledge_base_metadata\": {},\n  \"host_media\": false,\n  \"strict_hosted_media\": false,\n  \"image_processing\": {\n    \"enabled\": false,\n    \"make_square\": true,\n    \"background_color\": \"#FFFFFF\",\n    \"min_side_px\": 500,\n    \"max_side_px\": 1700,\n    \"output_format\": \"jpeg\",\n    \"quality\": 92,\n    \"force_reprocess_hosted\": false,\n    \"fields\": [\n      \"<string>\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://catalogapi.rastro.ai/api/public/enrich")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"\",\n  \"items\": [\n    {}\n  ],\n  \"output_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"type\": \"string\",\n      \"array_element_type\": \"<string>\",\n      \"unit\": \"<string>\",\n      \"enum\": [\n        \"<string>\"\n      ],\n      \"items_enum\": [\n        \"<string>\"\n      ],\n      \"sample_values\": [\n        \"<string>\"\n      ],\n      \"required\": true,\n      \"merge\": true,\n      \"pattern\": \"<string>\",\n      \"pattern_message\": \"<string>\",\n      \"min_length\": 123,\n      \"max_length\": 123,\n      \"minimum\": 123,\n      \"maximum\": 123,\n      \"unique\": true,\n      \"semantic_type\": \"<string>\"\n    }\n  ],\n  \"attribute_sets\": {},\n  \"source_hint_sets\": {},\n  \"allowed_domains\": [\n    \"<string>\"\n  ],\n  \"blocked_domains\": [\n    \"<string>\"\n  ],\n  \"speed\": \"deep\",\n  \"web_search\": true,\n  \"max_rows\": 123,\n  \"taxonomy\": {},\n  \"predict_taxonomy\": false,\n  \"predict_taxonomy_attributes\": true,\n  \"validate_semantics\": false,\n  \"review_mode\": true,\n  \"audit_decisions_enabled\": true,\n  \"include_source_explanations\": true,\n  \"low_confidence\": {\n    \"enabled\": false,\n    \"scopes\": [\n      \"<string>\"\n    ],\n    \"placement\": \"tail\",\n    \"max_candidates_per_item\": 8\n  },\n  \"catalog_id\": \"<string>\",\n  \"template_id\": \"<string>\",\n  \"async_mode\": false,\n  \"staged_status\": \"pending\",\n  \"source_activity_id\": \"<string>\",\n  \"source_catalog_id\": \"<string>\",\n  \"file_name\": \"<string>\",\n  \"include_service_usage\": false,\n  \"include_debug_log\": false,\n  \"capture_source_artifacts\": false,\n  \"reextract_from_activity_id\": \"<string>\",\n  \"global_feedback\": \"<string>\",\n  \"item_feedback\": {},\n  \"source_row_indices\": [\n    123\n  ],\n  \"webhook_url\": \"<string>\",\n  \"knowledge_base_enabled\": false,\n  \"knowledge_base_vector_store_id\": \"<string>\",\n  \"knowledge_base_sources\": {},\n  \"knowledge_base_metadata\": {},\n  \"host_media\": false,\n  \"strict_hosted_media\": false,\n  \"image_processing\": {\n    \"enabled\": false,\n    \"make_square\": true,\n    \"background_color\": \"#FFFFFF\",\n    \"min_side_px\": 500,\n    \"max_side_px\": 1700,\n    \"output_format\": \"jpeg\",\n    \"quality\": 92,\n    \"force_reprocess_hosted\": false,\n    \"fields\": [\n      \"<string>\"\n    ]\n  }\n}"

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

{
  "total_items": 123,
  "job_id": "<string>",
  "results": [
    {
      "original_data": {},
      "after_data": {},
      "all_sources": [
        "<string>"
      ],
      "error": "<string>",
      "category_id": "<string>",
      "taxonomy_attributes": {},
      "taxonomy_attribute_sources": {},
      "taxonomy_attribute_explanations": {},
      "review_info": {},
      "low_confidence_candidates": [
        {
          "name": "<string>",
          "scope": "field",
          "candidate_value": "<string>",
          "confidence": "LOW",
          "reason": "<string>",
          "sources": [
            "<string>"
          ],
          "source_explanation": "<string>"
        }
      ],
      "low_confidence_fields": [
        "<string>"
      ],
      "staged_change_id": "<string>"
    }
  ],
  "total_rows": 123,
  "successful": 0,
  "credits_used": 0,
  "status": "completed",
  "service_usage": {},
  "pricing_estimates": {},
  "knowledge_base_enabled": true,
  "knowledge_base_sources": {},
  "page": 123,
  "page_size": 123,
  "total_pages": 123,
  "completed_items": 123
}

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

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Organization-Id

string | null

Body

Request to enrich item data.

prompt

string | null

default:""

Search prompt for web enrichment (e.g., 'Find product specifications'). Optional - defaults to empty string.

items

Items · object[]

List of items to enrich. Required unless source_activity_id or source_catalog_id is provided.

output_schema

FieldDefinition · object[]

Schema defining fields to extract. Required unless source_activity_id or source_catalog_id is provided.

Show child attributes

attribute_sets

Attribute Sets · object | null

Canonical registry for requested-attribute jobs. Items carry attribute_set_id; workers expand that id to requested_attributes only at runtime. Per-row requested_attributes payloads are rejected by the public endpoint.

Show child attributes

source_hint_sets

Source Hint Sets · object | null

Canonical registry for repeated per-item source hints. Items carry source_hint_set_id; workers expand that id to source_hints only at runtime. Inline source_hints are rejected by the public endpoint.

allowed_domains

string[] | null

Restrict web scraping to these domains only

blocked_domains

string[] | null

Domains to exclude from web search and URL fetches

speed

string

default:deep

Processing speed: 'fast' (quick), 'medium' (balanced), 'deep'/'slow' (thorough default), 'ultra_slow' (maximum reasoning / strongest model path)

web_search

boolean

default:true

If true (default), performs web search to gather content. If false, skips web search and uses input data directly for extraction/validation.

max_rows

integer | null

Limit processing to first N items. All items are stored. Use source_activity_id to process remaining items later.

taxonomy

Taxonomy · object | null

Taxonomy definition for category prediction (TaxonomyInput format)

predict_taxonomy

boolean

default:false

If true and taxonomy is provided, predict category_id for each item

predict_taxonomy_attributes

boolean

default:true

If true, also predict taxonomy_attributes after classification. Set false for taxonomy classification only.

validate_semantics

boolean

default:false

If true, AI validates that field values make sense given their descriptions (e.g., email field contains valid email format)

review_mode

boolean

default:true

Run the enrich review agent after enrichment, apply clear output corrections, and attach activity.output.audit decisions. Public enrichment jobs keep this enabled.

audit_decisions_enabled

boolean

default:true

When false, the post-enrichment audit still applies clear output corrections but suppresses human-facing audit decisions/suggestions.

include_source_explanations

boolean

default:true

Include source_explanation for each enriched field (and taxonomy attribute) explaining how the value was derived from sources. Always enabled.

low_confidence

LowConfidenceConfig · object | null

Optional add-on for returning low-confidence candidates at the end of each result

Show child attributes

catalog_id

string | null

Optional catalog ID to link this enrichment job to

template_id

string | null

Optional organization-scoped enrichment template key. Template extraction fields apply to omitted request fields; template-owned safety controls remain enforced.

async_mode

boolean

default:false

If true, returns immediately with job_id instead of waiting for results

staged_status

string

default:pending

Status for staged changes: 'pending' (default, visible to admin) or 'draft' (vendor draft, not visible to admin until submitted)

source_activity_id

string | null

Activity ID of a previous run. Processes all stored items using saved config.

source_catalog_id

string | null

Catalog UUID to read items FROM as the enrichment input. Independent of catalog_id (the write target).

file_name

string | null

Original file name if items were loaded from a file

include_service_usage

boolean

default:false

If true, include detailed service_usage metrics (costs, tokens, per-item stats) in response

include_debug_log

boolean

default:false

If true, capture full audit log per item (raw markdown, tool history, LLM responses) and upload to storage

capture_source_artifacts

boolean

default:false

If true, preserve durable copies of consulted source material for audit trails. Web pages are captured as screenshots; PDFs are copied as PDF files.

reextract_from_activity_id

string | null

Activity ID to re-extract from. Skips web gather, reuses stored web research data. Supports prompt/schema overrides and feedback.

global_feedback

string | null

Feedback to apply to all items during re-extraction (appended to prompt)

item_feedback

Item Feedback · object | null

Per-item feedback keyed by row index as string (e.g. {'0': 'Wrong product', '3': 'Price is in EUR not USD'})

Show child attributes

source_row_indices

integer[] | null

Row indices to re-extract (others carried forward from source). Only used with reextract_from_activity_id.

webhook_url

string | null

HTTPS URL to POST results to when job completes. Must use https://.

knowledge_base_enabled

boolean

default:false

If true, use an uploaded knowledge base (OpenAI vector store) for structured generation.

knowledge_base_vector_store_id

string | null

OpenAI vector store ID containing uploaded knowledge base files.

knowledge_base_sources

Knowledge Base Sources · object | null

Optional SOURCE_X -> source URL mapping used for field-level citations (for example {'SOURCE_1': 'https://.../specs.pdf'}).

Show child attributes

knowledge_base_metadata

Knowledge Base Metadata · object | null

Optional SOURCE_X -> metadata mapping for uploaded knowledge-base files (for example {'SOURCE_1': {'doc_type': 'approved_marketing'}}).

Show child attributes

host_media

boolean

default:false

If true, upload all media URLs (images, PDFs) found in enrichment results to hosted storage, replacing with hosted URLs.

strict_hosted_media

boolean

default:false

If true, media/document output fields are cleared unless the URL is successfully copied to hosted storage.

image_processing

ImageProcessingConfig · object | null

Optional deterministic post-processing for hosted images, such as square white-background catalog normalization.

Show child attributes

Response

Successful Response

Response with enriched data for all items.

total_items

integer

required

Number of items being processed (may be limited by max_rows)

job_id

string | null

Job ID for tracking (always returned). Use this with source_activity_id to trigger full run.

results

EnrichItemResult · object[]

Enrichment results for each item (empty if async_mode=true)

Show child attributes

total_rows

integer | null

Total items passed in the request (before max_rows limit)

successful

integer

default:0

Number of successfully enriched items

credits_used

integer

default:0

Number of credits used (1 per successful item)

status

string

default:completed

Job status: 'running' (async) or 'completed' (sync)

service_usage

Service Usage · object | null

Detailed API usage metrics (costs, calls, tokens) - only present when job is complete

pricing_estimates

Pricing Estimates · object | null

Estimated pricing breakdown (for example knowledge-base storage + model runtime costs when available)

knowledge_base_enabled

boolean | null

Whether this enrichment job used a knowledge base vector store

knowledge_base_sources

Knowledge Base Sources · object | null

SOURCE_X -> hosted document URL mapping for knowledge-base files used by the activity

Show child attributes

page

integer | null

Current page number (1-indexed)

page_size

integer | null

Number of results per page

total_pages

integer | null

Total number of pages available

completed_items

integer | null

Number of items with results available so far (useful while status=running)

Get Workflow Run Status Judge Catalog Rows