Download OpenAPI specification:
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
| request_id required | string <uuid> (Request Id) Client-generated UUIDv7 retained with the exact body for retries. |
Thread Id (string) or Thread Id (null) (Thread Id) | |
| input required | string (Input) [ 1 .. 100000 ] characters |
| model required | string (Model) [ 1 .. 128 ] characters |
| max_output_tokens | integer (Max Output Tokens) [ 1 .. 100000 ] Default: 4096 |
System Instructions (string) or System Instructions (null) (System Instructions) | |
| output_format | string (Output Format) Default: "text" Enum: "text" "json" |
JsonObject-Input (object) or null |
{- "request_id": "0194e3b8-8f80-7ba0-9426-317054159cf2",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "input": "string",
- "model": "string",
- "max_output_tokens": 4096,
- "system_instructions": "string",
- "output_format": "text",
- "output_schema": {
- "property1": true,
- "property2": true
}
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "kind": "inference",
- "status": "queued",
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "output": "string",
- "structured_output": {
- "property1": true,
- "property2": true
}, - "wait_id": "bf7a87f9-89e0-481a-a995-b026ca4909e8",
- "error_code": "string",
- "partial": false
}| request_id required | string <uuid> (Request Id) |
| wait | number (Wait) [ 0 .. 30 ] Default: 0 Seconds to hold the request while the execution is queued or running. It returns as soon as the status changes to anything else, or with the current snapshot when the time is up. |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "kind": "inference",
- "status": "queued",
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "output": "string",
- "structured_output": {
- "property1": true,
- "property2": true
}, - "wait_id": "bf7a87f9-89e0-481a-a995-b026ca4909e8",
- "error_code": "string",
- "partial": false
}| request_id required | string <uuid> (Request Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "kind": "inference",
- "status": "queued",
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "output": "string",
- "structured_output": {
- "property1": true,
- "property2": true
}, - "wait_id": "bf7a87f9-89e0-481a-a995-b026ca4909e8",
- "error_code": "string",
- "partial": false
}X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "input_schema": {
- "property1": true,
- "property2": true
}
}
]| agent_id required | string <uuid> (Agent Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "input_schema": {
- "property1": true,
- "property2": true
}
}| agent_id required | string <uuid> (Agent Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
| request_id required | string <uuid> (Request Id) Client-generated UUIDv7 retained with the exact body for retries. |
Thread Id (string) or Thread Id (null) (Thread Id) | |
| input required | string (Input) [ 1 .. 100000 ] characters |
| model | string (Model) [ 1 .. 128 ] characters Default: "auto" |
| upload_ids | Array of strings <uuid> (Upload Ids) <= 100 items [ items <uuid > ] |
| folder_ids | Array of strings <uuid> (Folder Ids) <= 100 items [ items <uuid > ] |
{- "request_id": "0194e3b8-8f80-7ba0-9426-317054159cf2",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "input": "string",
- "model": "auto",
- "upload_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "folder_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "kind": "inference",
- "status": "queued",
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "output": "string",
- "structured_output": {
- "property1": true,
- "property2": true
}, - "wait_id": "bf7a87f9-89e0-481a-a995-b026ca4909e8",
- "error_code": "string",
- "partial": false
}X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "input_schema": {
- "property1": true,
- "property2": true
}
}
]| workflow_id required | string <uuid> (Workflow Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "input_schema": {
- "property1": true,
- "property2": true
}
}| workflow_id required | string <uuid> (Workflow Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
| request_id required | string <uuid> (Request Id) Client-generated UUIDv7 retained with the exact body for retries. |
Thread Id (string) or Thread Id (null) (Thread Id) | |
object (JsonObject-Input) | |
Trigger (string) or Trigger (null) (Trigger) | |
JsonObject-Input (object) or null |
{- "request_id": "0194e3b8-8f80-7ba0-9426-317054159cf2",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "inputs": {
- "property1": true,
- "property2": true
}, - "trigger": "string",
- "trigger_input": {
- "property1": true,
- "property2": true
}
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "kind": "inference",
- "status": "queued",
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "output": "string",
- "structured_output": {
- "property1": true,
- "property2": true
}, - "wait_id": "bf7a87f9-89e0-481a-a995-b026ca4909e8",
- "error_code": "string",
- "partial": false
}| kind required | string (Kind) Enum: "agent" "workflow" |
| execution_id required | string <uuid> (Execution Id) |
| wait | number (Wait) [ 0 .. 30 ] Default: 0 Seconds to hold the request while the execution is queued or running. It returns as soon as the status changes to anything else, or with the current snapshot when the time is up. |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "kind": "inference",
- "status": "queued",
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "output": "string",
- "structured_output": {
- "property1": true,
- "property2": true
}, - "wait_id": "bf7a87f9-89e0-481a-a995-b026ca4909e8",
- "error_code": "string",
- "partial": false
}| kind required | string (Kind) Enum: "agent" "workflow" |
| execution_id required | string <uuid> (Execution Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
- "kind": "inference",
- "status": "queued",
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "output": "string",
- "structured_output": {
- "property1": true,
- "property2": true
}, - "wait_id": "bf7a87f9-89e0-481a-a995-b026ca4909e8",
- "error_code": "string",
- "partial": false
}| kind required | string (Kind) Enum: "agent" "workflow" |
| execution_id required | string <uuid> (Execution Id) |
| limit | integer (Limit) [ 1 .. 500 ] Default: 100 |
| offset | integer (Offset) [ 0 .. 100000 ] Default: 0 |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "size_bytes": 0,
- "download_path": "string"
}
]| kind required | string (Kind) Enum: "agent" "workflow" |
| execution_id required | string <uuid> (Execution Id) |
| artifact_id required | string <uuid> (Artifact Id) |
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": { }
}
]
}| wait_id required | string <uuid> (Wait Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "kind": "string",
- "status": "string",
- "prompt": {
- "property1": true,
- "property2": true
}
}| wait_id required | string <uuid> (Wait Id) |
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id) |
| idempotency_key required | string (Idempotency Key) [ 8 .. 191 ] characters |
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": "stringst",
- "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
}
}
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "kind": "string",
- "status": "string",
- "prompt": {
- "property1": true,
- "property2": 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) <= 500 characters 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) 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) 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
}