Skip to main content
POST
/
v1
/
namespaces
/
{namespace}
/
documents
JavaScript
import Charcoal from '@charcoalhq/sdk';

const client = new Charcoal({
  apiKey: process.env['CHARCOAL_API_KEY'], // This is the default and can be omitted
});

const upsertDocumentsResponse = await client.namespaces.documents.upsert('namespace', {
  documents: [{ id: 'id' }],
});

console.log(upsertDocumentsResponse.documents_upserted);
{
  "documents_upserted": 123
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
namespace
string
required

Namespace identifier. Alphanumeric characters, hyphens, underscores, and dots. Max 128 characters.

Maximum string length: 128
Pattern: ^[A-Za-z0-9-_.]{1,128}$

Body

application/json
​
documents
object[]
required
Maximum array length: 10000
​
schema
object

Explicit schema for the documents. If omitted, schema is inferred from the document structure and merged with any existing namespace schema.

Response

Successful response

​
documents_upserted
integer
required