GET
/
agents
/
{agent_id}
/
metadata
curl --request GET \
  --url https://api.contextual.ai/v1/agents/{agent_id}/metadata \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "description": "<string>",
  "datastore_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "template_name": "<string>",
  "system_prompt": "<string>",
  "filter_prompt": "<string>",
  "no_retrieval_system_prompt": "<string>",
  "llm_model_id": "<string>",
  "suggested_queries": [
    "<string>"
  ],
  "agent_configs": {
    "retrieval_config": {
      "top_k_retrieved_chunks": 123,
      "lexical_alpha": 123,
      "semantic_alpha": 123
    },
    "filter_and_rerank_config": {
      "top_k_reranked_chunks": 123,
      "reranker_score_filter_threshold": 0,
      "rerank_instructions": "<string>",
      "default_metadata_filters": {
        "filters": [
          {
            "field": "field1",
            "operator": "equals",
            "value": "value1"
          }
        ],
        "operator": "AND"
      },
      "per_datastore_metadata_filters": {
        "d49609d9-61c3-4a67-b3bd-5196b10da560": {
          "filters": [
            {
              "field": "field1",
              "operator": "equals",
              "value": "value1"
            }
          ],
          "operator": "AND"
        }
      }
    },
    "generate_response_config": {
      "max_new_tokens": 123,
      "temperature": 123,
      "top_p": 123,
      "frequency_penalty": 123,
      "seed": 123,
      "calculate_groundedness": true,
      "avoid_commentary": false
    },
    "global_config": {
      "enable_rerank": true,
      "enable_filter": true,
      "enable_multi_turn": true,
      "should_check_retrieval_need": true
    },
    "reformulation_config": {
      "enable_query_expansion": true,
      "query_expansion_prompt": "<string>",
      "enable_query_decomposition": true,
      "query_decomposition_prompt": "<string>"
    }
  },
  "agent_usages": {
    "query": 123,
    "tune": 123,
    "eval": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id
string
required

ID of the agent for which to retrieve details

Response

200
application/json

Successful Response

Response to GET Agent request