Skip to content
Follow yggy on LinkedInFollow @yggy_tech on X

Bulk-ingest pre-chunked content onto the cold path

POST
/api/v1/documents/bulk-chunks
curl --request POST \
--url https://api.yggy.tech/api/v1/documents/bulk-chunks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "document": {}, "embeddingModel": "external", "chunks": [ { "chunkId": "example", "text": "example", "embedding": [ 1 ], "entities": [], "triples": [] } ], "projectId": "example" }'

Accepts pre-chunked, optionally pre-embedded payloads from an external pipeline. Triples are archived in cold storage; their entities are created without relations. Requires a project, because archived triples always belong to a project.

host
string | null
x-yggy-organization-id
string | null
Media type application/json
object
document
object
externalId
string
>= 1 characters <= 500 characters
title
string
<= 500 characters
source
string
<= 500 characters
embeddingModel
string
default: external >= 1 characters <= 200 characters
chunks
required
Array<object>
>= 1 items <= 200 items
object
chunkId
required
string
>= 1 characters <= 500 characters
text
required
string
>= 1 characters <= 100000 characters
embedding
Array<number>
>= 1 items <= 4096 items
entities
Array<object>
default: <= 200 items
object
externalId
required
string
>= 1 characters <= 500 characters
label
required
string
>= 1 characters <= 500 characters
type
required
string
>= 1 characters <= 200 characters
triples
Array<object>
default: <= 500 items
object
subject
required
string
>= 1 characters <= 500 characters
predicate
required
string
>= 1 characters <= 200 characters
object
required
string
>= 1 characters <= 500 characters
confidence
number
<= 1
projectId

Project ID to bind the bulk ingest to (org-level route only)

string

Bulk chunks accepted onto the cold path

Media type application/json
object
success
required
boolean
documentId
required
string
internalId
required
string
chunks
required
number
triples
required
number
entities
required
number
vectorsUpserted
required
number
embedsEnqueued
required
number
Example
{
"success": true
}

Invalid request

Media type application/json
object
success
boolean
error
required
string
message
string
Example
{
"success": false
}

Project access denied

Media type application/json
object
success
boolean
error
required
string
message
string
Example
{
"success": false
}

Failed to ingest bulk chunks

Media type application/json
object
success
boolean
error
required
string
message
string
Example
{
"success": false
}