System APIs
Creates an AI agent in the current system. New agents are created with local repository scope.
| HTTP method | POST |
| URI | https://api.rambase.net/system/ai-agents |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 7367, 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.
Name
Required/mandatory field
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
This field is optional.
>{String}</Description>ArgumentHint
Placeholder shown in the chat input indicating what kind of input the agent expects; it does not control model behavior
This field is optional.
>{String}</ArgumentHint>Instructions
Required/mandatory field
System instructions that guide the AI agent's behavior
>{String}</Instructions>OwnerCompany
Database that limits the agent's availability; leave empty for system-wide access
This field is optional.
>CompanyId
Company identifier
Minimum value: 100
This field is optional.
>{Integer}</CompanyId>OwnerUser
Optional user identifier that limits the AI agent to one user
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>Name
Required/mandatory field
The visible name of the AI agent
": "{String}",Description
A brief explanation of what the agent does, helping users decide when to use it
This field is optional.
": "{String}",ArgumentHint
Placeholder shown in the chat input indicating what kind of input the agent expects; it does not control model behavior
This field is optional.
": "{String}",Instructions
Required/mandatory field
System instructions that guide the AI agent's behavior
": "{String}",OwnerCompany
Database that limits the agent's availability; leave empty for system-wide access
This field is optional.
": {CompanyId
Company identifier
Minimum value: 100
This field is optional.
": "{Integer}"OwnerUser
Optional user identifier that limits the AI agent to one user
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
| $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] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the 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>Instructions
System instructions that guide the AI agent's behavior
>{String}</Instructions>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>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>IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
>{Boolean}</IsChanged>ChangedBy
EmployeeId of the employee making the change
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
>{Boolean}</IsPendingDeployment>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}",Instructions
System instructions that guide the AI agent's 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}",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}",IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
": "{Boolean}",ChangedBy
EmployeeId of the employee making the change
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
": "{Boolean}"
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:
| Error 100009 HTTP 400 | Missing required input arguments |
| Error 110533 HTTP 404 | AI agent not found |