Skip to main content
POST
/
batch-definitions
Python
from meibel import MeibelClient

client = MeibelClient(api_key="your-api-key")

# Create request body
body = CreateBatchDefinitionRequest(name="Example")

result = client.batches.create(body=body)
print(result)
{
  "id": "<string>",
  "catalog_urn": "<string>",
  "name": "<string>",
  "version": "<string>"
}

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.

Authorizations

Meibel-API-Key
string
header
required

Body

application/json

Create a new BatchDefinition lineage.

name
string
required

Kebab-case label (non-unique within tenant)

agent_id
string
required

AgentDefinition ID; resolved + pinned at creation time

input_datasource_id
string
required

Datasource holding the input Data Elements

filters
BatchDefinitionFilters · object

Recipe-level filters. element_ids belongs here; per-execution overrides use BatchInputOverrides on the execution row.

output_datasource_id
string | null

Pinned output sink. NULL = workflow auto-creates per execution.

user_message
string | null
concurrency
integer | null
default:10
Required range: 1 <= x <= 999
retry_limit
integer | null
default:2
Required range: 0 <= x <= 999
recurrence_cron
string | null

Cron expression validated by croniter; not yet scheduled in DEL-1376.

description
string | null

Response

Successful Response

Compact post-create payload mirroring CreateAgentDefinitionResponse.

id
string
required
catalog_urn
string
required
name
string
required
version
string
required