Skip to main content
A set of endpoints used to interact with AI Studio.

​
AI agent

Standard representation of an AI Agent instance.
PropertyTypeRequiredDescription
idstringYesThe unique identifier of the AI Agent.
typeenum<string>NoThe type of agent used to handle queries. Available options: ai_agent.
originstringYesThe provider of the AI Agent.
namestringYesThe name of the AI Agent.
access_statestringYesThe state of the AI Agent. Possible values are: enabled, disabled, and enabled_for_selected_users.
created_byUser (Base)NoThe user who created this agent.
created_atstringNoThe ISO date-time formatted timestamp of when this AI agent was created.
modified_byUser (Base)NoThe user who most recently modified this agent.
modified_atstringNoThe ISO date-time formatted timestamp of when this AI agent was recently modified.
icon_referencestringNoThe icon reference of the AI Agent.
allowed_entitiesarray of The entity with type and IDNoList of allowed users or groups.
Example
{
  "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"
    }
  ]
}

​
AI agent (Full)

Full representation of an AI Agent instance.
PropertyTypeRequiredDescription
idstringYesThe unique identifier of the AI Agent.
typeenum<string>NoThe type of agent used to handle queries. Available options: ai_agent.
originstringYesThe provider of the AI Agent.
namestringYesThe name of the AI Agent.
access_statestringYesThe state of the AI Agent. Possible values are: enabled, disabled, and enabled_for_selected_users.
created_byUser (Base)NoThe user who created this agent.
created_atstringNoThe ISO date-time formatted timestamp of when this AI agent was created.
modified_byUser (Base)NoThe user who most recently modified this agent.
modified_atstringNoThe ISO date-time formatted timestamp of when this AI agent was recently modified.
icon_referencestringNoThe icon reference of the AI Agent.
allowed_entitiesarray of The entity with type and IDNoList of allowed users or groups.
askAI agent capability askNo
text_genAI agent capability text generationNo
extractAI agent capability extractNo
Example
{
  "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",
        "temperature": 0,
        "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
        }
      },
      "is_custom_instructions_included": false,
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_text": {
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "llm_endpoint_params": {
        "type": "openai_params",
        "temperature": 0,
        "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}`.",
      "is_custom_instructions_included": false,
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_image": {
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "llm_endpoint_params": {
        "type": "openai_params",
        "temperature": 0,
        "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}`.",
      "is_custom_instructions_included": false,
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "spreadsheet": {
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "llm_endpoint_params": {
        "type": "openai_params",
        "temperature": 0,
        "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",
        "temperature": 0,
        "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
        }
      },
      "is_custom_instructions_included": false,
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_text_multi": {
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "llm_endpoint_params": {
        "type": "openai_params",
        "temperature": 0,
        "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}`.",
      "is_custom_instructions_included": false,
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_image_multi": {
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "llm_endpoint_params": {
        "type": "openai_params",
        "temperature": 0,
        "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}`.",
      "is_custom_instructions_included": false,
      "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",
        "temperature": 0,
        "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}---",
      "is_custom_instructions_included": false,
      "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",
        "temperature": 0,
        "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
        }
      },
      "is_custom_instructions_included": false,
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_text": {
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "llm_endpoint_params": {
        "type": "openai_params",
        "temperature": 0,
        "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}`.",
      "is_custom_instructions_included": false,
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_image": {
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "llm_endpoint_params": {
        "type": "openai_params",
        "temperature": 0,
        "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}`.",
      "is_custom_instructions_included": false,
      "warnings": [
        "MODEL_INACTIVE"
      ]
    }
  }
}

​
AI agent capability ask

The AI agent to be used to ask questions.
PropertyTypeRequiredDescription
typeenum<string>YesThe type of AI agent used to ask questions. Available options: ai_agent_ask.
access_statestringYesThe state of the AI Agent capability. Possible values are: enabled and disabled.
descriptionstringYesThe description of the AI agent.
custom_instructionsstringNoCustom instructions for the AI agent. Can be null.
suggested_questionsarray of stringNoSuggested questions for the AI agent. If null, suggested question will be generated. If empty, no suggested questions will be displayed.
long_textAI agent long text toolNo
basic_textAI agent basic text toolNo
basic_imageAI agent basic text toolNo
spreadsheetAI agent spreadsheet toolNo
long_text_multiAI agent long text toolNo
basic_text_multiAI agent basic text toolNo
basic_image_multiAI agent basic text toolNo
Example
{
  "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",
      "temperature": 0,
      "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
      }
    },
    "is_custom_instructions_included": false,
    "warnings": [
      "MODEL_INACTIVE"
    ]
  },
  "basic_text": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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}`.",
    "is_custom_instructions_included": false,
    "warnings": [
      "MODEL_INACTIVE"
    ]
  },
  "basic_image": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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}`.",
    "is_custom_instructions_included": false,
    "warnings": [
      "MODEL_INACTIVE"
    ]
  },
  "spreadsheet": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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",
      "temperature": 0,
      "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
      }
    },
    "is_custom_instructions_included": false,
    "warnings": [
      "MODEL_INACTIVE"
    ]
  },
  "basic_text_multi": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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}`.",
    "is_custom_instructions_included": false,
    "warnings": [
      "MODEL_INACTIVE"
    ]
  },
  "basic_image_multi": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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}`.",
    "is_custom_instructions_included": false,
    "warnings": [
      "MODEL_INACTIVE"
    ]
  }
}

​
AI agent capability ask request

The AI agent to be used to handle queries.
PropertyTypeRequiredDescription
typeenum<string>YesThe type of AI agent used to handle queries. Available options: ai_agent_ask.
access_statestringYesThe state of the AI Agent capability. Possible values are: enabled and disabled.
descriptionstringYesThe description of the AI agent.
custom_instructionsstringNoCustom instructions for the AI agent. Can be null.
suggested_questionsarray of stringNoSuggested questions for the AI agent. If null, suggested question will be generated. If empty, no suggested questions will be displayed.
long_textAI agent long text tool requestNo
basic_textAI agent basic text tool requestNo
basic_imageAI agent basic text tool requestNo
spreadsheetAI agent spreadsheet toolNo
long_text_multiAI agent long text tool requestNo
basic_text_multiAI agent basic text tool requestNo
basic_image_multiAI agent basic text tool requestNo
Example
{
  "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",
      "temperature": 0,
      "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
      }
    },
    "is_custom_instructions_included": false
  },
  "basic_text": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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}`.",
    "is_custom_instructions_included": false
  },
  "basic_image": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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}`.",
    "is_custom_instructions_included": false
  },
  "spreadsheet": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "top_p": 1,
      "frequency_penalty": 1.5,
      "presence_penalty": 1.5,
      "stop": "<|im_end|>"
    }
  },
  "long_text_multi": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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
      }
    },
    "is_custom_instructions_included": false
  },
  "basic_text_multi": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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}`.",
    "is_custom_instructions_included": false
  },
  "basic_image_multi": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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}`.",
    "is_custom_instructions_included": false
  }
}

​
AI agent capability extract

The AI agent to be used for metadata extraction.
PropertyTypeRequiredDescription
typeenum<string>YesThe type of AI agent to be used for metadata extraction. Available options: ai_agent_extract.
access_statestringYesThe state of the AI Agent capability. Possible values are: enabled and disabled.
descriptionstringYesThe description of the AI agent.
custom_instructionsstringNoCustom instructions for the AI agent. Can be null.
long_textAI agent long text toolNo
basic_textAI agent basic text toolNo
basic_imageAI agent basic text toolNo
Example
{
  "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",
      "temperature": 0,
      "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
      }
    },
    "is_custom_instructions_included": false,
    "warnings": [
      "MODEL_INACTIVE"
    ]
  },
  "basic_text": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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}`.",
    "is_custom_instructions_included": false,
    "warnings": [
      "MODEL_INACTIVE"
    ]
  },
  "basic_image": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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}`.",
    "is_custom_instructions_included": false,
    "warnings": [
      "MODEL_INACTIVE"
    ]
  }
}

​
AI agent capability extract request

The AI agent to be used for metadata extraction.
PropertyTypeRequiredDescription
typeenum<string>YesThe type of AI agent to be used for metadata extraction. Available options: ai_agent_extract.
access_statestringYesThe state of the AI Agent capability. Possible values are: enabled and disabled.
descriptionstringYesThe description of the AI agent.
custom_instructionsstringNoCustom instructions for the AI agent. Can be null.
long_textAI agent long text tool requestNo
basic_textAI agent basic text tool requestNo
basic_imageAI agent basic text tool requestNo
Example
{
  "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",
      "temperature": 0,
      "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
      }
    },
    "is_custom_instructions_included": false
  },
  "basic_text": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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}`.",
    "is_custom_instructions_included": false
  },
  "basic_image": {
    "model": "azure__openai__gpt_4o_mini",
    "num_tokens_for_completion": 8400,
    "llm_endpoint_params": {
      "type": "openai_params",
      "temperature": 0,
      "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}`.",
    "is_custom_instructions_included": false
  }
}

​
AI agent capability text generation

The AI agent to be used to generate text.
PropertyTypeRequiredDescription
typeenum<string>YesThe type of AI agent used for generating text. Available options: ai_agent_text_gen.
access_statestringYesThe state of the AI Agent capability. Possible values are: enabled and disabled.
descriptionstringYesThe description of the AI agent.
custom_instructionsstringNoCustom instructions for the AI agent. Can be null.
suggested_questionsarray of stringNoSuggested questions for the AI agent. If null, suggested question will be generated. If empty, no suggested questions will be displayed.
basic_genAI agent basic text generation toolNo
Example
{
  "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",
      "temperature": 0,
      "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}---",
    "is_custom_instructions_included": false,
    "warnings": [
      "MODEL_INACTIVE"
    ]
  }
}

​
AI agent capability text generation request

The AI agent to be used to generate text.
PropertyTypeRequiredDescription
typeenum<string>YesThe type of AI agent used for generating text. Available options: ai_agent_text_gen.
access_statestringYesThe state of the AI Agent capability. Possible values are: enabled and disabled.
descriptionstringYesThe description of the AI agent.
custom_instructionsstringNoCustom instructions for the AI agent. Can be null.
suggested_questionsarray of stringNoSuggested questions for the AI agent. If null, suggested question will be generated. If empty, no suggested questions will be displayed.
basic_genAI agent basic text generation tool requestNo
Example
{
  "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",
      "temperature": 0,
      "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}---",
    "is_custom_instructions_included": false
  }
}

​
AI agents list

List of AI Agents with pagination.
PropertyTypeRequiredDescription
limitintegerNoThe limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
next_markerstringNoThe marker for the start of the next page of results. Can be null.
prev_markerstringNoThe marker for the start of the previous page of results. Can be null.
entriesarray of AI agent (Full)YesThe list of AI Agents.
Example
{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "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",
            "temperature": 0,
            "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
            }
          },
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_text": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "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}`.",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_image": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "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}`.",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "spreadsheet": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "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",
            "temperature": 0,
            "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
            }
          },
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_text_multi": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "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}`.",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_image_multi": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "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}`.",
          "is_custom_instructions_included": false,
          "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",
            "temperature": 0,
            "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}---",
          "is_custom_instructions_included": false,
          "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",
            "temperature": 0,
            "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
            }
          },
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_text": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "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}`.",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        },
        "basic_image": {
          "model": "azure__openai__gpt_4o_mini",
          "num_tokens_for_completion": 8400,
          "llm_endpoint_params": {
            "type": "openai_params",
            "temperature": 0,
            "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}`.",
          "is_custom_instructions_included": false,
          "warnings": [
            "MODEL_INACTIVE"
          ]
        }
      }
    }
  ]
}
Last modified on July 9, 2026