logo STATICALIZA
Home Projects Socials API

DATABASE

Launch your private StativerseDB workspace and get started.

1 MB included for free.

Storage Usage 0 B

PROJECTS

ENDPOINTS

Authorization is required on every request. Use your Stativerse API key in the Authorization: Bearer <key> header. You can create an API key in your account settings. Click any endpoint path to copy the full endpoint shape.

POST /database/list >

Payload

project string Existing project name. Letters, numbers, underscores. 1-32 chars.
collection string Existing collection name. Letters, numbers, underscores. 1-32 chars.
cursor string Optional key cursor. Starts after the provided key.
limit number Optional page size. Defaults to 10. Max 100.

Response

ok boolean True when the request succeeds. False when it fails.
data {...} List response payload when ok is true. >
project string Resolved project scope.
collection string Resolved collection scope.
items [...] Ordered page of key/value items. >
[...] {...} Object shape for each array entry in the current page. >
key string Data key name for the current row.
value any Stored value for the current row.
nextCursor string Cursor for the next page, or null when complete.
hasMore boolean Whether another page is available.
limit number Resolved page size used for the request.
error {...} Null when ok is true. On failure includes public error details. >
code string Normalized public error code.
message string Normalized public error message.
POST /database/get >

Payload

project string Existing project name.
collection string Existing collection name.
key string Target data key. Max 128 chars.

Response

ok boolean True when the request succeeds. False when it fails.
data {...} Get response payload when ok is true. >
project string Resolved project scope.
collection string Resolved collection scope.
key string Requested key.
exists boolean Whether the key exists in the collection.
value any Stored value, or null when the key is missing.
error {...} Null when ok is true. On failure includes public error details. >
code string Normalized public error code.
message string Normalized public error message.
POST /database/set >

Payload

project string Existing project name.
collection string Existing collection name.
key string Target data key. Max 128 chars.
value any String, number, boolean, array, or object. Max 1 KB serialized.

Response

ok boolean True when the request succeeds. False when it fails.
data {...} Set response payload when ok is true. >
project string Resolved project scope.
collection string Resolved collection scope.
key string Stored key name.
created boolean True when the key was created, false when it was overwritten.
value any Stored value after validation.
error {...} Null when ok is true. On failure includes public error details. >
code string Normalized public error code.
message string Normalized public error message.
POST /database/remove >

Payload

project string Existing project name.
collection string Existing collection name.
key string Target data key. Max 128 chars.

Response

ok boolean True when the request succeeds. False when it fails.
data {...} Remove response payload when ok is true. >
project string Resolved project scope.
collection string Resolved collection scope.
key string Requested key.
removed boolean False when the key did not exist.
error {...} Null when ok is true. On failure includes public error details. >
code string Normalized public error code.
message string Normalized public error message.
POST /database/batch >

Payload

requests [...] 1-10 actions per batch. >
[...] {...} Object shape for each batch request entry. >
id string Optional client id. Must be unique when provided.
action string Allowed values: list, get, set, remove.
project string Existing project name.
collection string Existing collection name.
cursor string Optional list cursor. Only used by the list action.
limit number Optional list page size. Defaults to 10. Max 100.
key string Required for get, set, and remove.
value any Required for set.
continueOnError boolean Optional. Defaults to true.

Response

ok boolean True when the request succeeds. False when it fails.
data {...} Batch response payload when ok is true. >
continueOnError boolean Resolved batch execution mode.
results [...] Ordered result list for every batch action. >
[...] {...} Object shape for each batch result entry. >
id string Action id from the request.
action string Executed action name.
ok boolean Per-action success state.
data any Present when the action succeeds. Shape depends on the action.
error {...} Present when the action fails. >
code string Normalized public error code.
message string Normalized public error message.
error {...} Null when ok is true. On failure includes public error details. >
code string Normalized public error code.
message string Normalized public error message.
© Staticaliza