System APIs
Updates an AI agent's editable fields.
| HTTP method | PUT |
| URI | https://api.rambase.net/system/ai-agents/{aiAgentId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {aiAgentId} |
AI agent identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 7368, version 2 |
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.
AiAgent
This field is optional.
>Name
The visible name of the AI agent
This field is optional.
>{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
System instructions that guide the AI agent's behavior
This field is optional.
>{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>AiAgent
This field is optional.
": {Name
The visible name of the AI agent
This field is optional.
": "{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
System instructions that guide the AI agent's behavior
This field is optional.
": "{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. |
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. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
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 110533 HTTP 404 | AI agent not found |
| Error 110530 HTTP 400 | Global AI agents cannot be assigned to a database or user. |