Download OpenAPI specification:
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
[- {
- "llm_id": 0,
- "llm_type_id": 0,
- "profile_id": "string",
- "name": "string",
- "description": "string",
- "deployment_name": "string",
- "slug": "string",
- "is_active": true,
- "is_frontend_visible": true,
- "is_premium": true,
- "is_default_chat_model": false,
- "is_legacy": false,
- "cost_per_1k_input_token_usd": 0,
- "cost_per_1k_cached_input_token_usd": 0,
- "cost_per_1k_cache_write_input_token_usd": 0,
- "cost_per_1k_output_token_usd": 0,
- "max_input_tokens": 0,
- "max_output_tokens": 0,
- "is_thinking_model": true,
- "available_reasoning_efforts": "string",
- "default_reasoning_effort": "string",
- "is_reasoning_locked": false,
- "available_feature_slugs": "string",
- "is_favorite": false,
- "cost_tier": "string"
}
]| llm_id required | integer (Llm Id) >= 1 |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "property1": true,
- "property2": true
}X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "session_id": "string",
- "model": "string",
- "expires_at": 0,
- "client_secret": {
- "value": "string",
- "expires_at": 0
}
}| session_id required | string (Session Id) [ 1 .. 128 ] characters |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
RealtimeUsageBucket (object) or null | |
RealtimeUsageBucket (object) or null | |
| status | string (Status) Default: "completed" Enum: "completed" "error" "cancelled" |
{- "realtime": {
- "input_tokens": 0,
- "output_tokens": 0,
- "total_cost_usd": 0
}, - "transcription": {
- "input_tokens": 0,
- "output_tokens": 0,
- "total_cost_usd": 0
}, - "status": "completed"
}null| session_id required | string (Session Id) [ 1 .. 128 ] characters |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
nullX-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
| audio_file required | string <application/octet-stream> (Audio File) |
| language | string (Language) Default: "en" |
{- "duration": 0,
- "text": "string",
- "segments": [
- {
- "start": 0,
- "end": 0,
- "text": "string"
}
], - "total_cost_usd": 0,
- "input_tokens": 0,
- "output_tokens": 0
}X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
| utterance required | string (Utterance) The user's message or question to send to the agent |
Utterance Id (string) or Utterance Id (null) (Utterance Id) Client-generated UUID7 for the utterance (for optimistic UI) | |
Startup Trace Id (string) or Startup Trace Id (null) (Startup Trace Id) Browser-generated startup trace retained across durable dispatch | |
Array of Message Parts (objects) or Message Parts (null) (Message Parts) Optional structured message parts. When omitted, the utterance is stored as one text part. | |
| thread_mode | string (Thread Mode) Default: "agent" Enum: "agent" "workflow" "write" Thread mode: 'agent' (default), 'workflow', or 'write' |
Agent Id (string) or Agent Id (null) (Agent Id) Agent ID to use (defaults to mode-appropriate internal agent) | |
Model (string) or Model (null) (Model) Model slug to use (defaults to 'auto-fast') | |
Reasoning Effort (string) or Reasoning Effort (null) (Reasoning Effort) Reasoning effort level (e.g., 'minimal', 'low', 'medium', 'high', 'xhigh', 'max') | |
Client Timezone (string) or Client Timezone (null) (Client Timezone) IANA timezone reported by the calling client (for example, 'America/Chicago') | |
Thread Id (string) or Thread Id (null) (Thread Id) Existing thread ID to continue conversation, or null for new thread | |
Thread Folder Id (string) or Thread Folder Id (null) (Thread Folder Id) Folder ID to organize a newly created thread | |
System Instructions (string) or System Instructions (null) (System Instructions) Additional system instructions for the agent | |
Array of Upload Ids (strings) or Upload Ids (null) (Upload Ids) IDs of uploaded files to include in context | |
Array of Folder Ids (strings) or Folder Ids (null) (Folder Ids) IDs of folders to search for context | |
Array of Active Skill Slugs (strings) or Active Skill Slugs (null) (Active Skill Slugs) Optional list of explicitly activated sandbox skills. | |
Persona Id (string) or Persona Id (null) (Persona Id) ID of the persona to apply | |
ThreadAgentResourceContext (object) or null Optional context for server-side generator routing. |
{- "utterance": "string",
- "utterance_id": "0c682eb6-7e43-4c9b-9b55-314e09e4e36b",
- "startup_trace_id": "96f5c7b3-987b-439b-981a-72843c42d628",
- "message_parts": [
- { }
], - "thread_mode": "agent",
- "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
- "model": "string",
- "reasoning_effort": "string",
- "client_timezone": "string",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "thread_folder_id": "7e19fe12-702e-42b4-9ecf-1117e64fefd3",
- "system_instructions": "string",
- "upload_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "folder_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "active_skill_slugs": [
- "string"
], - "persona_id": "84321d19-6cb7-45af-a8d3-0bb38b11a872",
- "resource_context": {
- "resource_type": "workflow",
- "mode": "create",
- "target_resource_id": "19fdebe7-c5db-4b7d-a5db-4e8518e530a8",
- "link_thread_to_resource": false
}
}{- "thread_run": {
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "utterance_id": "0c682eb6-7e43-4c9b-9b55-314e09e4e36b",
- "utterance_content": "string",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "tool_call_id": "6786703c-7c59-49a0-b3ee-bc30b7ddc419",
- "thread_run_status_type_id": 0,
- "thread_mode": "agent",
- "created_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "error_message": "string",
- "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
- "turn_index": 0,
- "llm_id": 0,
- "reasoning_effort": "string",
- "capability_snapshot": {
- "property1": true,
- "property2": true
}, - "execution_mode": "server",
- "harness_session_id": "5ad5227b-42f8-46fa-aa22-ef0a35092f9b",
- "current_wait_id": "153bdf58-4abf-4be9-85eb-c71ffae6bb1d",
- "folder_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "upload_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "persona_id": "84321d19-6cb7-45af-a8d3-0bb38b11a872",
- "system_instructions": "string",
- "include_citations": true,
- "source_app": "redbelt_ui",
- "connector_metadata": {
- "property1": true,
- "property2": true
}
}, - "utterance": {
- "utterance_id": "0c682eb6-7e43-4c9b-9b55-314e09e4e36b",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "content": "string",
- "prompt_id": "24783230-27c2-455c-9de9-95bbdbb78c3d",
- "parts": [
- {
- "property1": true,
- "property2": true
}
], - "created_at": "2019-08-24T14:15:22Z"
}, - "thread": {
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "title": "string",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "is_archived": false,
- "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
- "folder_name": "string",
- "tags": [ ],
- "created_at": "2019-08-24T14:15:22Z",
- "last_modified_at": "2019-08-24T14:15:22Z",
- "external_user_id": "string",
- "utterances": [ ],
- "agent_actions": [ ],
- "tool_data": {
- "property1": {
- "tool_call": {
- "tool_call_id": "6786703c-7c59-49a0-b3ee-bc30b7ddc419",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "llm_tool_call_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "arguments": "string",
- "is_approved": true,
- "metadata": {
- "property1": true,
- "property2": true
}, - "orchestrator_action_id": "b7227590-acba-4f70-b25a-ce4264bb5e26",
- "workflow_step_run_id": "8731ce24-7f50-4903-9b9d-bd5598803a93",
- "plugin_version_id": "8a502dd0-15ec-4f09-9fa8-1b62d6865097",
- "plugin_tool_key": "string",
- "plugin_renderer_key": "string",
- "plugin_presentation_mode": "string",
- "plugin_display_name": "string",
- "plugin_icon_url": "string",
- "plugin_tool_display_name": "string",
- "plugin_tool_icon_url": "string",
- "plugin_activity_category": "string",
- "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
- "execution_state": "string"
}, - "tool_result": {
- "tool_call_id": "6786703c-7c59-49a0-b3ee-bc30b7ddc419",
- "content": "string",
- "output": {
- "property1": true,
- "property2": true
}, - "metadata": {
- "property1": true,
- "property2": true
}, - "total_cost_usd": 0,
- "external_cost_usd": 0,
- "num_llm_calls": 0,
- "runtime_seconds": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "blobs": [
- "string"
], - "tool_result_status_type_id": 0
}
}, - "property2": {
- "tool_call": {
- "tool_call_id": "6786703c-7c59-49a0-b3ee-bc30b7ddc419",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "llm_tool_call_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "arguments": "string",
- "is_approved": true,
- "metadata": {
- "property1": true,
- "property2": true
}, - "orchestrator_action_id": "b7227590-acba-4f70-b25a-ce4264bb5e26",
- "workflow_step_run_id": "8731ce24-7f50-4903-9b9d-bd5598803a93",
- "plugin_version_id": "8a502dd0-15ec-4f09-9fa8-1b62d6865097",
- "plugin_tool_key": "string",
- "plugin_renderer_key": "string",
- "plugin_presentation_mode": "string",
- "plugin_display_name": "string",
- "plugin_icon_url": "string",
- "plugin_tool_display_name": "string",
- "plugin_tool_icon_url": "string",
- "plugin_activity_category": "string",
- "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
- "execution_state": "string"
}, - "tool_result": {
- "tool_call_id": "6786703c-7c59-49a0-b3ee-bc30b7ddc419",
- "content": "string",
- "output": {
- "property1": true,
- "property2": true
}, - "metadata": {
- "property1": true,
- "property2": true
}, - "total_cost_usd": 0,
- "external_cost_usd": 0,
- "num_llm_calls": 0,
- "runtime_seconds": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "blobs": [
- "string"
], - "tool_result_status_type_id": 0
}
}
}, - "workflow_runs": [ ],
- "workflow_step_runs": [ ],
- "compactions": [ ],
- "timeline": [ ],
- "last_thread_run": {
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "utterance_id": "0c682eb6-7e43-4c9b-9b55-314e09e4e36b",
- "utterance_content": "string",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "tool_call_id": "6786703c-7c59-49a0-b3ee-bc30b7ddc419",
- "thread_run_status_type_id": 0,
- "thread_mode": "agent",
- "created_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "error_message": "string",
- "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
- "turn_index": 0,
- "llm_id": 0,
- "reasoning_effort": "string",
- "capability_snapshot": {
- "property1": true,
- "property2": true
}, - "execution_mode": "server",
- "harness_session_id": "5ad5227b-42f8-46fa-aa22-ef0a35092f9b",
- "current_wait_id": "153bdf58-4abf-4be9-85eb-c71ffae6bb1d",
- "folder_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "upload_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "persona_id": "84321d19-6cb7-45af-a8d3-0bb38b11a872",
- "system_instructions": "string",
- "include_citations": true,
- "source_app": "redbelt_ui",
- "connector_metadata": {
- "property1": true,
- "property2": true
}
}, - "thread_artifacts": [ ],
- "latest_compaction": {
- "thread_compaction_id": "3c3ea082-4dfd-43f8-b8b7-aa2f4cba8525",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "workflow_step_run_id": "8731ce24-7f50-4903-9b9d-bd5598803a93",
- "include_in_history": true,
- "previous_thread_compaction_id": "28b1ea32-3c4e-45e9-914a-9b1d95dfca46",
- "llm_id": 0,
- "trigger_type": "string",
- "summary": "string",
- "compacted_through_utterance_id": "91d45097-af3c-4b1f-95f1-9bc496acc748",
- "compacted_through_action_id": "e04fc8ad-e06e-4c79-823e-0c50262e082c",
- "retained_tail_start_utterance_id": "19c8e956-4458-434f-ae5c-b514f2fabf61",
- "retained_tail_start_action_id": "795eeb36-fa92-4882-8f0e-82ef5e2edce8",
- "tokens_before": 0,
- "tokens_after": 0,
- "total_cost_usd": 0,
- "response_seconds": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
}
}| wait_id required | string <uuid> (Wait Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "wait_id": "bf7a87f9-89e0-481a-a995-b026ca4909e8",
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "wait_kind": "string",
- "status": "string",
- "prompt_payload": {
- "property1": true,
- "property2": true
}, - "response_payload": {
- "property1": true,
- "property2": true
}, - "compute_hold_until": "2019-08-24T14:15:22Z",
- "compute_released_at": "2019-08-24T14:15:22Z",
- "checkpoint_id": "4d0293ba-f0d3-4c7e-8eba-c2cef877c686",
- "tool_call_id": "6786703c-7c59-49a0-b3ee-bc30b7ddc419",
- "created_at": "2019-08-24T14:15:22Z",
- "fulfilled_at": "2019-08-24T14:15:22Z"
}| wait_id required | string <uuid> (Wait Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
Array of Answers (objects) or Answers (null) (Answers) | |
Decision (string) or Decision (null) (Decision) | |
Array of Folder Ids (strings) or Folder Ids (null) (Folder Ids) | |
Array of Upload Ids (strings) or Upload Ids (null) (Upload Ids) | |
Tool Parameters (object) or Tool Parameters (null) (Tool Parameters) | |
Idempotency Key (string) or Idempotency Key (null) (Idempotency Key) |
{- "answers": [
- {
- "question_id": "string",
- "selected_option_id": "string",
- "selected_option_answer": "string",
- "used_other": false,
- "other_text": "string",
- "folder_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "upload_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "selected_paths": [
- "string"
]
}
], - "decision": "string",
- "folder_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "upload_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "tool_parameters": {
- "property1": {
- "property1": true,
- "property2": true
}, - "property2": {
- "property1": true,
- "property2": true
}
}, - "idempotency_key": "stringst"
}{- "wait": {
- "wait_id": "bf7a87f9-89e0-481a-a995-b026ca4909e8",
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "wait_kind": "string",
- "status": "string",
- "prompt_payload": {
- "property1": true,
- "property2": true
}, - "response_payload": {
- "property1": true,
- "property2": true
}, - "compute_hold_until": "2019-08-24T14:15:22Z",
- "compute_released_at": "2019-08-24T14:15:22Z",
- "checkpoint_id": "4d0293ba-f0d3-4c7e-8eba-c2cef877c686",
- "tool_call_id": "6786703c-7c59-49a0-b3ee-bc30b7ddc419",
- "created_at": "2019-08-24T14:15:22Z",
- "fulfilled_at": "2019-08-24T14:15:22Z"
}, - "tool_result": {
- "tool_call_id": "6786703c-7c59-49a0-b3ee-bc30b7ddc419",
- "content": "string",
- "output": {
- "property1": true,
- "property2": true
}, - "metadata": {
- "property1": true,
- "property2": true
}, - "total_cost_usd": 0,
- "external_cost_usd": 0,
- "num_llm_calls": 0,
- "runtime_seconds": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "blobs": [
- "string"
], - "tool_result_status_type_id": 0
}, - "agent_action": {
- "orchestrator_action_id": "b7227590-acba-4f70-b25a-ce4264bb5e26",
- "utterance_id": "0c682eb6-7e43-4c9b-9b55-314e09e4e36b",
- "orchestrator_action_type_id": 0,
- "llm_id": 0,
- "content": "string",
- "response_seconds": 0,
- "input_token_cost_usd": 0,
- "output_token_cost_usd": 0,
- "input_tokens": 0,
- "uncached_input_tokens": 0,
- "cached_input_tokens": 0,
- "cache_write_input_tokens": 0,
- "output_tokens": 0,
- "cached_input_token_cost_usd": 0,
- "cache_write_input_token_cost_usd": 0,
- "thinking": "string",
- "thinking_seconds": 0,
- "encrypted_reasoning_content": "string",
- "thought_signature": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
- "handoff_agent_id": "8787af99-f3a7-41fb-8d2b-86f824d50296",
- "turn_index": 0,
- "metadata": {
- "property1": true,
- "property2": true
}, - "workflow_step_run_id": "8731ce24-7f50-4903-9b9d-bd5598803a93",
- "output_template_id": "2c21cbd9-7634-4129-a906-4483ea4e2061",
- "include_in_history": true
}
}X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
| folder_id required | string <uuid> (Folder Id) The ID of the folder where the file will be uploaded |
| file_name required | string (File Name) The name of the file being uploaded including the extension |
| size required | integer (Size) The total size of the file in bytes (max 512MB) |
Metadata (object) or Metadata (null) (Metadata) Optional metadata dictionary associated with the file | |
Array of Tags (strings) or Tags (null) (Tags) Optional list of tags for categorizing the file | |
Client Batch Id (string) or Client Batch Id (null) (Client Batch Id) Optional batch identifier for grouping multiple uploads | |
External Id (string) or External Id (null) (External Id) Client-provided external identifier (<=64 chars) |
{- "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
- "file_name": "string",
- "size": 0,
- "metadata": { },
- "tags": [
- "string"
], - "client_batch_id": "string",
- "external_id": "string"
}{- "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
- "part_size": 0,
- "num_parts": 0,
- "file_type_id": 0
}| upload_id required | string <uuid> (Upload Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
| file_name required | string (File Name) The updated name of the file including the extension |
| size required | integer (Size) The total size of the file in bytes (max 512MB) |
Metadata (object) or Metadata (null) (Metadata) Optional metadata associated with the updated file | |
Array of Tags (strings) or Tags (null) (Tags) Optional list of tags for the updated file | |
Client Batch Id (string) or Client Batch Id (null) (Client Batch Id) Optional batch identifier for grouping uploads | |
Expected Revision (integer) or Expected Revision (null) (Expected Revision) Optional raw-content compare-and-set token |
{- "file_name": "string",
- "size": 0,
- "metadata": { },
- "tags": [
- "string"
], - "client_batch_id": "string",
- "expected_revision": 1
}{- "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
- "part_size": 0,
- "num_parts": 0,
- "file_type_id": 0
}| upload_id required | string <uuid> (Upload Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
Title (string) or Title (null) (Title) | |
File Name (string) or File Name (null) (File Name) | |
Metadata (object) or Metadata (null) (Metadata) | |
Array of Tags (strings) or Tags (null) (Tags) | |
Folder Id (string) or Folder Id (null) (Folder Id) | |
External Id (string) or External Id (null) (External Id) |
{- "title": "string",
- "file_name": "string",
- "metadata": { },
- "tags": [
- "string"
], - "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
- "external_id": "string"
}null| upload_id required | string <uuid> (Upload Id) ID of the upload object |
| part_number required | integer (Part Number) The part number being uploaded (1-based indexing) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
- "part_number": 0,
- "received_bytes": 0
}| upload_id required | string <uuid> (Upload Id) ID of the upload object |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
- "status": "string"
}| upload_id required | string <uuid> (Upload Id) ID of the incomplete upload object |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string",
- "input": null,
- "ctx": { }
}
]
}| upload_id required | string <uuid> (Upload Id) ID of the upload object |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
- "file_name": "string",
- "blob_name": "string",
- "staging_blob_name": "string",
- "committed_blob_name": "string",
- "committed_blob_deleted": true,
- "status": "string",
- "part_size": 0,
- "num_parts": 0,
- "parts_received": 0,
- "size": 0,
- "client_batch_id": "string",
- "content_revision": 1
}| upload_id required | string <uuid> (Upload Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
- "file_name": "string",
- "markdown": "string",
- "content_revision": 1,
- "writable": true
}| upload_id required | string <uuid> (Upload Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
| markdown required | string (Markdown) <= 2000000 characters |
| expected_revision required | integer (Expected Revision) >= 1 |
{- "markdown": "string",
- "expected_revision": 1
}{- "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
- "file_name": "string",
- "content_revision": 1
}| upload_id required | string <uuid> (Upload Id) ID of the upload object |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "title": "string",
- "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
- "file_name": "string",
- "source_type": "user_upload",
- "source_metadata": { },
- "external_id": "string",
- "metadata": { },
- "created_at": "2019-08-24T14:15:22Z",
- "last_modified_at": "2019-08-24T14:15:22Z",
- "delete_at": "2019-08-24T14:15:22Z",
- "is_deleted": false,
- "last_modified_by_user_id": "ee1a2e7e-88a3-4b95-8ec0-7ebb834a0317",
- "upload_status_type_id": 0,
- "file_type_id": 0,
- "has_tables": false,
- "size": 0,
- "tags": [
- "string"
], - "blob_name": "string",
- "content_revision": 1
}[- {
- "tool_key": "string",
- "name": "string",
- "description": "string",
- "family": "string",
- "aliases": [
- "string"
], - "tool_group_id": 0,
- "tool_group_slug": "string",
- "tool_group_name": "string",
- "tool_group_description": "string",
- "tool_group_sort_order": 0,
- "tool_group_is_frontend_visible": true,
- "tool_group_is_advanced": true
}
]| public_id required | string (Public Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "public_id": "string",
- "interface_type": "form",
- "name": "string",
- "description": "string",
- "logo_url": "string",
- "config": {
- "property1": true,
- "property2": true
}, - "style_config": {
- "property1": true,
- "property2": true
}, - "limits_config": {
- "property1": true,
- "property2": true
}, - "identity_config": {
- "property1": true,
- "property2": true
}, - "input_schema": {
- "property1": true,
- "property2": true
}, - "chat_input_field": "string",
- "compatibility_errors": [
- "string"
], - "compatibility_warnings": [
- "string"
]
}| public_id required | string (Public Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
| anonymous_id required | string (Anonymous Id) [ 8 .. 255 ] characters |
Identity Token (string) or Identity Token (null) (Identity Token) | |
Access Token (string) or Access Token (null) (Access Token) | |
Referrer (string) or Referrer (null) (Referrer) | |
Hcaptcha Token (string) or Hcaptcha Token (null) (Hcaptcha Token) | |
Recaptcha Token (string) or Recaptcha Token (null) (Recaptcha Token) |
{- "anonymous_id": "stringst",
- "identity_token": "string",
- "access_token": "string",
- "referrer": "string",
- "hcaptcha_token": "string",
- "recaptcha_token": "string"
}{- "workflow_export_session_id": "711da8be-d762-4dfa-8195-70b79d3913db",
- "session_token": "string",
- "identity_verified": true,
- "user_label": "string"
}| public_id required | string (Public Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
Title (string) or Title (null) (Title) |
{- "title": "string"
}{- "workflow_export_conversation_id": "890ddb88-673f-4083-a183-0880d0d38819",
- "workflow_export_id": "d3b4937e-0e12-48a7-963a-db022ef90f5f",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "workflow_export_session_id": "711da8be-d762-4dfa-8195-70b79d3913db",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "status": "string",
- "title": "string",
- "last_message_preview": "string",
- "external_user_label": "string",
- "source": "external",
- "started_at": "2019-08-24T14:15:22Z",
- "last_activity_at": "2019-08-24T14:15:22Z",
- "closed_at": "2019-08-24T14:15:22Z",
- "user_label": "string",
- "identity_verified": true,
- "run_count": 0,
- "latest_run_status": "string"
}| public_id required | string (Public Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
| conversation_id required | string <uuid> (Conversation Id) |
| field_name required | string (Field Name) |
| file required | string <application/octet-stream> (File) |
{- "artifact_id": "b7bd6bbb-c7f1-4314-8742-2aeeeece9d12",
- "artifact_ref": "string",
- "artifact_path": "string",
- "file_name": "string",
- "content_type": "string",
- "size_bytes": 0,
- "distillation_status": "string"
}| public_id required | string (Public Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
Workflow Export Conversation Id (string) or Workflow Export Conversation Id (null) (Workflow Export Conversation Id) | |
Workflow Export Run Id (string) or Workflow Export Run Id (null) (Workflow Export Run Id) | |
| event_type required | string (Event Type) [ 1 .. 64 ] characters ^[a-z0-9_.:-]+$ |
Event Name (string) or Event Name (null) (Event Name) | |
Object Type (string) or Object Type (null) (Object Type) | |
Object Id (string) or Object Id (null) (Object Id) | |
Object Label (string) or Object Label (null) (Object Label) | |
Object Url (string) or Object Url (null) (Object Url) | |
Value Decimal (number) or Value Decimal (string) or Value Decimal (null) (Value Decimal) | |
object (JsonObject-Input) | |
Page Url (string) or Page Url (null) (Page Url) | |
Client Event Id (string) or Client Event Id (null) (Client Event Id) | |
Client Event At (string) or Client Event At (null) (Client Event At) |
{- "workflow_export_conversation_id": "890ddb88-673f-4083-a183-0880d0d38819",
- "workflow_export_run_id": "472f9ffa-c8fd-4ea4-a4e0-272f9dc6197d",
- "event_type": "string",
- "event_name": "string",
- "object_type": "string",
- "object_id": "string",
- "object_label": "string",
- "object_url": "string",
- "value_decimal": 0,
- "metadata": {
- "property1": true,
- "property2": true
}, - "page_url": "string",
- "client_event_id": "string",
- "client_event_at": "2019-08-24T14:15:22Z"
}{- "workflow_export_event_id": "daf76bd2-c9a7-4e36-8bf6-f793d757af2c",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "workflow_export_id": "d3b4937e-0e12-48a7-963a-db022ef90f5f",
- "workflow_export_session_id": "711da8be-d762-4dfa-8195-70b79d3913db",
- "workflow_export_conversation_id": "890ddb88-673f-4083-a183-0880d0d38819",
- "workflow_export_run_id": "472f9ffa-c8fd-4ea4-a4e0-272f9dc6197d",
- "workflow_run_id": "5e5ef678-2347-491b-a579-798b0d4ed952",
- "thread_run_id": "097cb672-86f3-4b38-bcb4-debf5c0d1a42",
- "trigger_utterance_id": "fc76dfdb-3301-4107-87b2-e96e20086ffe",
- "source": "external",
- "event_type": "string",
- "event_name": "string",
- "object_type": "string",
- "object_id": "string",
- "object_label": "string",
- "object_url": "string",
- "value_decimal": 0,
- "metadata": {
- "property1": true,
- "property2": true
}, - "page_url": "string",
- "client_event_id": "string",
- "client_event_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z"
}| public_id required | string (Public Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
| workflow_export_session_id required | string <uuid> (Workflow Export Session Id) |
Conversation Id (string) or Conversation Id (null) (Conversation Id) | |
object (JsonObject-Input) | |
Message (string) or Message (null) (Message) | |
User Timezone (string) or User Timezone (null) (User Timezone) |
{- "workflow_export_session_id": "711da8be-d762-4dfa-8195-70b79d3913db",
- "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",
- "inputs": {
- "property1": true,
- "property2": true
}, - "message": "string",
- "user_timezone": "string"
}{- "workflow_export_run_id": "472f9ffa-c8fd-4ea4-a4e0-272f9dc6197d",
- "workflow_run_id": "5e5ef678-2347-491b-a579-798b0d4ed952",
- "thread_run_id": "097cb672-86f3-4b38-bcb4-debf5c0d1a42",
- "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",
- "stream_url": "string",
- "status": "string"
}| public_id required | string (Public Id) |
| workflow_export_run_id required | string <uuid> (Workflow Export Run Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
null