Validate Pipeline

Validate a pipeline configuration without saving it

Validate Pipeline

cURL

curl --request POST \
  --url https://api.example.com/v1/pipeline/validate

200

{
  "valid": true,
  "message": "<string>",
  "errors": [
    {}
  ]
}

Check if a pipeline configuration is valid before creating or updating a pipeline.

Examples

Python

from chonkie.cloud import Pipeline

# Validate steps configuration
steps = [
    {"type": "chunk", "component": "recursive", "chunk_size": 512},
    {"type": "refine", "component": "overlap", "context_size": 64}
]

is_valid, errors = Pipeline.validate(steps)

if is_valid:
    print("Configuration is valid!")
else:
    print(f"Errors: {errors}")

Request

steps · array · required

Array of pipeline step configurations to validate.

Each step object contains:

• type: Step type (process, chunk, or refine)
• component: Component name (e.g., recursive, overlap, embeddings)
• Additional parameters specific to the component

Response

valid · boolean

Whether the configuration is valid.

message · string

Human-readable validation result message.

errors · array

List of validation errors if the configuration is invalid. Null if valid.

Validation Rules

The validation endpoint checks:

1. Required chunk step: At least one chunk step must be present
2. Valid step types: Only process, chunk, and refine are allowed
3. Valid components: Component names must match available chunkers, refiners, or processors
4. Valid parameters: Component-specific parameters are validated

Errors

Status	Description
422	Invalid request format