curl --request POST \
--url https://{api_endpoint}/api/v1/orchestrate/runs/stream \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": {
"role": "<string>",
"content": [
{
"response_type": "conversational_search",
"json_schema": {},
"ui_schema": {},
"form_data": {},
"id": "<string>",
"form_operation": "<string>",
"sub_type": "<string>",
"event_type": "<string>",
"dps_payload_id": "<string>"
}
],
"mentions": [
{
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"document_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"parent_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additional_properties": {
"wxa_message": {},
"display_properties": {
"skip_render": false,
"is_async": false,
"form_operation": ""
},
"tool_calls": [
{}
],
"tool_call_id": "<string>",
"tool_name": "<string>",
"wxo_connection_status": {
"connection_status": "<string>",
"connection_message": "<string>"
}
},
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context": {
"values": []
},
"step_history": [
{}
],
"message_state": {}
},
"thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"llm_params": {
"beam_width": 1,
"decoding_method": "greedy",
"include_stop_sequence": true,
"length_penalty": {
"decay_factor": 2,
"start_index": 2
},
"max_new_tokens": 1,
"min_new_tokens": 1,
"random_seed": 2147483648,
"repetition_penalty": 1.5,
"return_options": {
"generated_tokens": false,
"input_parameters": true,
"input_text": false,
"input_tokens": false,
"token_logprobs": false,
"token_ranks": false,
"top_n_tokens": 2
},
"stop_sequences": "[\" and \"]",
"temperature": 1,
"time_limit": 123,
"top_k": 50,
"top_p": 0.5,
"truncate_input_tokens": 1,
"typical_p": 0.505
},
"guardrails": {
"hap": {
"input": {
"enabled": false,
"threshold": 0.5
},
"output": {
"enabled": false,
"threshold": 0.5
},
"mask": {
"remove_entity_value": false
}
},
"social_bias": {
"input": {
"enabled": false,
"threshold": 0.5
},
"output": {
"enabled": false,
"threshold": 0.5
},
"mask": {
"remove_entity_value": false
}
},
"pii": {
"input": {
"enabled": false,
"threshold": 0.5
},
"output": {
"enabled": false,
"threshold": 0.5
},
"mask": {
"remove_entity_value": false
}
}
},
"context": {},
"agent_id": "<string>",
"additional_parameters": {},
"environment_id": "<string>",
"version": 123,
"context_variables": {}
}
'{
"id": "<string>",
"event": "run.started",
"data": {}
}curl --request POST \
--url https://{api_endpoint}/api/v1/orchestrate/runs/stream \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": {
"role": "<string>",
"content": [
{
"response_type": "conversational_search",
"json_schema": {},
"ui_schema": {},
"form_data": {},
"id": "<string>",
"form_operation": "<string>",
"sub_type": "<string>",
"event_type": "<string>",
"dps_payload_id": "<string>"
}
],
"mentions": [
{
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"document_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"parent_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additional_properties": {
"wxa_message": {},
"display_properties": {
"skip_render": false,
"is_async": false,
"form_operation": ""
},
"tool_calls": [
{}
],
"tool_call_id": "<string>",
"tool_name": "<string>",
"wxo_connection_status": {
"connection_status": "<string>",
"connection_message": "<string>"
}
},
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context": {
"values": []
},
"step_history": [
{}
],
"message_state": {}
},
"thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"llm_params": {
"beam_width": 1,
"decoding_method": "greedy",
"include_stop_sequence": true,
"length_penalty": {
"decay_factor": 2,
"start_index": 2
},
"max_new_tokens": 1,
"min_new_tokens": 1,
"random_seed": 2147483648,
"repetition_penalty": 1.5,
"return_options": {
"generated_tokens": false,
"input_parameters": true,
"input_text": false,
"input_tokens": false,
"token_logprobs": false,
"token_ranks": false,
"top_n_tokens": 2
},
"stop_sequences": "[\" and \"]",
"temperature": 1,
"time_limit": 123,
"top_k": 50,
"top_p": 0.5,
"truncate_input_tokens": 1,
"typical_p": 0.505
},
"guardrails": {
"hap": {
"input": {
"enabled": false,
"threshold": 0.5
},
"output": {
"enabled": false,
"threshold": 0.5
},
"mask": {
"remove_entity_value": false
}
},
"social_bias": {
"input": {
"enabled": false,
"threshold": 0.5
},
"output": {
"enabled": false,
"threshold": 0.5
},
"mask": {
"remove_entity_value": false
}
},
"pii": {
"input": {
"enabled": false,
"threshold": 0.5
},
"output": {
"enabled": false,
"threshold": 0.5
},
"mask": {
"remove_entity_value": false
}
}
},
"context": {},
"agent_id": "<string>",
"additional_parameters": {},
"environment_id": "<string>",
"version": 123,
"context_variables": {}
}
'{
"id": "<string>",
"event": "run.started",
"data": {}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Show child attributes
Show child attributes
conversational_search, text, image, option, pause, iframe, connect_to_agent, suggestion, channel_transfer, search, user_defined, video, audio, date, inline_error, chat_with_docs_upload, disconnected_apps, forms, form_operation, document_processing_response Show child attributes
Show child attributes
0 <= x <= 3greedy, sample x >= 0x >= 01 <= x <= 42949672951 <= x <= 2Must be a multiple of 0.01Show child attributes
0 <= x <= 51 - 6 elements"[\" and \"]"
0 <= x <= 2Must be a multiple of 0.011 <= x <= 1000 <= x <= 1Must be a multiple of 0.01x >= 00.01 <= x <= 1Must be a multiple of 0.01Show child attributes
Show child attributes
Show child attributes
Show child attributes
Context variables for the agent execution (e.g., {'wxo_email_id': '[email protected]', 'wxo_user_name': 'John Doe'})
Successful Response
run.started, run.completed, run.failed, run.expired, run.cancelled, run.step.started, run.step.completed, run.step.failed, run.step.delta, message.created, message.started, message.delta, message.completed, run.step.thinking, message.interrupt, transcription, summary, error, done, planning, flow.slot.listen