Build agents¶
Generate, regenerate, commit, or cancel candidate plans for an existing agent, and view the resources available during authoring. This page does not cover normal agent creation or version management.
Prerequisites¶
Prepare credentials that can access the target workspace and the ID of the agent to build. For service endpoints, authentication, and general request formats, see Prepare to call an API.
Candidate-plan input and follow-up operations are defined by their action pages. Submitting a candidate plan does not make it the current configuration; commit the candidate to apply it.
Call sequence¶
First get the current agent configuration to confirm the current configuration and target agent.
Query resources available for authoring, then generate a candidate plan.
Regenerate the candidate when you need to adjust it. Commit it when you decide to use it, or cancel it when you do not.
Query the current agent configuration again to confirm the resulting configuration.
API operations¶
View configuration and available resources¶
What you need to do |
API operation |
Use it when |
|---|---|---|
Get the current agent configuration |
Before authoring or to confirm a committed result. |
|
List available authoring resources |
Learn available resources before generating a candidate plan. |
Generate and handle candidate plans¶
What you need to do |
API operation |
Use it when |
|---|---|---|
Generate an agent candidate plan |
Generate a candidate plan for the current target. |
|
Regenerate an agent candidate plan |
Adjust a candidate plan. |
|
Commit an agent candidate plan |
You decided to use the candidate plan. |
|
Cancel an agent candidate plan |
You no longer want to use the candidate plan. |
Confirm the result¶
After committing a candidate plan, use Get the current agent configuration to view the current configuration. Candidate status and commit conditions are defined by the corresponding action page.