Release Notes
- What's new
- Known issues
- Troubleshooting
- License reference
Get Started
Environments
Large Language Models (LLMs)
Webchats
Tutorials
API's reference
- watsonx Orchestrate Developer Edition APIs
- Orchestrate Agent
- Custom Assistants
- watsonx Assistant
- External Chat Agents
- Message Threads
- Models
- Embed settings
- Completions
- Prompts
- Default Agent Settings
- Tools
- Welcome Content
- LLM Analytics
- Agents
- Agent Releases
- GETList Versioned Agents By Environment Name
- GETGet List Of Agent Versions By Id.
- POSTRelease An Agent By Id
- GETGet The Status Of The Agent Deployment
- GETGet An Agent Version By Id And Version
- DELDelete Version Of A Released Agent
- POSTUndeploy A Released Agent
- POSTSwitch Current Agent Version Of An Environment To A New Version.
- GET
- Agent Release Environments
- API Reference
- Channel integration
- Knowledge-Bases
- Toolkits
- GETAlive
- GETReady
Legal notices
Agent Releases
Get An Agent Version By Id And Version
Get an agent version by id and version.
GET
/
orchestrate
/
agents
/
{id}
/
releases
/
{version}
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/orchestrate/agents/{id}/releases/{version} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"name": "<string>",
"description": "<string>",
"version_label": 123,
"instructions": "<string>",
"tools": [],
"collaborators": [],
"llm": "<string>",
"created_by": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>",
"style": "default",
"supported_apps": [
"slack/askhr"
],
"agent_mapping": {},
"deleted_by": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"hidden": false,
"points_to": [],
"display_name": "<string>",
"comments": "<string>",
"mapped_environments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"current_version": 123
}
],
"knowledge_base": [
"<string>"
],
"environments": [],
"structured_output": {},
"custom_join_tool": {},
"deployment_status": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200
application/json
Successful Response
Schema for a complete agent version.
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/orchestrate/agents/{id}/releases/{version} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"name": "<string>",
"description": "<string>",
"version_label": 123,
"instructions": "<string>",
"tools": [],
"collaborators": [],
"llm": "<string>",
"created_by": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>",
"style": "default",
"supported_apps": [
"slack/askhr"
],
"agent_mapping": {},
"deleted_by": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"hidden": false,
"points_to": [],
"display_name": "<string>",
"comments": "<string>",
"mapped_environments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"current_version": 123
}
],
"knowledge_base": [
"<string>"
],
"environments": [],
"structured_output": {},
"custom_join_tool": {},
"deployment_status": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.