Databases

This section describes the API calls used to create, read, update and delete databases. The page builds upon (and assumes you've read) the API Usage Guide. Please ensure you're familiar with the API calling conventions before reading on.

List all databases

Version
1.0
View
team
Action
list_databases
Request Data
integerlimit

The maximum number of results to return in this page.

stringcursor

A token used to paginate the search results. Cursors returned in previous responses can be used in subsequent requests.

Response Data
integercount

The number of results returned.

booleanhas_more

Whether there are more results on the next page

stringcursor

A token that can be used to request the next page of results. It's only useful if has_more is true.

array<object>results

A list of results.

stringid

The globally unique identifier of the database.

stringname

The display name of the database.

stringmodel

The AI model used for this database. Use cosmopolitan-v10 for any content.

string | nulllanguage

The ISO 639-1 code of the primary natural language of the content in your database, or null.

Fetch a database

Version
1.0
View
team
Action
fetch_database
Request Data
stringid

The globally unique identifier of the database to fetch.

Response Data
stringid

The globally unique identifier of the database.

stringname

The display name of the database.

stringmodel

The AI model used for this database. Use cosmopolitan-v10 for any content.

string | nulllanguage

The ISO 639-1 code of the primary natural language of the content in your database, or null.

Create a database

Version
1.0
View
team
Action
create_database
Request Data
stringname

A display name for your database.

stringmodel

The AI model used for this database. Use cosmopolitan-v10 for any content.

string | nulllanguage

The ISO 639-1 code of the primary natural language of the content in your database, or null.

Response Data
stringid

A globally unique identifier of the newly created database.

Update a database

Version
1.0
View
team
Action
update_database
Request Data
stringid

The globally unique identifier of the database to update.

stringname

The new display name for the database.

Response Data

Always null if successful.

Delete a database

Version
1.0
View
team
Action
delete_database
Request Data
stringid

The globally unique identifier of the database to delete.

Response Data

Always null if successful.

GRAVITAS

© 2021-2025 Noematic.ai