> ## Documentation Index > Fetch the complete documentation index at: https://docs.meibel.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Agent ## OpenAPI ````yaml /api-v2.json get /agents/{agent_id} openapi: 3.1.0 info: title: Meibel AI API summary: Meibel Gateway Service description: >- Our API allows you to interact with our services. Read the [docs](https://docs.meibel.ai) to learn how to use it. version: 0.6.4 servers: - url: https://api.meibel.ai/v2 description: Meibel API (v2) - url: https://api.dev.meibel.ai/v2 description: Meibel Dev API (v2) - url: http://localhost:8000/v2 description: Local Development security: [] tags: - name: Datasources description: v2 datasource management - name: Data Elements description: v2 data element CRUD and search - name: File Upload description: Upload files to a datasource and track upload progress - name: Ingest description: Trigger and monitor datasource ingestion - name: Datasource Downloads description: Export all datasource content as a zip archive - name: Table Descriptions description: v2 table and column descriptions - name: Metadata Model Catalog description: v2 metadata model catalog - name: Confidence Scoring description: v2 confidence scoring jobs and summaries - name: Documents description: Parse and transform documents into structured data - name: Agents description: Agent definition management - name: Sessions description: Agent session (execution) management and chat - name: Execution Policies description: Data access and tool usage constraints scoped to agent sessions - name: Artifact Schemas description: Agent artifact schema management paths: /agents/{agent_id}: get: tags: - Agents summary: Get Agent operationId: getAgent parameters: - name: agent_id in: path required: true schema: type: string title: Agent Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AgentDetailResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] x-codeSamples: - lang: Python label: Python source: >- import os from meibel import MeibelClient client = MeibelClient(api_key=os.environ["MEIBEL_API_KEY"]) agent = client.agents.get(agent_id="agent_abc123") print(f"{agent.display_name} ({agent.version}) - model: {agent.llm_model}") if agent.execution_policy and agent.execution_policy.datasources: for ds_id, ds_view in agent.execution_policy.datasources.items(): print(f"datasource {ds_id} disabled: {ds_view.disabled}") - lang: TypeScript label: TypeScript source: >- import { MeibelClient } from "meibel"; const client = new MeibelClient({ apiKey: process.env.MEIBEL_API_KEY }); const agent = await client.agents.get("agent_abc123"); console.log(`${agent.display_name} (${agent.version}): ${agent.llm_model}`); console.log(`Tools: ${agent.tools.length}, Datasources: ${agent.datasources.join(", ")}`); - lang: Go label: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"os\"\n\n\tv2 \"github.com/meibel-ai/meibel-go/v2\"\n)\n\nfunc main() {\n\tclient := v2.NewClient(v2.WithAPIKey(os.Getenv(\"MEIBEL_API_KEY\")))\n\n\tagent, err := client.Agents.Get(context.Background(), \"agent_abc123\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%s (%s) - model: %s\\n\", agent.DisplayName, agent.Version, agent.LlmModel)\n}" components: schemas: AgentDetailResponse: properties: id: type: string title: Id name: type: string title: Name display_name: type: string title: Display Name catalog_urn: type: string title: Catalog Urn version: type: string title: Version parent_version: anyOf: - type: string - type: 'null' title: Parent Version type: type: string title: Type description: anyOf: - type: string - type: 'null' title: Description llm_model: type: string title: Llm Model fallback_models: items: type: string type: array title: Fallback Models datasources: items: type: string type: array title: Datasources instructions: type: string title: Instructions tools: items: additionalProperties: true type: object type: array title: Tools artifacts: items: type: string type: array title: Artifacts confidence_configs: items: type: string type: array title: Confidence Configs temperature: anyOf: - type: number - type: integer title: Temperature max_tokens: anyOf: - type: integer - type: 'null' title: Max Tokens tags: items: type: string type: array title: Tags icon: anyOf: - type: string - type: 'null' title: Icon created_by: anyOf: - type: string - type: 'null' title: Created By created_at: anyOf: - type: string format: date-time - type: 'null' title: Created At execution_policy: anyOf: - $ref: '#/components/schemas/ExecutionPolicy' - type: 'null' description: Execution policy applied to this agent's sessions. examples: - datasources: ds_abc123: documents: filter: data_element.__id__: $in: - de_abc - de_def tables: filter: orders.region: $eq: EU table.__name__: $in: - orders - customers hidden_columns: customers: - ssn - credit_card ds_xyz789: disabled: true tools: send_email: variables: max_attachments: $lte: 3 to: $eq: support@acme.com web_search: disabled: true execution_policy_ids: anyOf: - items: type: string type: array - type: 'null' title: Execution Policy Ids last_execution_status: anyOf: - type: string - type: 'null' title: Last Execution Status last_execution_time: anyOf: - type: string format: date-time - type: 'null' title: Last Execution Time type: object required: - id - name - display_name - catalog_urn - version - type - llm_model - fallback_models - datasources - instructions - tools - artifacts - confidence_configs - temperature - tags title: AgentDetailResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ExecutionPolicy: properties: datasources: anyOf: - additionalProperties: $ref: '#/components/schemas/DatasourceView' type: object - type: 'null' title: Datasources description: >- Per-datasource access controls, keyed by datasource_id. Each entry can disable the datasource entirely or apply TAG/RAG filters to restrict which data is accessible. tools: anyOf: - additionalProperties: $ref: '#/components/schemas/ToolConfig' type: object - type: 'null' title: Tools description: >- Per-tool access controls, keyed by tool instance name. Each entry can disable the tool entirely or constrain its parameters to specific values or ranges. type: object title: ExecutionPolicy description: >- Session-level access constraints (hardrails) for data and tools. Controls what data an agent session can access and what tools it can use. Constraints are enforced by the platform at runtime — the agent cannot bypass them. Multiple policies can be composed: stored policies (by ID) and/or an inline policy are structurally merged. Overlapping datasource or tool entries are combined with ``$and`` (intersection semantics). All filter fields use MongoDB-style constraint operators. Plain values are automatically normalized to ``{"$eq": value}``. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError DatasourceView: properties: disabled: anyOf: - type: boolean - type: 'null' title: Disabled description: >- When true, the datasource is entirely inaccessible for this session. All queries against it will be blocked. tables: anyOf: - $ref: '#/components/schemas/TagConstraints' - type: 'null' description: >- TAG (SQL/database) constraints. Controls table/row access and column redaction. documents: anyOf: - $ref: '#/components/schemas/RagConstraints' - type: 'null' description: >- RAG (vector search) constraints. Controls which documents can be retrieved. type: object title: DatasourceView description: >- Access controls for a single datasource. Each datasource can be entirely disabled, or selectively constrained via TAG (SQL) and/or RAG (vector search) filters. Keyed by datasource_id in ``ExecutionPolicy.datasources``. ToolConfig: properties: disabled: anyOf: - type: boolean - type: 'null' title: Disabled description: >- When true, the tool is removed from the agent's toolkit for this session. The agent will not be able to invoke it. variables: anyOf: - additionalProperties: true type: object - type: 'null' title: Variables description: Optional override for the tool's parameters schema type: object title: ToolConfig description: >- Access controls for a single tool instance. Tools can be entirely disabled, or have their parameters constrained to specific values or ranges. Keyed by tool instance name in ``ExecutionPolicy.tools``. Variable constraints use the same MongoDB-style operators as datasource filters. Plain values are automatically normalized to ``{"$eq": value}`` on construction. All constraints are: 1. Annotated in the tool's parameter schema (visible to the LLM) 2. Validated at execution time (enforced by the platform) Supported operators: - Comparison: ``$eq``, ``$ne``, ``$gt``, ``$gte``, ``$lt``, ``$lte`` - Set: ``$in``, ``$nin`` - Logical: ``$and``, ``$or``, ``$not`` TagConstraints: properties: filter: anyOf: - additionalProperties: true type: object - type: 'null' title: Filter description: Optional override for the tool's parameters schema hidden_columns: anyOf: - additionalProperties: items: type: string type: array type: object - type: 'null' title: Hidden Columns description: >- Per-table column names to redact from query output. Keyed by table name; values are lists of column names. Columns remain usable in WHERE/JOIN — only the final result values are stripped. hidden_tables: anyOf: - items: type: string type: array - type: 'null' title: Hidden Tables description: >- Table names whose columns are fully redacted from query output. Tables remain queryable in WHERE/JOIN — only SELECT output is stripped. type: object title: TagConstraints description: >- Constraints for TAG (SQL/database) queries within a datasource. Controls which tables and rows the agent can access, and which columns are redacted from query output. Filters use MongoDB-style constraint dicts. Plain values are automatically normalized to ``{"$eq": value}`` on construction. Supported operators: - Comparison: ``$eq``, ``$ne``, ``$gt``, ``$gte``, ``$lt``, ``$lte`` - Set: ``$in``, ``$nin`` - Logical: ``$and``, ``$or``, ``$not`` RagConstraints: properties: filter: anyOf: - additionalProperties: true type: object - type: 'null' title: Filter description: Optional override for the tool's parameters schema type: object title: RagConstraints description: >- Constraints for RAG (vector search) queries within a datasource. Controls which documents the agent can retrieve via vector search. Filters use MongoDB-style constraint dicts. Plain values are automatically normalized to ``{"$eq": value}`` on construction. Built-in fields: - ``data_element.__id__``: scope by data element ID - ``data_element.__name__``: scope by original filename Custom indexed metadata fields (e.g., ``author``, ``document_type``) are also supported when configured on the datasource. Supported operators: - Comparison: ``$eq``, ``$ne``, ``$gt``, ``$gte``, ``$lt``, ``$lte`` - Set: ``$in``, ``$nin`` - Logical: ``$and``, ``$or``, ``$not`` securitySchemes: APIKeyHeader: type: apiKey in: header name: Meibel-API-Key ````