Pipes
Run pipes (async)
Enrich data asynchronously. Create an enrichment task. Check this task by polling the /check endpoint until the status becomes completed or failed. Requests accept at most 100 input records; send larger workloads in chunks.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/pipes/run" \ -H "Content-Type: application/json" \ -d '{ "pipes": [ { "pipe_id": "prompt:run@1", "config": { "prompt": { "template": "stringstri" } } } ], "input": [ { "property1": "string", "property2": "string" } ] }'{ "id": "string", "organization_id": "string", "order": [ 0 ], "field_definitions": { "property1": { "type": "string", "label": "string", "added_by": { "ref": "prompt:run@1", "config_hash": "string", "pipe_index": 0 }, "format": "json_object", "is_primary_output": true, "order": 0 }, "property2": { "type": "string", "label": "string", "added_by": { "ref": "prompt:run@1", "config_hash": "string", "pipe_index": 0 }, "format": "json_object", "is_primary_output": true, "order": 0 } }, "errors": [ { "code": "string", "message": "string", "path": "string" } ], "records": { "property1": { "id": 0, "fields": { "property1": { "value": "string", "status": "completed", "type": "string", "reason": { "code": "string", "summary": "string", "message": "string" }, "claimed_by": { "ref": "prompt:run@1", "config_hash": "string" }, "resolved_by": { "ref": "prompt:run@1", "environment": "production", "config_hash": "string", "input_hash": "string" }, "widgets": { "display_value": { "type": "static", "label": "string", "marks": [ "bold" ] }, "entity_logo": { "type": "static", "image_url": "http://example.com", "entity": "string" }, "external_link": { "type": "static", "url": "http://example.com" }, "location_indicator": { "type": "static", "emoji": "string" }, "avatar": { "type": "static", "image_url": "http://example.com", "name": "string" }, "waterfall": { "type": "static", "attempted_providers": [ { "provider": "pipe0" } ], "available_providers": [ "pipe0" ], "successful_provider": "pipe0" }, "icon": { "type": "static", "key": "linkedin" }, "action_summary": { "type": "static", "result_status": "completed" }, "sources": { "type": "static", "list": [ { "source": "string", "description": "string", "url": "string" } ] }, "confidence": { "type": "static", "numeric": 1 }, "emoji": { "type": "static", "value": "string" } }, "format": "json_object" }, "property2": { "value": "string", "status": "completed", "type": "string", "reason": { "code": "string", "summary": "string", "message": "string" }, "claimed_by": { "ref": "prompt:run@1", "config_hash": "string" }, "resolved_by": { "ref": "prompt:run@1", "environment": "production", "config_hash": "string", "input_hash": "string" }, "widgets": { "display_value": { "type": "static", "label": "string", "marks": [ "bold" ] }, "entity_logo": { "type": "static", "image_url": "http://example.com", "entity": "string" }, "external_link": { "type": "static", "url": "http://example.com" }, "location_indicator": { "type": "static", "emoji": "string" }, "avatar": { "type": "static", "image_url": "http://example.com", "name": "string" }, "waterfall": { "type": "static", "attempted_providers": [ { "provider": "pipe0" } ], "available_providers": [ "pipe0" ], "successful_provider": "pipe0" }, "icon": { "type": "static", "key": "linkedin" }, "action_summary": { "type": "static", "result_status": "completed" }, "sources": { "type": "static", "list": [ { "source": "string", "description": "string", "url": "string" } ] }, "confidence": { "type": "static", "numeric": 1 }, "emoji": { "type": "static", "value": "string" } }, "format": "json_object" } } }, "property2": { "id": 0, "fields": { "property1": { "value": "string", "status": "completed", "type": "string", "reason": { "code": "string", "summary": "string", "message": "string" }, "claimed_by": { "ref": "prompt:run@1", "config_hash": "string" }, "resolved_by": { "ref": "prompt:run@1", "environment": "production", "config_hash": "string", "input_hash": "string" }, "widgets": { "display_value": { "type": "static", "label": "string", "marks": [ "bold" ] }, "entity_logo": { "type": "static", "image_url": "http://example.com", "entity": "string" }, "external_link": { "type": "static", "url": "http://example.com" }, "location_indicator": { "type": "static", "emoji": "string" }, "avatar": { "type": "static", "image_url": "http://example.com", "name": "string" }, "waterfall": { "type": "static", "attempted_providers": [ { "provider": "pipe0" } ], "available_providers": [ "pipe0" ], "successful_provider": "pipe0" }, "icon": { "type": "static", "key": "linkedin" }, "action_summary": { "type": "static", "result_status": "completed" }, "sources": { "type": "static", "list": [ { "source": "string", "description": "string", "url": "string" } ] }, "confidence": { "type": "static", "numeric": 1 }, "emoji": { "type": "static", "value": "string" } }, "format": "json_object" }, "property2": { "value": "string", "status": "completed", "type": "string", "reason": { "code": "string", "summary": "string", "message": "string" }, "claimed_by": { "ref": "prompt:run@1", "config_hash": "string" }, "resolved_by": { "ref": "prompt:run@1", "environment": "production", "config_hash": "string", "input_hash": "string" }, "widgets": { "display_value": { "type": "static", "label": "string", "marks": [ "bold" ] }, "entity_logo": { "type": "static", "image_url": "http://example.com", "entity": "string" }, "external_link": { "type": "static", "url": "http://example.com" }, "location_indicator": { "type": "static", "emoji": "string" }, "avatar": { "type": "static", "image_url": "http://example.com", "name": "string" }, "waterfall": { "type": "static", "attempted_providers": [ { "provider": "pipe0" } ], "available_providers": [ "pipe0" ], "successful_provider": "pipe0" }, "icon": { "type": "static", "key": "linkedin" }, "action_summary": { "type": "static", "result_status": "completed" }, "sources": { "type": "static", "list": [ { "source": "string", "description": "string", "url": "string" } ] }, "confidence": { "type": "static", "numeric": 1 }, "emoji": { "type": "static", "value": "string" } }, "format": "json_object" } } } }, "status": "completed"}{ "type": "invalid-input", "title": "Invalid Input", "status": 400, "detail": "Name must be a string"}{ "type": "invalid-input", "title": "Invalid Input", "status": 400, "detail": "Name must be a string"}{ "type": "invalid-input", "title": "Invalid Input", "status": 400, "detail": "Name must be a string"}{ "type": "invalid-input", "title": "Invalid Input", "status": 400, "detail": "Name must be a string"}{ "type": "invalid-input", "title": "Invalid Input", "status": 400, "detail": "Name must be a string"}