AI Studio
Get AI agent by agent ID
Gets an AI Agent using the agent_id parameter.
get/ai_agents/{agent_id}
Path parameters
agent_idstring required
The agent id to get.
Query parameters
fieldsstring[]
The fields to return in the response.
Response
A successful response including the agent.
Example response
{
"id": "1234567890",
"type": "ai_agent",
"origin": "CUSTOM",
"name": "This is my Agent",
"access_state": "enabled",
"created_by": {
"id": "11446498",
"type": "user"
},
"created_at": "2022-01-01T00:00:00Z",
"modified_by": {
"id": "11446498",
"type": "user"
},
"modified_at": "2022-01-01T00:00:00Z",
"icon_reference": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg",
"allowed_entities": [
{
"id": "11446498",
"type": "user"
}
],
"ask": {
"type": "ai_agent_ask",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"warnings": [
"MODEL_INACTIVE"
]
},
"spreadsheet": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"warnings": [
"MODEL_INACTIVE"
]
},
"long_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"warnings": [
"MODEL_INACTIVE"
]
}
},
"text_gen": {
"type": "ai_agent_text_gen",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"basic_gen": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"content_template": "---{content}---",
"warnings": [
"MODEL_INACTIVE"
]
}
},
"extract": {
"type": "ai_agent_extract",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"warnings": [
"MODEL_INACTIVE"
]
}
}
}