Skip to content
v0.5.1GitHub

Using

Stores a document under a system-generated UUIDv4 key (create-only).

applies to v0.5.1
POST
/store-api/json/{domain}/documents
curl --request POST \
--url https://example.com/store-api/json/example/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'
domain
required
string

JSON domain

Media typeapplication/json
object

Example generated

{}

Document created with generated UUIDv4 key

Media typeapplication/json

A document as returned by the store: _key/_version metadata merged into the user’s fields.

object
_key
required

Document key.

string
_version
required

Write counter: 1 on create, incremented on every write.

integer format: int64
key
additional properties

The document’s own fields. A document whose content is not a JSON object appears as a single _content field holding that value.

Example generated

{
"_key": "example",
"_version": 1
}

Reserved top-level field (_key, _version, _content)

Media typetext/plain
string

Domain not found

Media typetext/plain
string

Domain is being deleted

Media typetext/plain
string

Payload too large

Media typetext/plain
string

JSON engine disabled

Media typetext/plain
string

Insufficient Storage — disk space or memory runs short; the write was not applied. Reads go on; retry after the seconds in Retry-After.

Media typetext/plain
string
Retry-After
integer