write scope on your API key.
GET /v1/data
Retrieve a paginated list of all data objects in your account, ordered by your chosen sort field. Use thepage and limit parameters to work through large datasets efficiently.
Query Parameters
integer
default:"1"
The page number to retrieve. Starts at
1.integer
default:"20"
The number of items to return per page. Maximum is
100.string
default:"date"
The field by which results are ordered. Accepted values:
date— orders by creation date, newest first (default)title— orders alphabetically by title
Example Request
Example Response
Response Fields
array
An array of data objects belonging to your account, ordered by the
sort parameter.integer
The total number of data objects in your account across all pages.
POST /v1/data
Create a new data object in your account. You can attach free-form content, an array of searchable tags, and arbitrary key-value metadata to every object you create. This endpoint requires write scope and returns a201 Created response containing the newly created object.
Request Body
string
required
A short, descriptive title for the data object. This field is indexed for full-text search and displayed in search results.
string
required
The object type. Accepted values:
document— a longer-form text artifact such as a report or articlenote— a brief, informal piece of textrecord— a structured entry, often used for tabular or log data
string
The main body text of the data object. This field is fully indexed for search and supports plain text. There is no enforced maximum length, but objects with very large content bodies may affect indexing latency.
array
An array of string tags to associate with the object. Tags are indexed and can be used with the Search API’s
filter parameter — for example, filter=tags:finance. Each tag must be a non-empty string.object
An arbitrary key-value object for storing additional structured attributes alongside your data. Keys and values must both be strings. Metadata is not currently searchable but is returned in full on every object response.
Example Request
Example Response
Response Fields
string
The unique identifier for the newly created data object, prefixed with
dat_.string
The title of the data object as provided in the request body.
string
The object type. One of
document, note, or record.string
The main body text of the data object, as provided in the request body.
array
The array of string tags associated with the object.
object
The key-value metadata object attached to the data object.
string
The ISO 8601 timestamp at which the data object was created, in UTC.
After a successful
POST, the new data object will be available via GET /v1/data immediately. However, it may take up to 30 seconds for the object to become searchable via GET /v1/search while the search index is updated.DELETE /v1/data/
Permanently delete a data object from your account. Once deleted, the object and all of its associated content, tags, and metadata are removed and cannot be recovered. This endpoint requires write scope and returns204 No Content on success with an empty response body.
Path Parameters
string
required
The unique identifier of the data object you want to delete, for example
dat_abc123. You can obtain this from the GET /v1/data listing or from the response of a POST /v1/data request.Example Request
204 No Content with no body.
Response Fields
This endpoint returns no response body. A204 No Content status code indicates the data object was successfully deleted.