Get Assistant
This method allows you to retrieve the configuration of an agent identified by its ID. The response also includes the current status of the agent, such as if the agent is configured to use an LLM or index that is currently unavailable.
agent_id
Successful Response
{
"name": "string",
"description": "string",
"instructions": "string",
"session_max_ttl": 0,
"completion_role": "string",
"tools": [
{
"link_type": "string",
"tool_id": "string"
}
],
"index_id": "string",
"index_top_n": 0,
"index_similarity_cutoff": "number",
"index_reference_format": "string",
"index_reference_delimiter": "string",
"session_max_length": 0,
"session_summarization_strategy": "string",
"metadata": {
"metadata": "string"
},
"id": "string",
"object": "string",
"created_at": 0,
"model": "string",
"status": "string",
"status_errors": [
"string"
],
"chat_system_instruction_mode": "string"
}Name of the agent.
Description of the agent.
System instructions used by the agent.
Agent sessions that have not been written to within this many seconds are subject to deletion.
Response role for completions created by the agent. DEPRECATION WARNING: This property is deprecated and is subject to removal from agent requests and responses in the future.
A list of tools to be used by the agent.
Data Indexing and Retrieval index to be used by the agent. DEPRECATION WARNING: Direct linking to an index is deprecated and is subject to removal in the future. Use tools instead.
Top N chunks the agent should request from Data Indexing and Retrieval when fetching context from the index. DEPRECATION WARNING: Direct use of this property is deprecated and is subject to removal from agent requests and responses in the future. Use tools instead.
Chunk similarity the agent should request from Data Indexing and Retrieval when fetching context from the index. DEPRECATION WARNING: Direct use of this property is deprecated and is subject to removal from agent requests and responses in the future. Use tools instead.
Format in which index text references are returned by the agent.
Delimiter string to separate the agent completions response from the index references.
Sessions that exceed this length (in characters) will get summarized before new data is added. This value must be small enough to fit into the context window of the LLM used by this assistant (including any additional prompts sent to the LLM).
Strategy for summarizing an agent session once it exceeds the configured maximum session length.
Set of up to 16 key-value pairs attached to this agent. To delete a key from the agent metadata, set its value to null.
ID of the agent.
Object type, which is always agent.
Unix timestamp (in seconds) when the agent was created.
ID of the model to be used by the agent for generating completions.
Availability status of an agent.
Details of the agent error status, if the agent is not available.
Agent setting that decides how system instructions are sent to the LLM when generating completions. For LLMs supporting "system messages", this is the most robust choice, but not all LLMs support this type of instructions.
No agent found with the specified ID.
Validation Error
{
"detail": [
{
"loc": [
{}
],
"msg": "string",
"type": "string"
}
]
}detail
curl -H 'Authorization: <value>' https://{api_host}/api/v1/compatibility/openai/v1/assistants/{agent_id}