V1/service
Was this helpful?
Was this helpful?
Delete the given verion set from the given service.
This endpoint will error if the version set is used in any simulation unit tests.
Permissions
This endpoint requires the following permissions:
User:GetUserInfo for the authenticated user.
Service:GetService for the service.
Service:DeleteVersionSet for the version set.
Identifier of the service.
^[a-f0-9]{24}$Name of the version set.
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.
No content
Retrieve a list of services in this organization.
Permissions
This endpoint requires the following permissions:
User:GetUserInfo for the authenticated user.
This endpoint is impacted by the following permissions:
Only services that the authenticated user has the Service:GetService permission for are returned.
The ID of the service to retrieve.
Whether the service is active.
The fields to sort the versions by. Supported fields are name and is_active. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
[]The maximum number of services to return.
10The continuation token from the previous request used to retrieve the next page of services.
0The 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.
Create a new service. Depending on whether an active service with the same name already exists, the endpoint behaves differently:
If is_active is False, creates an inactive new service.
If is_active is True and no active service with the given name exists, creates a new active service.
If is_active is True and an active service with the given name exists, this endpoint throws an error.
The new service will automatically contain an edge version set that uses the latest Agent and ServiceHierarchicalStateMachine versions with no LLM model preference.
It will also create a release version set, that will equal to what's specified in the request if the release_version_set is specified, or equal to edge if not.
Permissions
This endpoint requires the following permissions:
User:GetUserInfo for the authenticated user.
Service:CreateService for the service to create.
Organization:GetAgent for the specified agent.
Organization:GetServiceHierarchicalStateMachine for the specified service hierarchical state machine.
Service:CreateVersionSet for the edge and release version sets.
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 ID of the state machine that this service uses.
^[a-f0-9]{24}$The ID of the agent that this service uses.
^[a-f0-9]{24}$The name of this service.
A description of this service.
Whether the newly-created service is active. Only active services are visible to users on the dashboard. You can later adjust the activeness of this service.
The release version set to use for this service. If not specified, the release version set will be the same as the edge version set, which uses the
latest agent and state machine versions with no model preference.
The icon to assign to a service. It will be displayed on the dashboard page if set. If not set, a default icon will be used. The icon must be a square-sized PNG file with at least
40 * 40 pixels resolution.
Upsert a version set for the specified service. Replace the existing version set with the same name if any, or create a new one.
Permissions
This endpoint requires the following permissions:
User:GetUserInfo for the authenticated user.
Service:GetService for the service.
This endpoint may require the following permissions:
Service:CreateVersionSet if the version set does not exist.
Service:UpdateVersionSet if the version set already exists.
Organization:GetAgent for the agent if an agent version is specified.
Organization:GetServiceHierarchicalStateMachine for the service hierarchical state machine if a service hierarchical state machine verion is specified.
Identifier of the service.
^[a-f0-9]{24}$Name of the version set to upsert.
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.
No content
Update fields about a service.
Permissions
This endpoint requires the following permissions:
User:GetUserInfo for the authenticated user.
Service:UpdateService for the service.
This endpoint may require the following permissions:
Organization:GetAgent for the specified agent, if any.
Organization:GetServiceHierarchicalStateMachine for the specified service hierarchical state machine, if any.
The identifier of the service to update.
^[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 service. Only updated if not-null.
A description of this Service. Only updates if not-null.
The icon to assign to a service. It will be displayed on the dashboard page if set. If not set, a default icon will be used. The icon must be a square-sized PNG file with at least
40 * 40 pixels resolution.
If not specified or set to an empty object, the field is not updated.
{}A specific type to indicate that a field is not set in the request.
The activeness of the service. Only updated if not-null.
If set to True and the service is currently inactive, no other service with the same name can be active.
If set to False and the service is currently active, it is deactivated. This will error if the service is used in a simulation unit test.
The ID of the agent that this service uses. Only updated if not-null.
^[a-f0-9]{24}$The ID of the service hierarchical state machine that this service uses. Only updated if not-null.
^[a-f0-9]{24}$No content