Run pipes (sync)
Enrich data synchronously. This endpoint waits for the enrichment to complete before returning a result. With with fewer than 10 records. To enrich more data at once use the '/run' endpoint.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
config?
Default
{"environment":"production","transform":{"include_fields":"input"},"widgets":{"enabled":false},"field_definitions":{"enabled":false}}field_annotations?
pipes*array<|||||||||||||||||||||||||||||||||||||||||||||||||||||||>
input*array<>
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.pipe0.com/v1/pipes/run/sync" \ -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"
},
"property2": {
"type": "string",
"label": "string",
"added_by": {
"ref": "prompt:run@1",
"config_hash": "string",
"pipe_index": 0
},
"format": "json_object"
}
},
"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": {
"label": "string"
},
"entity_logo": {
"image_url": "http://example.com",
"entity": "string"
},
"location_indicator": {
"emoji": "string"
},
"avatar": {
"image_url": "http://example.com",
"name": "string"
},
"waterfall": {
"attempted_providers": [
{
"provider": "pipe0"
}
],
"available_providers": [
"pipe0"
],
"successful_provider": "pipe0"
},
"icon": {
"key": "linkedin"
},
"action_summary": {
"result_status": "completed"
},
"sources": {
"list": [
{
"source": "string",
"description": "string",
"url": "string"
}
]
},
"confidence": {
"numeric": 1
}
},
"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": {
"label": "string"
},
"entity_logo": {
"image_url": "http://example.com",
"entity": "string"
},
"location_indicator": {
"emoji": "string"
},
"avatar": {
"image_url": "http://example.com",
"name": "string"
},
"waterfall": {
"attempted_providers": [
{
"provider": "pipe0"
}
],
"available_providers": [
"pipe0"
],
"successful_provider": "pipe0"
},
"icon": {
"key": "linkedin"
},
"action_summary": {
"result_status": "completed"
},
"sources": {
"list": [
{
"source": "string",
"description": "string",
"url": "string"
}
]
},
"confidence": {
"numeric": 1
}
},
"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": {
"label": "string"
},
"entity_logo": {
"image_url": "http://example.com",
"entity": "string"
},
"location_indicator": {
"emoji": "string"
},
"avatar": {
"image_url": "http://example.com",
"name": "string"
},
"waterfall": {
"attempted_providers": [
{
"provider": "pipe0"
}
],
"available_providers": [
"pipe0"
],
"successful_provider": "pipe0"
},
"icon": {
"key": "linkedin"
},
"action_summary": {
"result_status": "completed"
},
"sources": {
"list": [
{
"source": "string",
"description": "string",
"url": "string"
}
]
},
"confidence": {
"numeric": 1
}
},
"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": {
"label": "string"
},
"entity_logo": {
"image_url": "http://example.com",
"entity": "string"
},
"location_indicator": {
"emoji": "string"
},
"avatar": {
"image_url": "http://example.com",
"name": "string"
},
"waterfall": {
"attempted_providers": [
{
"provider": "pipe0"
}
],
"available_providers": [
"pipe0"
],
"successful_provider": "pipe0"
},
"icon": {
"key": "linkedin"
},
"action_summary": {
"result_status": "completed"
},
"sources": {
"list": [
{
"source": "string",
"description": "string",
"url": "string"
}
]
},
"confidence": {
"numeric": 1
}
},
"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"
}