Add a document — Skryx Docs

Adds one document to the index. If a document with the same id already exists, this request upserts it — the entire stored document is replaced by the body.

For bulk operations (more than a couple of documents at a time), use the batch endpoint — it's 50–100× faster.

# Body

The body must match your index schema. Unknown fields are rejected with SK-SE-400. Optional fields can be omitted; required fields cannot.

Field	Type	Notes
`id`	string	Required. Your stable identifier.
(schema fields)	per schema	All declared fields are accepted.

# Response

{ "data": { "id": "1", "indexed": true } }

curl -X POST https://api.skryx.io/v1/indexes/products/documents \ -H "Authorization: Bearer $SKRYX_API_KEY" \ -H "Content-Type: application/json" \ -d ' { "id": "1", "title": "Sony WH-1000XM5", "brand": "Sony", "category": "Headphones", "price": 379, "in_stock": true } '

const response = await fetch('https://api.skryx.io/v1/indexes/products/documents', { method: 'POST', headers: { 'Authorization': `Bearer ${process.env.SKRYX_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ id: '1', title: 'Sony WH-1000XM5', brand: 'Sony', category: 'Headphones', price: 379, in_stock: true, }), }); const data = await response.json();

<?php $ch = curl_init('https://api.skryx.io/v1/indexes/products/documents'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . getenv('SKRYX_API_KEY'), 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => json_encode([ 'id' => '1', 'title' => 'Sony WH-1000XM5', 'brand' => 'Sony', 'category' => 'Headphones', 'price' => 379, 'in_stock' => true, ]), ]); $response = json_decode(curl_exec($ch), true);

import os import requests response = requests.post( 'https://api.skryx.io/v1/indexes/products/documents', headers={ 'Authorization': f"Bearer {os.environ['SKRYX_API_KEY']}", 'Content-Type': 'application/json', }, json={ 'id': '1', 'title': 'Sony WH-1000XM5', 'brand': 'Sony', 'category': 'Headphones', 'price': 379, 'in_stock': True, }, ) data = response.json()

require 'net/http' require 'json' uri = URI('https://api.skryx.io/v1/indexes/products/documents') http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = true request = Net::HTTP::Post.new(uri.request_uri, { 'Authorization' => "Bearer #{ENV['SKRYX_API_KEY']}", 'Content-Type' => 'application/json', }) request.body = { 'id' => '1', 'title' => 'Sony WH-1000XM5', 'brand' => 'Sony', 'category' => 'Headphones', 'price' => 379, 'in_stock' => true, }.to_json response = JSON.parse(http.request(request).body)

package main import ( "bytes" "encoding/json" "io" "net/http" "os" ) func main() { body, _ := json.Marshal(map[string]interface{}{ "id": '1', "title": 'Sony WH-1000XM5', "brand": 'Sony', "category": 'Headphones', "price": 379, "in_stock": true, }) req, _ := http.NewRequest("POST", "https://api.skryx.io/v1/indexes/products/documents", bytes.NewBuffer(body)) req.Header.Set("Authorization", "Bearer "+os.Getenv("SKRYX_API_KEY")) req.Header.Set("Content-Type", "application/json") resp, _ := http.DefaultClient.Do(req) defer resp.Body.Close() response, _ := io.ReadAll(resp.Body) _ = response }