curl --request GET \
--url http://localhost/api/v1/orchestrate/agents/{id} \
--header 'Authorization: Bearer <token>'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"tools": [
"<string>"
],
"collaborators": [
"<string>"
],
"knowledge_base": [],
"llm": "<string>",
"style": "default",
"supported_apps": [
"slack/askhr"
],
"created_by": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"updated_by": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_by": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"environments": [],
"agent_mapping": {},
"hidden": true,
"display_name": "<string>",
"structured_output": {},
"custom_join_tool": "<string>",
"guidelines": [],
"tags": [
"<string>"
],
"chat_with_docs": {
"enabled": true,
"vector_index": {
"embeddings_model_name": "<string>",
"chunk_size": 400,
"chunk_overlap": 50,
"limit": 10
},
"generation": {
"model_id": "<string>",
"prompt_instruction": "",
"generated_response_length": "Moderate",
"display_text_no_results_found": "I searched my knowledge base, but did not find anything related to your query",
"display_text_connectivity_issue": "I might have information related to your query to share, but am unable to connect to my knowledge base at the moment"
},
"query_rewrite": {
"enabled": true,
"model_id": "<string>"
},
"confidence_thresholds": {
"retrieval_confidence_threshold": "Low",
"response_confidence_threshold": "Low"
},
"citations": {
"citation_title": "How do we know?",
"citations_shown": -1
},
"hap_filtering": {
"output": {
"enabled": false,
"threshold": 0.5
}
}
},
"voice_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additional_properties": {
"starter_prompts": {
"customize": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"prompt": "<string>",
"state": "<string>"
}
]
},
"welcome_content": {
"welcome_message": "<string>",
"description": "<string>"
}
},
"context_access_enabled": true,
"context_variables": []
}
Retrieves details of a specific agent by its id.
curl --request GET \
--url http://localhost/api/v1/orchestrate/agents/{id} \
--header 'Authorization: Bearer <token>'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"tools": [
"<string>"
],
"collaborators": [
"<string>"
],
"knowledge_base": [],
"llm": "<string>",
"style": "default",
"supported_apps": [
"slack/askhr"
],
"created_by": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"updated_by": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_by": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"environments": [],
"agent_mapping": {},
"hidden": true,
"display_name": "<string>",
"structured_output": {},
"custom_join_tool": "<string>",
"guidelines": [],
"tags": [
"<string>"
],
"chat_with_docs": {
"enabled": true,
"vector_index": {
"embeddings_model_name": "<string>",
"chunk_size": 400,
"chunk_overlap": 50,
"limit": 10
},
"generation": {
"model_id": "<string>",
"prompt_instruction": "",
"generated_response_length": "Moderate",
"display_text_no_results_found": "I searched my knowledge base, but did not find anything related to your query",
"display_text_connectivity_issue": "I might have information related to your query to share, but am unable to connect to my knowledge base at the moment"
},
"query_rewrite": {
"enabled": true,
"model_id": "<string>"
},
"confidence_thresholds": {
"retrieval_confidence_threshold": "Low",
"response_confidence_threshold": "Low"
},
"citations": {
"citation_title": "How do we know?",
"citations_shown": -1
},
"hap_filtering": {
"output": {
"enabled": false,
"threshold": 0.5
}
}
},
"voice_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additional_properties": {
"starter_prompts": {
"customize": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"prompt": "<string>",
"state": "<string>"
}
]
},
"welcome_content": {
"welcome_message": "<string>",
"description": "<string>"
}
},
"context_access_enabled": true,
"context_variables": []
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Successful Response
Schema for fetching agent.