Dynamic_behavior_set
Retrieve dynamic behavior sets that match the given filters.
Permissions
This endpoint may be impacted by the following permissions:
Only dynamic behavior sets that the authenticated user has
DynamicBehaviorInstruction:GetDynamicBehaviorInstructionpermission for will be retrieved.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The IDs of the dynamic behavior sets to retrieve.
[]The maximum number of dynamic behavior sets to return.
50The continuation token to use to retrieve the next set of dynamic behavior sets.
0Whether the dynamic behavior set is active.
The IDs of the services that the dynamic behavior set is applied to.
[]The creators of the dynamic behavior sets.
[]The tags of the dynamic behavior sets. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.
[]The fields to sort the sets by. Supported fields are updated_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
[]The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 500 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/dynamic_behavior_set/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"dynamic_behavior_sets": [
{
"id": "text",
"name": "text",
"is_active": true,
"applied_to_services": [
"text"
],
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_at": "2025-11-13T18:52:56.105Z",
"creator": {
"org_id": "text",
"user_id": "text"
},
"updated_at": "2025-11-13T18:52:56.105Z",
"updated_by": {
"org_id": "text",
"user_id": "text"
}
}
],
"has_more": true,
"continuation_token": 1,
"filter_values": {
"applied_to_services_ids": [
"text"
],
"creators": [
{
"org_id": "text",
"user_id": "text"
}
],
"tags": [
"text"
]
}
}Create a new dynamic behavior set as well as its initial version.
Permissions
This endpoint requires the following permissions:
DynamicBehaviorInstruction:CreateDynamicBehaviorInstructionon the set to create.DynamicBehaviorInstruction:UpdateDynamicBehaviorInstructionon the set to create.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
[]The name of the dynamic behavior set.
The services that the dynamic behavior set should be applied to.
Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization or service does not exist.
If the initial version is defined and is_active is set to True, an active dynamic behavior set with the same name already exists.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 200 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/dynamic_behavior_set/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 234
{
"name": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"applied_to_services": [
"text"
],
"initial_version": {
"is_active": true,
"conversation_triggers": [
"text"
],
"action": {
"type": "text",
"instruction": "text",
"overrides_instructions": true
}
}
}{
"dynamic_behavior_set_id": "text"
}Update a dynamic behavior set.
Permissions
This endpoint requires the following permissions:
DynamicBehaviorInstruction:UpdateDynamicBehaviorInstructionon the dynamic behavior set to update.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The ID of the dynamic behavior set to delete.
^[a-f0-9]{24}$The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
[]The name of the dynamic behavior set.
The tags of the dynamic behavior set. Both the key and the value can only contain alphanumeric characters, underscores, or spaces.
The services that the dynamic behavior set should be applied to.
Whether the dynamic behavior set is active.
Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization, dynamic behavior set, or service does not exist.
Another active set with the same name already exists.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 500 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/dynamic_behavior_set/{dynamic_behavior_set_id}/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 105
{
"name": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"applied_to_services": [
"text"
],
"is_active": true
}No content
Delete a dynamic behavior instruction
Delete a dynamic behavior set.
Permissions
This endpoint requires the following permissions:
DynamicBehaviorInstruction:DeleteDynamicBehaviorInstructionon the dynamic behavior set to delete.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The ID of the dynamic behavior set to delete.
^[a-f0-9]{24}$The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
The specified organization or dynamic behavior set does not exist.
Invalid request path parameter failed validation.
The user has exceeded the rate limit of 500 requests per minute for this endpoint.
The service is going through temporary maintenance.
DELETE /v1/{organization}/dynamic_behavior_set/{dynamic_behavior_set_id}/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
No content
Get dynamic behavior set versions
Get the versions of a dynamic behavior set.
Permissions
This endpoint requires the following permissions:
DynamicBehaviorInstruction:GetDynamicBehaviorInstructionfor the dynamic behavior set to retrieve.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The ID of the dynamic behavior set.
^[a-f0-9]{24}$The versions of the dynamic behavior set to retrieve. One can specify an exact version to retrieve, which is either the version number or latest,
which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by -,
and every version within the range would be retrieved.
1The maximum number of dynamic behavior set versions to return.
10The continuation token from the previous request used to retrieve the next page of dynamic behavior set versions.
0The fields to sort the versions by. Supported fields are version. Specify a + before the field name to indicate ascending sorting and -
for descending sorting. Multiple fields can be specified to break ties.
[]The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization or dynamic behavior set is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 1000 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/dynamic_behavior_set/{dynamic_behavior_set_id}/version/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"dynamic_behavior_set_versions": [
{
"_id": "text",
"org_id": "text",
"created_at": "2025-11-13T18:52:56.105Z",
"updated_at": "2025-11-13T18:52:56.105Z",
"dynamic_behavior_set_id": "text",
"version": 1,
"conversation_triggers": [
"text"
],
"action": {
"type": "text",
"instruction": "text",
"overrides_instructions": true
}
}
],
"has_more": true,
"continuation_token": 1
}Create a new version of a dynamic behavior set.
Create a new version of the given dynamic behavior set.
Permissions
This endpoint requires the following permissions:
DynamicBehaviorInstruction:UpdateDynamicBehaviorInstructionon the dynamic behavior set to create a new version for.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The ID of the dynamic behavior set to delete.
^[a-f0-9]{24}$The version number of the new version. If specified, this endpoint throws an error if the next version in the database doesn't equal to the value of this parameter.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
[]The conversation triggers for the dynamic behavior set version.
Succeeded.
The specified version number is not the expected next version to be created.
Invalid authorization credentials.
Missing required permissions.
The specified organization or dynamic behavior set does not exist.
Invalid request path parameter, request query parameter, or request body failed validation.
The user has exceeded the rate limit of 200 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/dynamic_behavior_set/{dynamic_behavior_set_id}/version/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 110
{
"conversation_triggers": [
"text"
],
"action": {
"type": "text",
"instruction": "text",
"overrides_instructions": true
}
}{
"new_version_number": 1
}Search for dynamic behavior sets that match the given filters and contain the given query in its name and the triggers of its latest version. Only the top 50 results will be returned. The results will be sorted by the relevance of the search query.
Permissions
This endpoint may be impacted by the following permissions:
Only dynamic behavior sets that the authenticated user has
DynamicBehaviorInstruction:GetDynamicBehaviorInstructionpermission for will be retrieved.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The query to search for. Any sets containing the terms in its name and the triggers of its latest version would be returned.
Whether the dynamic behavior set is active.
The IDs of the services that the dynamic behavior set is applied to.
[]The creators of the dynamic behavior sets. Each value must be of the format org_id,user_id.
[]The tags of the dynamic behavior sets. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags.
If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.
[]The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/dynamic_behavior_set/search?query=text HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"dynamic_behavior_sets": [
{
"id": "text",
"name": "text",
"is_active": true,
"applied_to_services": [
"text"
],
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created_at": "2025-11-13T18:52:56.105Z",
"creator": {
"org_id": "text",
"user_id": "text"
},
"updated_at": "2025-11-13T18:52:56.105Z",
"updated_by": {
"org_id": "text",
"user_id": "text"
}
}
]
}Get dynamic behavior invocations
Retrieve the dynamic behavior invocations for a dynamic behavior set.
Permissions
This endpoint requires the following permissions:
DynamicBehaviorInstruction:GetDynamicBehaviorInstructionfor the dynamic behavior set.
This endpoint is impacted by the following permissions:
Only invocations from messages that the authenticated user has the
Conversation:GetMessagepermission for are returned.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The ID of the dynamic behavior set.
^[a-f0-9]{24}$The maximum number of dynamic behavior invocations to return.
30The continuation token from the previous request used to retrieve the next page of dynamic behavior invocations.
0The fields to sort the versions by. Supported fields are invoked_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
[]The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization or dynamic behavior set is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 50 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/dynamic_behavior_set/{dynamic_behavior_set_id}/invocation/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"dynamic_behavior_invocations": [
{
"_id": "text",
"org_id": "text",
"created_at": "2025-11-13T18:52:56.105Z",
"updated_at": "2025-11-13T18:52:56.105Z",
"conversation_id": "text",
"service_id": "text",
"user_id": "text",
"initial_message_id": "text",
"agent_message_id": "text",
"agent_inner_thoughts_ids": [
"text"
],
"dynamic_behavior_set_version_info": [],
"invoked_at": "2025-11-13T18:52:56.105Z",
"external_event_message_ids": [
"text"
]
}
],
"has_more": true,
"continuation_token": 1
}Last updated
Was this helpful?