System APIs
Lists AI agents visible to the current user, including agents scoped to a system, company, or user.
| HTTP method | GET |
| URI | https://api.rambase.net/system/ai-agents |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 7365, version 1 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| AiAgentId Integer | AI agent identifier. |
| CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| Name String | The visible name of the AI agent. |
| OwnerDatabase String | Database that limits the agent's availability; leave empty for system-wide access. Available macros: currentDB() |
| OwnerUserId Integer | Optional user identifier that limits the AI agent to one user. Available macros: currentUser() |
| Scope String | Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system. |
| Status Integer | Status of the AI agent. |
| UpdatedAt Datetime | Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Read more about filters and sorting on how to use sortable parameters
| AiAgentId Integer | AI agent identifier |
| CreatedAt Datetime | Date and time of creation |
| Name String | The visible name of the AI agent |
| OwnerDatabase String | Database that limits the agent's availability; leave empty for system-wide access |
| OwnerUserId Integer | Optional user identifier that limits the AI agent to one user |
| Scope String | Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system. |
| Status Integer | Status of the AI agent |
| UpdatedAt Datetime | Date and time of update |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
AiAgentId
AI agent identifier
>{Integer}</AiAgentId>Name
The visible name of the AI agent
>{String}</Name>Description
A brief explanation of what the agent does, helping users decide when to use it
>{String}</Description>ArgumentHint
Placeholder shown in the chat input indicating what kind of input the agent expects; it does not control model behavior
>{String}</ArgumentHint>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>OwnerCompany
Database that limits the agent's availability; leave empty for system-wide access
>CompanyId
Company identifier
>{Integer}</CompanyId>Database
Abbreviation/code to identify the company
>{String}</Database>CompanyLink
Company reference
>{String}</CompanyLink>OwnerUser
Optional user identifier that limits the AI agent to one user
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>Repository
Information about the object's repository synchronization.
>Scope
Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.
Possible domain values can be found here
>{String}</Scope>AiAgentLink
A link to the AI agent.
>{String}</AiAgentLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>AiAgentId
AI agent identifier
": "{Integer}",Status
Status of the AI agent
Possible domain values can be found here
": "{Integer}",Name
The visible name of the AI agent
": "{String}",Description
A brief explanation of what the agent does, helping users decide when to use it
": "{String}",ArgumentHint
Placeholder shown in the chat input indicating what kind of input the agent expects; it does not control model behavior
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",UpdatedAt
Date and time of update
": "{Datetime}",OwnerCompany
Database that limits the agent's availability; leave empty for system-wide access
": {CompanyId
Company identifier
": "{Integer}",Database
Abbreviation/code to identify the company
": "{String}",CompanyLink
Company reference
": "{String}"OwnerUser
Optional user identifier that limits the AI agent to one user
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"Repository
Information about the object's repository synchronization.
": {Scope
Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.
Possible domain values can be found here
": "{String}"AiAgentLink
A link to the AI agent.
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return: