NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Exist connects to a Nagent workspace with OAuth sign-in. Once it is connected, agents can call 12 Exist actions, such as "Get Attributes With Values", "Get Attribute Templates" and "Get Averages". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Exist, with input parameters and output schema.
EXIST_ACQUIRE_ATTRIBUTE_OWNERSHIPTool to acquire ownership of attributes for the authenticated user. Allows your service to write data to these attributes. Use when you need to create or take ownership of attributes before writing data. Acquiring a templated attribute the user doesn't have yet will create this attribute and give you ownership.
Input parameters
List of attributes to acquire ownership of (maximum 35)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
EXIST_GET_ATTRIBUTES_WITH_VALUESTool to retrieve attributes with their current values for the authenticated user. Use when you need both attribute metadata and their historical values. Results are limited to your read scopes.
Input parameters
Page number for pagination (1-based indexing)
Page size for pagination (number of attributes per page)
Filter to only attributes in these groups, as comma-separated list of group names (e.g., 'activity,workouts')
Maximum date for values in ISO format YYYY-MM-DD (e.g., '2024-12-31')
Minimum date for values in ISO format YYYY-MM-DD (e.g., '2024-01-01')
Filter to only these attributes, as comma-separated list of attribute names (e.g., 'steps,sleep')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
EXIST_GET_ATTRIBUTE_TEMPLATESTool to retrieve a paged list of supported attribute templates. Use when you need to browse available templates before creating or updating data.
Input parameters
Page index, starting at 1
Number of results per page
Filter by groups, e.g., \['activity','workouts'\]
Include templates with priority >= 10
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
EXIST_GET_AVERAGESTool to retrieve the most recent average values for each tracked attribute, with one set per week. Returns overall weekly averages plus daily breakdowns (Monday-Sunday). Use include_historical flag to retrieve historical average records.
Input parameters
Page index, 1-based. Defaults to 1.
Number of results per page.
Filter by attribute groups. Provide a list, e.g. \['activity','workouts'\].
Maximum (most recent) date inclusive, in yyyy-mm-dd format.
Minimum (oldest) date inclusive, in yyyy-mm-dd format.
Filter by specific attributes. Provide a list, e.g. \['steps','floors'\].
Set true to retrieve historical average records.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
EXIST_GET_CORRELATIONSRetrieve a paginated list of correlations discovered between tracked attributes in the last week. Correlations reveal statistical relationships between different metrics (e.g., sleep duration vs mood). Filter by relationship strength, confidence level (statistical significance), or specific attributes. Returns correlation coefficients, p-values, and human-readable descriptions.
Input parameters
Page index (default 1)
Number of items per page (max 100)
Filter to return only correlations above a certain relationship strength threshold (stronger correlations indicate closer relationships between attributes)
Filter correlations to this attribute name
Filter to return only correlations with five-star confidence (highest statistical significance, certain to be related)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
EXIST_GET_INSIGHTSTool to retrieve automatically-generated insights about patterns in tracked data for the authenticated user. Insights are observations about correlations, trends, and anomalies (e.g., "You walked more on days you slept well"). Use when analyzing user behavior patterns or displaying personalized feedback.
Input parameters
Page index, 1-based. Defaults to 1.
Number of insights to return per page (max 100)
Most recent date (inclusive) of results to be returned, in format YYYY-MM-DD
Oldest date (inclusive) of results to be returned, in format YYYY-MM-DD
Filter by insight priority, where 1 = today and 4 = last month
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
EXIST_GET_OWNED_ATTRIBUTESTool to retrieve attributes owned by your service for the authenticated user. Use when you need to limit data updates to only the attributes your service controls.
Input parameters
Page index, 1-based. Defaults to 1.
Number of results per page.
Filter by attribute groups. Provide a list, e.g. \['activity','workouts'\].
If true, only manual attributes; if false, excludes them.
Filter by attribute names. Provide a list, e.g. \['sleep_efficiency','steps'\].
If true, only templated attributes are returned.
If true, includes inactive attributes (active=false).
If true, includes attributes with priority >= 10.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
EXIST_GET_USER_ATTRIBUTESTool to retrieve a paged list of the user's attributes without values. Use when you need metadata on available attributes for filtering or selection. Omitting `groups` and `attributes` filters returns the full attribute catalog; use those filters to narrow results and avoid oversized responses.
Input parameters
Page index, 1-based. Defaults to 1.
Number of results per page.
If true, only attributes owned by this client are returned.
Filter by attribute groups. Provide a list, e.g. \['activity','workouts'\].
If true, only manual attributes; if false, excludes them.
Filter by attribute names. Provide a list, e.g. \['sleep_efficiency','steps'\].
If true, only templated attributes are returned.
If true, includes inactive attributes (active=false).
If true, includes attributes with priority >= 10.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
EXIST_GET_USER_PROFILETool to retrieve the authenticated user's profile details and preferences. Use after authentication to inspect account settings and status. OAuth scopes granted during authentication determine which fields are returned; missing fields indicate insufficient scopes. Response includes a timezone field; use it when interpreting any date-based attributes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
EXIST_INCREMENT_ATTRIBUTE_VALUESTool to increment attribute values by a delta amount rather than setting totals. Use for counters and cumulative data. Does not work with string, scale, or time of day attributes.
Input parameters
List of attributes to increment with name, date, and delta value. Does not work with string, scale, or time of day attributes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
EXIST_OAUTH2_AUTHORIZEConstructs an OAuth2 authorization URL for Exist.io. This tool generates the URL that users must visit in their browser to grant permissions to your application. After user consent, Exist redirects back to your redirect_uri with an authorization code that can be exchanged for an access token. This action does not make an API call - it only builds the authorization URL.
Input parameters
Space-separated list of permission scopes to request. Available scopes follow the pattern \[category\]_read or \[category\]_write. Categories include: activity, productivity, mood, sleep, workouts, events, finance, food, health, location, media, social, weather, custom, and manual. Example: 'activity_read mood_write custom_read'
Optional opaque value used to maintain state between the authorization request and callback. Recommended for CSRF protection - generate a random token, store it in your session, and verify it matches when the user returns to your redirect_uri
The client application's ID, as assigned by Exist
HTTPS URI where the user will be redirected after authorization. Must match the redirect URI registered with your Exist OAuth2 client application. The authorization code will be appended as a query parameter to this URI
OAuth2 response type. Must be 'code' for authorization code flow. This parameter defaults to 'code' and typically does not need to be changed
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
EXIST_RELEASE_ATTRIBUTE_OWNERSHIPTool to release ownership of attributes for the authenticated user. Use when your service will stop providing data for an attribute or becomes inactive.
Input parameters
List of attributes to release ownership of. Maximum 35 attributes per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 12 Exist actions on Nagent, including "Get Attributes With Values", "Get Attribute Templates" and "Get Averages". Get Attributes With Values: Retrieve attributes with their current values for the authenticated user. Each action is listed on this page with its input parameters and its output.
Exist connects with OAuth sign-in, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It also takes 6 optional inputs: page, limit, groups, date_max, date_min and attributes. It returns data, error and successful.