# Run Pipeline

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Run Pipeline"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/api/v1/haystack/pipelines/run"}
  context={"endpoint"}
>
  
</MethodEndpoint>

Runs a haystack pipeline with the provided configuration and inputs.

This is useful for testing pipelines or running them with specific input data.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"properties":{"include_outputs_from":{"anyOf":[{"items":{"type":"string"},"type":"array","uniqueItems":true},{"type":"null"}],"description":"Optional component names to include outputs from. If not provided, all outputs will be included.","title":"Include Outputs From"},"input_types":{"anyOf":[{"additionalProperties":{"additionalProperties":{"type":"string"},"type":"object"},"type":"object"},{"type":"null"}],"description":"Optional input types used to deserialize data, defining how raw input is converted into usable Python objects before the pipeline runs. If not provided, they're inferred from the component's input definitions.","title":"Input Types"},"inputs":{"additionalProperties":{"additionalProperties":true,"type":"object"},"description":"Input data for the pipeline run.","title":"Inputs","type":"object"},"pipeline_config":{"additionalProperties":true,"description":"Pipeline configuration as a dictionary containing components, connections, and other pipeline settings.","title":"Pipeline Config","type":"object"},"pipeline_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Unique identifier of a pipeline.","title":"Pipeline Id"},"pipeline_version_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"The version of pipeline used to execute the query.","title":"Pipeline Version ID"}},"required":["pipeline_config","inputs"],"title":"RunPipelineRequest","type":"object"}}},"required":true}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"content":{"application/json":{"schema":{"additionalProperties":true,"title":"RunPipelineResponse","type":"object"}}},"description":"The output produced by running the pipeline."},"400":{"description":"The pipeline failed to run because of incorrect configuration, parameters or input, or it references a disabled index. Enable the index first before running the pipeline."},"404":{"description":"The pipeline configuration is invalid or contains components that don't exist. Make sure the pipeline configuration is correct."},"422":{"content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"ctx":{"title":"Context","type":"object"},"input":{"title":"Input"},"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"}}},"description":"Validation Error"}}}
>
  
</StatusCodes>