NoSQL Databases - API Documentation
Full reference for all commands and admin features.
In all URLs below, replace XXX with your AI Apps Account ID, found in your account settings.
How Endpoints Work
Two ways to call each endpoint - read this first
App Command (API Call)
POST your request to
Mode / Webhook (Direct URL)
POST directly to the endpoint URL shown in each section. The fields go in the POST body as standard form fields (the same fields you would include in an HTML form POST). Use this method for provider webhooks, website forms, or any third-party system that sends form data. No API key is required - the account ID is part of the URL.
POST your request to
https://api.aiappsapi.com with your API key and account ID in the POST body. The fields described in each section below go inside the jsonData POST field as a JSON-encoded string. Use this method when your server is making the call and you have your API credentials available.Mode / Webhook (Direct URL)
POST directly to the endpoint URL shown in each section. The fields go in the POST body as standard form fields (the same fields you would include in an HTML form POST). Use this method for provider webhooks, website forms, or any third-party system that sends form data. No API key is required - the account ID is part of the URL.
Two ways to call each action: You can use the unified
nosqlcommand with an action field set to query, insert, update, or delete. Or you can call the individual shortcut commands (nosqlquery, nosqlinsert, nosqlupdate, nosqldelete) which do the same thing without needing the action field. Both methods are shown in each section below.
Query a Record
command: nosqlcommand (action=query) | shortcut: nosqlquery
Retrieve a single record from a NoSQL table by its unique key. Returns the full data object stored in that record, or an empty array if the record does not exist. Costs 1 credit per call.
POST App Command URL
https://api.aiappsapi.com app: nosql command: nosqlcommand (with action=query)
https://api.aiappsapi.com app: nosql command: nosqlquery
This command is only available as an App Command. It is not available as a direct mode/webhook URL.
Required Fields
| Field Name | Field Key | Notes |
|---|---|---|
| Table Name | table | The name of the NoSQL table to query. Must match a table you created in the admin area. |
| Unique Key | uniqueIndex | The unique identifier for the record you want to retrieve. |
Insert a Record
command: nosqlcommand (action=insert) | shortcut: nosqlinsert
Store a new record or completely replace an existing one. You provide the unique key and a data object containing all the fields and values you want stored. If a record with that key already exists, it is fully replaced with the new data. Costs 2 credits per call.
POST App Command URL
https://api.aiappsapi.com app: nosql command: nosqlcommand (with action=insert)
https://api.aiappsapi.com app: nosql command: nosqlinsert
This command is only available as an App Command. It is not available as a direct mode/webhook URL.
Required Fields
| Field Name | Field Key | Notes |
|---|---|---|
| Table Name | table | The name of the NoSQL table to insert into. |
| Unique Key | uniqueIndex | The unique identifier for this record. If a record with this key already exists, it will be completely replaced. |
| Data | data | A JSON object containing the fields and values to store. Example: {"name": "John", "score": 100} |
Update a Record
command: nosqlcommand (action=update) | shortcut: nosqlupdate
Merge new fields into an existing record. Fields you include are added or overwritten. Fields you do not include are left unchanged. This is perfect for updating one or two values without touching the rest of the record. If no record exists yet, one is created with the provided data. Costs 2 credits per call.
POST App Command URL
https://api.aiappsapi.com app: nosql command: nosqlcommand (with action=update)
https://api.aiappsapi.com app: nosql command: nosqlupdate
This command is only available as an App Command. It is not available as a direct mode/webhook URL.
Required Fields
| Field Name | Field Key | Notes |
|---|---|---|
| Table Name | table | The name of the NoSQL table containing the record. |
| Unique Key | uniqueIndex | The unique identifier of the record to update. |
| Data | data | A JSON object of fields and values to merge into the existing record. Example: {"score": 200} updates only the score field and leaves everything else unchanged. |
Delete a Record
command: nosqlcommand (action=delete) | shortcut: nosqldelete
Permanently delete a record from a NoSQL table by its unique key. This cannot be undone. Costs 2 credits per call.
POST App Command URL
https://api.aiappsapi.com app: nosql command: nosqlcommand (with action=delete)
https://api.aiappsapi.com app: nosql command: nosqldelete
This command is only available as an App Command. It is not available as a direct mode/webhook URL.
Required Fields
| Field Name | Field Key | Notes |
|---|---|---|
| Table Name | table | The name of the NoSQL table containing the record. |
| Unique Key | uniqueIndex | The unique identifier of the record to delete. |
Admin Area
Managing tables and records from the dashboard
The admin area provides two pages for managing your NoSQL data without writing any code.
Manage Tables
| Feature | Description |
|---|---|
| Create Tables | Create new named tables from the admin dashboard. Give each table a name and it is ready to use immediately via the API. |
| Delete Tables | Remove tables you no longer need. Use the bulk delete checkboxes to remove multiple tables at once. |
Search Records
| Feature | Description |
|---|---|
| Search by Key | Look up any record by entering its unique key. View the full data stored in that record. |
| Create Records | Create new records directly from the admin by entering a record ID. Then use the API to populate the data. |
| Delete Records | Remove individual records from the admin interface. |