Version Sets & Promotion
What Each Special Set Means
Creating and Updating Version Sets
How Version Sets Are Used at Runtime
Recommended Workflow (Git-Branch Style)
Promotion Flow
CLI Commands (forge version-set)
forge version-set)List Version Sets
Create/Update a Version Set
Version Existence Validation
Compare Version Sets
Promote Version Sets
Rollback Version Sets
Show Version Set Details
Delete a Version Set
Discovering Services (forge service)
forge service)List Services
Show Service Details
Check Service Health Status
Discovering Asset Versions (forge asset)
forge asset)List Agent Versions
List Context Graph Versions
Show Version Details
Check Behavior Invocations
Workflow: Pin Discovered Versions
CLI Validation
Validation Rules
Example: Blocked Mutation
Example: Warning (Non-blocking)
Practical Tips
Naming Conventions
API Touchpoints (Operational Behavior)
API References
Create a new service. Depending on whether an active service with the same name already exists, the endpoint behaves differently:
- If
is_activeisFalse, creates an inactive new service. - If
is_activeisTrueand no active service with the given name exists, creates a new active service. - If
is_activeisTrueand 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:
Service:CreateServicefor the service to create.Service:CreateVersionSetfor theedgeandreleaseversion sets.
The username should be set to {org_id}_{user_id}, and the password should be the Amigo issued JWT token that identifies the user.
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 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.
A list of keyterms that are easy to get wrong during audio transcriptions that tend to occur commonly in audio sessions using this service.
Succeeded.
This error could be thrown due to the following reasons:
- The specified ID for agent or service hierarchical state machine versions in the
releaseversion set does not belong to the agent or service hierarchical state machine of the service. - The specified agent or state machine doesn't have any versions.
- The specified LLM config is invalid.
Invalid authorization credentials.
Missing required permissions.
The specified organization, agent, or service hierarchical state machine do not exist.
An active service with the given name already exists.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 20 requests per minute for this endpoint.
The service is going through temporary maintenance.
Upsert a service version set
Upsert a version set for the specified service. Replace the existing version set with the same name if any, or create a new one.
Note that the edge version set cannot be updated.
Permissions
This endpoint may require the following permissions:
Service:CreateVersionSetif the version set does not exist.Service:UpdateVersionSetif the version set already exists.
The username should be set to {org_id}_{user_id}, and the password should be the Amigo issued JWT token that identifies the user.
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.
Identifier of the service.
^[a-f0-9]{24}$Name of the version set to upsert.
^[A-Za-z0-9_-]+$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.
The agent or service hierarchical state machine version in the request do not belong to the agent or state machine of the service, or attempted to update the edge version set, or the supplied LLM config is invalid.
Invalid authorization credentials.
Missing required permissions.
The specified organization or service do not exist.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 30 requests per minute for this endpoint.
The service is going through temporary maintenance.
No content
Delete a service version set
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:
Service:DeleteVersionSetfor the version set.
The username should be set to {org_id}_{user_id}, and the password should be the Amigo issued JWT token that identifies the user.
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.
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.
[]Succeeded.
The specified version set is used in a simulation unit test, or is the edge or release version set.
Invalid authorization credentials.
Missing required permissions.
The specified organization, service, or version set do not exist.
Invalid request path parameter failed validation.
The user has exceeded the rate limit of 30 requests per minute for this endpoint.
The service is going through temporary maintenance.
No content
Last updated
Was this helpful?

