Data Ingestion API — Push Documents to Your Opensolr Index Programmatically

POST https://api.opensolr.com/solr_manager/api/ingest

// Parameters (form-encoded or JSON body):
email       = your@email.com
api_key     = your_api_key
core_name   = your_index_name
documents   = [JSON array of document objects]

{
  "status": true,
  "msg": "QUEUED",
  "job_id": "a1b2c3d4e5f6...",
  "total_docs": 25,
  "doc_ids": ["e8392e28...", "a3f1c9d0..."]
}

GET https://api.opensolr.com/solr_manager/api/ingest_status

email       = your@email.com
api_key     = your_api_key
job_id      = a1b2c3d4e5f6...

{
  "status": true,
  "job": {
    "state_label": "completed",
    "total_docs": 25,
    "processed_docs": 25,
    "success_docs": 24,
    "failed_docs": 1,
    "result": [...per-doc details...]
  }
}

// The crawler indexed https://example.com/products/widget-a
// Submit the same uri via API to update it (id = md5(uri) is generated automatically):
{
  "title": "Widget A — Updated Price",
  "description": "Now only $29.99",
  "text": "Full updated product description...",
  "uri": "https://example.com/products/widget-a",
  "content_type": "text/html",
  "timestamp": 1741392000
}

curl -X POST https://api.opensolr.com/solr_manager/api/ingest \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","api_key":"YOUR_API_KEY","core_name":"my_index","documents":[{"uri":"https://example.com/page-1","title":"Page One","description":"First page description","text":"Full text content of page one.","content_type":"text/html"},{"uri":"https://example.com/page-2","title":"Page Two","description":"Second page description","text":"Full text content of page two.","content_type":"text/html","category":"Docs","timestamp":1741392000}]}'

# Full payload in the file (recommended for large batches):
curl -X POST https://api.opensolr.com/solr_manager/api/ingest \
  -F "payload_file=@my_documents.json"

# Or auth as form fields, documents in the file:
curl -X POST https://api.opensolr.com/solr_manager/api/ingest \
  -F "email=you@example.com" \
  -F "api_key=YOUR_API_KEY" \
  -F "core_name=my_index" \
  -F "payload_file=@my_documents.json"

// Method 1: JSON body
$payload = [
    'email'     => 'you@example.com',
    'api_key'   => 'YOUR_API_KEY',
    'core_name' => 'my_index',
    'documents' => [
        [
            'uri'         => 'https://example.com/page-1',
            'title'       => 'Page One',
            'description' => 'First page description',
            'text'        => 'Full text content of page one.',
            'content_type'=> 'text/html',
        ],
        [
            'uri'         => 'https://example.com/page-2',
            'title'       => 'Page Two',
            'description' => 'Second page description',
            'text'        => 'Full text content of page two.',
            'content_type'=> 'text/html',
            'category'    => 'Docs',
            'timestamp'   => 1741392000,
        ],
    ],
];

$ch = curl_init('https://api.opensolr.com/solr_manager/api/ingest');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode($payload),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

if ($response['status']) {
    echo "Queued! Job ID: " . $response['job_id'] . "\n";
    echo "Doc IDs: " . implode(', ', $response['doc_ids']) . "\n";
} else {
    echo "Error: " . $response['msg'] . "\n";
    if (!empty($response['errors'])) {
        foreach ($response['errors'] as $err) echo "  - $err\n";
    }
}

// Method 2: File upload
$ch = curl_init('https://api.opensolr.com/solr_manager/api/ingest');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS     => [
        'payload_file' => new CURLFile('/path/to/my_documents.json', 'application/json'),
    ],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

import requests, json

# Method 1: JSON body
payload = {
    "email": "you@example.com",
    "api_key": "YOUR_API_KEY",
    "core_name": "my_index",
    "documents": [
        {
            "uri": "https://example.com/page-1",
            "title": "Page One",
            "description": "First page description",
            "text": "Full text content of page one.",
            "content_type": "text/html",
        },
        {
            "uri": "https://example.com/page-2",
            "title": "Page Two",
            "description": "Second page description",
            "text": "Full text content of page two.",
            "content_type": "text/html",
            "category": "Docs",
            "timestamp": 1741392000,
        },
    ],
}

resp = requests.post(
    "https://api.opensolr.com/solr_manager/api/ingest",
    json=payload,
)
data = resp.json()

if data["status"]:
    print(f"Queued! Job ID: {data['job_id']}")
    print(f"Doc IDs: {data['doc_ids']}")
else:
    print(f"Error: {data['msg']}")
    for err in data.get("errors", []):
        print(f"  - {err}")

# Method 2: File upload
with open("my_documents.json", "rb") as f:
    resp = requests.post(
        "https://api.opensolr.com/solr_manager/api/ingest",
        files={"payload_file": ("payload.json", f, "application/json")},
    )
    print(resp.json())

# Check job status
status = requests.get("https://api.opensolr.com/solr_manager/api/ingest_status", params={
    "email": "you@example.com",
    "api_key": "YOUR_API_KEY",
    "job_id": data["job_id"],
}).json()
print(f"State: {status['job']['state_label']}, Progress: {status['job']['processed_docs']}/{status['job']['total_docs']}")