Tests
Webhook
Mock endpoint that simulates the http request to the deployment webhook
POST
/
v1
/
processors
/
automations
/
tests
/
webhook
/
{automation_id}
Copy
curl --request POST \
--url https://api.uiform.com/v1/processors/automations/tests/webhook/{automation_id}
Copy
{
"object": "automation_log",
"id": "<string>",
"user_email": "jsmith@example.com",
"organization_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"automation_snapshot": {
"object": "automation",
"id": "<string>",
"name": "<string>",
"processor_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"default_language": "en",
"webhook_url": "<string>",
"webhook_headers": {},
"need_validation": false
},
"completion": {
"id": "<string>",
"choices": [
{
"finish_reason": "stop",
"index": 123,
"logprobs": {
"content": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123,
"top_logprobs": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123
}
]
}
],
"refusal": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123,
"top_logprobs": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123
}
]
}
]
},
"message": {
"content": "<string>",
"refusal": "<string>",
"role": "<string>",
"annotations": [
{
"type": "<string>",
"url_citation": {
"end_index": 123,
"start_index": 123,
"title": "<string>",
"url": "<string>"
}
}
],
"audio": {
"id": "<string>",
"data": "<string>",
"expires_at": 123,
"transcript": "<string>"
},
"function_call": {
"arguments": "<string>",
"name": "<string>"
},
"tool_calls": [
{
"id": "<string>",
"function": {
"arguments": "<string>",
"name": "<string>",
"parsed_arguments": "<any>"
},
"type": "<string>"
}
],
"parsed": "<any>"
},
"field_locations": {},
"key_mapping": {}
}
],
"created": 123,
"model": "<string>",
"object": "<string>",
"service_tier": "auto",
"system_fingerprint": "<string>",
"usage": {
"completion_tokens": 123,
"prompt_tokens": 123,
"total_tokens": 123,
"completion_tokens_details": {
"accepted_prediction_tokens": 123,
"audio_tokens": 123,
"reasoning_tokens": 123,
"rejected_prediction_tokens": 123
},
"prompt_tokens_details": {
"audio_tokens": 123,
"cached_tokens": 123
}
},
"extraction_id": "<string>",
"likelihoods": {},
"schema_validation_error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"request_at": "2023-11-07T05:31:56Z",
"first_token_at": "2023-11-07T05:31:56Z",
"last_token_at": "2023-11-07T05:31:56Z",
"api_cost": {
"value": 123,
"currency": "<string>"
}
},
"file_metadata": {
"filename": "file.pdf",
"url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..."
},
"external_request_log": {
"webhook_url": "<string>",
"request_body": {},
"request_headers": {},
"request_at": "2023-11-07T05:31:56Z",
"response_body": {},
"response_headers": {},
"response_at": "2023-11-07T05:31:56Z",
"status_code": 123,
"error": "<string>",
"duration_ms": 123
},
"extraction_id": "<string>",
"api_cost": {
"value": 123,
"currency": "<string>"
},
"cost_breakdown": {
"total": {
"value": 123,
"currency": "<string>"
},
"text_prompt_cost": {
"value": 123,
"currency": "<string>"
},
"text_cached_cost": {
"value": 123,
"currency": "<string>"
},
"text_completion_cost": {
"value": 123,
"currency": "<string>"
},
"text_total_cost": {
"value": 123,
"currency": "<string>"
},
"audio_prompt_cost": {
"value": 123,
"currency": "<string>"
},
"audio_completion_cost": {
"value": 123,
"currency": "<string>"
},
"audio_total_cost": {
"value": 123,
"currency": "<string>"
},
"token_counts": {
"prompt_regular_text": 123,
"prompt_cached_text": 123,
"prompt_audio": 123,
"completion_regular_text": 123,
"completion_audio": 123,
"total_tokens": 123
},
"model": "<string>",
"is_fine_tuned": false
}
}
Authorizations
Path Parameters
Response
200
application/json
Successful Response
The response is of type object
.
Copy
curl --request POST \
--url https://api.uiform.com/v1/processors/automations/tests/webhook/{automation_id}
Copy
{
"object": "automation_log",
"id": "<string>",
"user_email": "jsmith@example.com",
"organization_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"automation_snapshot": {
"object": "automation",
"id": "<string>",
"name": "<string>",
"processor_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"default_language": "en",
"webhook_url": "<string>",
"webhook_headers": {},
"need_validation": false
},
"completion": {
"id": "<string>",
"choices": [
{
"finish_reason": "stop",
"index": 123,
"logprobs": {
"content": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123,
"top_logprobs": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123
}
]
}
],
"refusal": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123,
"top_logprobs": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123
}
]
}
]
},
"message": {
"content": "<string>",
"refusal": "<string>",
"role": "<string>",
"annotations": [
{
"type": "<string>",
"url_citation": {
"end_index": 123,
"start_index": 123,
"title": "<string>",
"url": "<string>"
}
}
],
"audio": {
"id": "<string>",
"data": "<string>",
"expires_at": 123,
"transcript": "<string>"
},
"function_call": {
"arguments": "<string>",
"name": "<string>"
},
"tool_calls": [
{
"id": "<string>",
"function": {
"arguments": "<string>",
"name": "<string>",
"parsed_arguments": "<any>"
},
"type": "<string>"
}
],
"parsed": "<any>"
},
"field_locations": {},
"key_mapping": {}
}
],
"created": 123,
"model": "<string>",
"object": "<string>",
"service_tier": "auto",
"system_fingerprint": "<string>",
"usage": {
"completion_tokens": 123,
"prompt_tokens": 123,
"total_tokens": 123,
"completion_tokens_details": {
"accepted_prediction_tokens": 123,
"audio_tokens": 123,
"reasoning_tokens": 123,
"rejected_prediction_tokens": 123
},
"prompt_tokens_details": {
"audio_tokens": 123,
"cached_tokens": 123
}
},
"extraction_id": "<string>",
"likelihoods": {},
"schema_validation_error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"request_at": "2023-11-07T05:31:56Z",
"first_token_at": "2023-11-07T05:31:56Z",
"last_token_at": "2023-11-07T05:31:56Z",
"api_cost": {
"value": 123,
"currency": "<string>"
}
},
"file_metadata": {
"filename": "file.pdf",
"url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..."
},
"external_request_log": {
"webhook_url": "<string>",
"request_body": {},
"request_headers": {},
"request_at": "2023-11-07T05:31:56Z",
"response_body": {},
"response_headers": {},
"response_at": "2023-11-07T05:31:56Z",
"status_code": 123,
"error": "<string>",
"duration_ms": 123
},
"extraction_id": "<string>",
"api_cost": {
"value": 123,
"currency": "<string>"
},
"cost_breakdown": {
"total": {
"value": 123,
"currency": "<string>"
},
"text_prompt_cost": {
"value": 123,
"currency": "<string>"
},
"text_cached_cost": {
"value": 123,
"currency": "<string>"
},
"text_completion_cost": {
"value": 123,
"currency": "<string>"
},
"text_total_cost": {
"value": 123,
"currency": "<string>"
},
"audio_prompt_cost": {
"value": 123,
"currency": "<string>"
},
"audio_completion_cost": {
"value": 123,
"currency": "<string>"
},
"audio_total_cost": {
"value": 123,
"currency": "<string>"
},
"token_counts": {
"prompt_regular_text": 123,
"prompt_cached_text": 123,
"prompt_audio": 123,
"completion_regular_text": 123,
"completion_audio": 123,
"total_tokens": 123
},
"model": "<string>",
"is_fine_tuned": false
}
}
Assistant
Responses are generated using AI and may contain mistakes.