> ## 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. # Update Batch Definition By Id ## OpenAPI ````yaml /api-v2.json put /batch-definitions/id/{definition_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: /batch-definitions/id/{definition_id}: put: tags: - Batch Definitions summary: Update Batch Definition By Id operationId: updateBatchById parameters: - name: definition_id in: path required: true schema: type: string title: Definition Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateBatchDefinitionRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UpdateBatchDefinitionResponse' '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 from meibel.models import UpdateBatchDefinitionRequest, BatchDefinitionFilters client = MeibelClient(api_key=os.environ["MEIBEL_API_KEY"]) request = UpdateBatchDefinitionRequest( name="Quarterly Invoice Extraction", concurrency=10, retry_limit=2, filters=BatchDefinitionFilters( regex=r".*\.pdf$", media_types=["application/pdf"], ), ) response = client.batches.update_by_id("batchdef_7f3c9a1e", request) print(f"{response.id} -> version {response.version}") - lang: TypeScript label: TypeScript source: >- import { MeibelClient } from "meibel"; const client = new MeibelClient({ apiKey: process.env.MEIBEL_API_KEY }); const updatedDefinition = await client.batches.updateById("batchdef_7f3a9c2e", { name: "Q1 Invoice Reconciliation", concurrency: 10, retry_limit: 3, filters: { media_types: ["application/pdf"], }, execution_policy: { datasources: { ds_invoices_2024: { tables: { hidden_columns: { invoices: ["ssn", "bank_account"], }, }, }, }, }, }); console.log(`${updatedDefinition.id} -> version ${updatedDefinition.version}`); - 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\tresp, err := client.Batches.UpdateById(context.Background(), \"batchdef_8f3a1c2e\", v2.UpdateBatchDefinitionRequest{\n\t\tName: v2.String(\"Nightly Invoice Summarization\"),\n\t\tConcurrency: v2.Int(10),\n\t\tRetryLimit: v2.Int(3),\n\t\tUserMessage: v2.String(\"Summarize each invoice and flag anomalies over $10,000.\"),\n\t\tFilters: &v2.BatchDefinitionFilters{\n\t\t\tRegex: v2.String(\".*\\\\.pdf$\"),\n\t\t\tMediaTypes: []string{\"application/pdf\"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tfmt.Println(\"error:\", err)\n\t\treturn\n\t}\n\n\tfmt.Println(\"id:\", resp.ID)\n\tfmt.Println(\"version:\", resp.Version)\n}" components: schemas: UpdateBatchDefinitionRequest: properties: name: anyOf: - type: string - type: 'null' title: Name agent_id: anyOf: - type: string - type: 'null' title: Agent Id description: If set, re-resolves and re-pins the agent spec input_datasource_id: anyOf: - type: string - type: 'null' title: Input Datasource Id filters: anyOf: - $ref: '#/components/schemas/BatchDefinitionFilters' - type: 'null' output_datasource_id: anyOf: - type: string - type: 'null' title: Output Datasource Id user_message: anyOf: - type: string - type: 'null' title: User Message concurrency: anyOf: - type: integer maximum: 999 minimum: 1 - type: 'null' title: Concurrency retry_limit: anyOf: - type: integer maximum: 999 minimum: 0 - type: 'null' title: Retry Limit recurrence_cron: anyOf: - type: string - type: 'null' title: Recurrence Cron description: anyOf: - type: string - type: 'null' title: Description execution_policy: anyOf: - $ref: '#/components/schemas/ExecutionPolicy' - type: 'null' description: Inline execution policy constraints (datasources, tools) execution_policy_ids: anyOf: - items: type: string type: array - type: 'null' title: Execution Policy Ids description: IDs of stored ExecutionPolicies to compose type: object title: UpdateBatchDefinitionRequest description: Patch a BatchDefinition; the service forks a new version row. UpdateBatchDefinitionResponse: properties: id: type: string title: Id catalog_urn: type: string title: Catalog Urn version: type: string title: Version type: object required: - id - catalog_urn - version title: UpdateBatchDefinitionResponse description: New version metadata returned after a successful update fork. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError BatchDefinitionFilters: properties: regex: anyOf: - type: string - type: 'null' title: Regex description: Filter Data Elements by name pattern (regex) media_types: anyOf: - items: type: string type: array - type: 'null' title: Media Types description: Filter Data Elements by content type element_ids: anyOf: - items: type: string type: array - type: 'null' title: Element Ids description: Recipe-pinned subset of Data Element IDs. type: object title: BatchDefinitionFilters description: >- Recipe-level filters. element_ids belongs here; per-execution overrides use BatchInputOverrides on the execution row. 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 ````