API docs by Redocly

Redbelt API (1.0.0)

Download OpenAPI specification:

threads

Get Frontend Llms

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Toggle Llm Favorite

Authorizations:
BearerAuth
path Parameters
llm_id
required
integer (Llm Id) >= 1

Responses

Response samples

Content type
application/json
{
  • "property1": true,
  • "property2": true
}

Create Realtime Session

Authorizations:
BearerAuth
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)

Responses

Response samples

Content type
application/json
{
  • "session_id": "string",
  • "model": "string",
  • "expires_at": 0,
  • "client_secret": {
    }
}

Report Realtime Session Usage

Authorizations:
BearerAuth
path Parameters
session_id
required
string (Session Id) [ 1 .. 128 ] characters
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
object (RealtimeUsageBucket)
object (RealtimeUsageBucket)
status
string (Status)
Default: "completed"
Enum: "completed" "error" "cancelled"

Responses

Request samples

Content type
application/json
{
  • "realtime": {
    },
  • "transcription": {
    },
  • "status": "completed"
}

Response samples

Content type
application/json
null

Transcribe Dictation Audio

Authorizations:
BearerAuth
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: multipart/form-data
required
audio_file
required
string <application/octet-stream> (Audio File)
language
string (Language)
Default: "en"

Responses

Response samples

Content type
application/json
{
  • "duration": 0,
  • "text": "string",
  • "segments": [
    ],
  • "total_cost_usd": 0,
  • "input_tokens": 0,
  • "output_tokens": 0
}

Run Thread Agent

Authorizations:
BearerAuth
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
utterance
required
string (Utterance)

The user's message or question to send to the agent

utterance_id
string <uuid> (Utterance Id)

Client-generated UUID7 for the utterance (for optimistic UI)

Array of objects (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 <uuid> (Agent Id)

Agent ID to use (defaults to mode-appropriate internal agent)

model
string (Model)

Model slug to use (defaults to 'auto-fast')

reasoning_effort
string (Reasoning Effort)

Reasoning effort level (e.g., 'minimal', 'low', 'medium', 'high', 'xhigh', 'max')

client_timezone
string (Client Timezone) <= 64 characters

IANA timezone reported by the calling client (for example, 'America/Chicago')

thread_id
string <uuid> (Thread Id)

Existing thread ID to continue conversation, or null for new thread

thread_folder_id
string <uuid> (Thread Folder Id)

Folder ID to organize a newly created thread

system_instructions
string (System Instructions)

Additional system instructions for the agent

allowed_tools
Array of strings (Allowed Tools)

List of tool names the agent is allowed to use

object (Tool Parameters)

Parameters for specific tools (tool_name -> parameters).

pre_run_tool
string (Pre Run Tool)

Tool to execute before the agent processes the utterance

required_tool
string (Required Tool)

Tool that must be executed during this run

upload_ids
Array of strings <uuid> (Upload Ids) [ items <uuid > ]

IDs of uploaded files to include in context

folder_ids
Array of strings <uuid> (Folder Ids) [ items <uuid > ]

IDs of folders to search for context

active_skill_slugs
Array of strings (Active Skill Slugs)

Optional list of explicitly activated sandbox skills.

persona_id
string <uuid> (Persona Id)

ID of the persona to apply in write mode

textdoc_id
string <uuid> (Textdoc Id)

ID of the TextDoc to operate on in write mode

object (ThreadAgentResourceContext)

Optional context for server-side generator routing.

Responses

Request samples

Content type
application/json
{
  • "utterance": "string",
  • "utterance_id": "0c682eb6-7e43-4c9b-9b55-314e09e4e36b",
  • "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",
  • "allowed_tools": [
    ],
  • "tool_parameters": {
    },
  • "pre_run_tool": "string",
  • "required_tool": "string",
  • "upload_ids": [
    ],
  • "folder_ids": [
    ],
  • "active_skill_slugs": [
    ],
  • "persona_id": "84321d19-6cb7-45af-a8d3-0bb38b11a872",
  • "textdoc_id": "f7a1f879-a5ee-4bd7-bf59-497e3aeb3b8c",
  • "resource_context": {
    }
}

Response samples

Content type
application/json
{
  • "thread_run": {
    },
  • "utterance": {
    },
  • "thread": {
    }
}

Approve Thread Run

Authorizations:
BearerAuth
path Parameters
run_id
required
string (Run Id)
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
decision
required
string (Decision)
Enum: "approve" "approve_with_edits" "reject"
upload_ids
Array of strings <uuid> (Upload Ids) [ items <uuid > ]
folder_ids
Array of strings <uuid> (Folder Ids) [ items <uuid > ]
object (Tool Parameters)

Responses

Request samples

Content type
application/json
{
  • "decision": "approve",
  • "upload_ids": [
    ],
  • "folder_ids": [
    ],
  • "tool_parameters": {
    }
}

Response samples

Content type
application/json
{
  • "tool_call": {
    },
  • "tool_result": {
    },
  • "agent_action": {
    },
  • "thread_deleted": false
}

Get Pending Thread Wait

Authorizations:
BearerAuth
path Parameters
thread_id
required
string <uuid> (Thread Id)
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)

Responses

Response samples

Content type
application/json
Example
{
  • "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": {
    },
  • "response_payload": {
    },
  • "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"
}

Respond To Thread Wait

Authorizations:
BearerAuth
path Parameters
wait_id
required
string <uuid> (Wait Id)
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
Array of objects (Answers)
decision
string (Decision)
folder_ids
Array of strings <uuid> (Folder Ids) [ items <uuid > ]
upload_ids
Array of strings <uuid> (Upload Ids) [ items <uuid > ]
object (Tool Parameters)

Responses

Request samples

Content type
application/json
{
  • "answers": [
    ],
  • "decision": "string",
  • "folder_ids": [
    ],
  • "upload_ids": [
    ],
  • "tool_parameters": {
    }
}

Response samples

Content type
application/json
{
  • "wait": {
    },
  • "tool_result": {
    },
  • "agent_action": {
    },
  • "thread_deleted": false
}

files

Start Upload

Authorizations:
BearerAuth
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
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)

object (Metadata)

Optional metadata dictionary associated with the file

tags
Array of strings (Tags)

Optional list of tags for categorizing the file

client_batch_id
string (Client Batch Id)

Optional batch identifier for grouping multiple uploads

external_id
string (External Id)

Client-provided external identifier (<=64 chars)

Responses

Request samples

Content type
application/json
{
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "file_name": "string",
  • "size": 0,
  • "metadata": { },
  • "tags": [
    ],
  • "client_batch_id": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
  • "part_size": 0,
  • "num_parts": 0,
  • "file_type_id": 0
}

Start Update Upload

Authorizations:
BearerAuth
path Parameters
upload_id
required
string <uuid> (Upload Id)
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
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)

object (Metadata)

Optional metadata associated with the updated file

tags
Array of strings (Tags)

Optional list of tags for the updated file

client_batch_id
string (Client Batch Id)

Optional batch identifier for grouping uploads

Responses

Request samples

Content type
application/json
{
  • "file_name": "string",
  • "size": 0,
  • "metadata": { },
  • "tags": [
    ],
  • "client_batch_id": "string"
}

Response samples

Content type
application/json
{
  • "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
  • "part_size": 0,
  • "num_parts": 0,
  • "file_type_id": 0
}

Update File Metadata

Authorizations:
BearerAuth
path Parameters
upload_id
required
string <uuid> (Upload Id)
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
title
string (Title)
file_name
string (File Name)
object (Metadata)
tags
Array of strings (Tags)
folder_id
string <uuid> (Folder Id)
external_id
string (External Id)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "file_name": "string",
  • "metadata": { },
  • "tags": [
    ],
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "external_id": "string"
}

Response samples

Content type
application/json
null

Upload Part

Authorizations:
BearerAuth
path Parameters
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)

header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)

Responses

Response samples

Content type
application/json
{
  • "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
  • "part_number": 0,
  • "received_bytes": 0
}

Finish Upload

Authorizations:
BearerAuth
path Parameters
upload_id
required
string <uuid> (Upload Id)

ID of the upload object

header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)

Responses

Response samples

Content type
application/json
{
  • "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
  • "status": "string"
}

Abort Upload

Authorizations:
BearerAuth
path Parameters
upload_id
required
string <uuid> (Upload Id)

ID of the incomplete upload object

header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get Upload Session

Authorizations:
BearerAuth
path Parameters
upload_id
required
string <uuid> (Upload Id)

ID of the upload object

header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)

Responses

Response samples

Content type
application/json
{
  • "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"
}

Get Upload

Authorizations:
BearerAuth
path Parameters
upload_id
required
string <uuid> (Upload Id)

ID of the upload object

header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "blob_name": "string"
}

tools

Get Frontend Tools

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

workflow_exports

Get Workflow Export Embed Shell

Authorizations:
BearerAuth
path Parameters
public_id
required
string (Public Id)

Responses

Response samples

Content type
application/json
null

Get Public Workflow Export Config

Authorizations:
BearerAuth
path Parameters
public_id
required
string (Public Id)

Responses

Response samples

Content type
application/json
{
  • "public_id": "string",
  • "interface_type": "form",
  • "name": "string",
  • "description": "string",
  • "logo_url": "string",
  • "config": {
    },
  • "style_config": {
    },
  • "limits_config": {
    },
  • "identity_config": {
    },
  • "input_schema": {
    },
  • "chat_input_field": "string",
  • "compatibility_errors": [
    ],
  • "compatibility_warnings": [
    ]
}

Create Public Workflow Export Session

Authorizations:
BearerAuth
path Parameters
public_id
required
string (Public Id)
Request Body schema: application/json
required
anonymous_id
required
string (Anonymous Id) [ 8 .. 255 ] characters
identity_token
string (Identity Token)
access_token
string (Access Token)
referrer
string (Referrer)
hcaptcha_token
string (Hcaptcha Token) <= 5000 characters
recaptcha_token
string (Recaptcha Token) <= 5000 characters

Responses

Request samples

Content type
application/json
{
  • "anonymous_id": "stringst",
  • "identity_token": "string",
  • "access_token": "string",
  • "referrer": "string",
  • "hcaptcha_token": "string",
  • "recaptcha_token": "string"
}

Response samples

Content type
application/json
{
  • "workflow_export_session_id": "711da8be-d762-4dfa-8195-70b79d3913db",
  • "session_token": "string",
  • "identity_verified": true,
  • "user_label": "string"
}

Create Public Workflow Export Conversation

Authorizations:
BearerAuth
path Parameters
public_id
required
string (Public Id)
Request Body schema: application/json
title
string (Title)

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Upload Public Workflow Export File

Authorizations:
BearerAuth
path Parameters
public_id
required
string (Public Id)
Request Body schema: multipart/form-data
required
conversation_id
required
string <uuid> (Conversation Id)
field_name
required
string (Field Name)
file
required
string <application/octet-stream> (File)

Responses

Response samples

Content type
application/json
{
  • "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"
}

Create Public Workflow Export Event

Authorizations:
BearerAuth
path Parameters
public_id
required
string (Public Id)
Request Body schema: application/json
required
workflow_export_conversation_id
string <uuid> (Workflow Export Conversation Id)
workflow_export_run_id
string <uuid> (Workflow Export Run Id)
event_type
required
string (Event Type) [ 1 .. 64 ] characters ^[a-z0-9_.:-]+$
event_name
string (Event Name) <= 128 characters ^[a-z0-9_.:-]+$
object_type
string (Object Type) <= 64 characters
object_id
string (Object Id) <= 255 characters
object_label
string (Object Label) <= 512 characters
object_url
string (Object Url) <= 2048 characters
Value Decimal (number) or Value Decimal (string) or Value Decimal (null) (Value Decimal)
object (JsonObject-Input)
page_url
string (Page Url) <= 2048 characters
client_event_id
string (Client Event Id) <= 128 characters
client_event_at
string <date-time> (Client Event At)

Responses

Request samples

Content type
application/json
{
  • "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": {
    },
  • "page_url": "string",
  • "client_event_id": "string",
  • "client_event_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "page_url": "string",
  • "client_event_id": "string",
  • "client_event_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Create Public Workflow Export Run

Authorizations:
BearerAuth
path Parameters
public_id
required
string (Public Id)
Request Body schema: application/json
required
workflow_export_session_id
required
string <uuid> (Workflow Export Session Id)
conversation_id
string <uuid> (Conversation Id)
object (JsonObject-Input)
message
string (Message)
user_timezone
string (User Timezone)

Responses

Request samples

Content type
application/json
{
  • "workflow_export_session_id": "711da8be-d762-4dfa-8195-70b79d3913db",
  • "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",
  • "inputs": {
    },
  • "message": "string",
  • "user_timezone": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Stream Public Workflow Export Run

Authorizations:
BearerAuth
path Parameters
public_id
required
string (Public Id)
workflow_export_run_id
required
string <uuid> (Workflow Export Run Id)

Responses

Response samples

Content type
application/json
null

Get Public Workflow Export Logo

Authorizations:
BearerAuth
path Parameters
public_id
required
string (Public Id)

Responses

Response samples

Content type
application/json
null

textdocs

Create Textdoc

Authorizations:
BearerAuth
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
title
string (Title) [ 1 .. 255 ] characters
Default: "Untitled"
doc_type
string (Doc Type) [ 1 .. 64 ] characters
Default: "document"
content_markdown
string (Content Markdown)
Default: ""
thread_id
string <uuid> (Thread Id)

Responses

Request samples

Content type
application/json
{
  • "title": "Untitled",
  • "doc_type": "document",
  • "content_markdown": "",
  • "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84"
}

Response samples

Content type
application/json
{
  • "textdoc_id": "f7a1f879-a5ee-4bd7-bf59-497e3aeb3b8c",
  • "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
  • "linked_upload_id": "0e42acb2-087c-4291-ab97-ae3218893c6e",
  • "linked_prompt_id": "5453a276-4e0d-492e-beb2-66eb82d3ee0a",
  • "title": "string",
  • "doc_type": "string",
  • "latest_textdoc_version_id": "74e54a2f-ca3a-4766-a2fe-fa6230ba0de7",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "latest_version": {
    }
}

List Textdocs

Authorizations:
BearerAuth
query Parameters
Search (string) or Search (null) (Search)
Cursor (string) or Cursor (null) (Cursor)
limit
integer (Limit) [ 1 .. 100 ]
Default: 25
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "next_cursor": "string"
}

Open Upload In Canvas

Authorizations:
BearerAuth
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
upload_id
required
string <uuid> (Upload Id)

Responses

Request samples

Content type
application/json
{
  • "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb"
}

Response samples

Content type
application/json
{
  • "textdoc": {
    },
  • "imported": true
}

Get Textdoc

Authorizations:
BearerAuth
path Parameters
textdoc_id
required
string <uuid> (Textdoc Id)
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)

Responses

Response samples

Content type
application/json
{
  • "textdoc_id": "f7a1f879-a5ee-4bd7-bf59-497e3aeb3b8c",
  • "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
  • "linked_upload_id": "0e42acb2-087c-4291-ab97-ae3218893c6e",
  • "linked_prompt_id": "5453a276-4e0d-492e-beb2-66eb82d3ee0a",
  • "title": "string",
  • "doc_type": "string",
  • "latest_textdoc_version_id": "74e54a2f-ca3a-4766-a2fe-fa6230ba0de7",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "latest_version": {
    }
}

List Textdoc Versions

Authorizations:
BearerAuth
path Parameters
textdoc_id
required
string <uuid> (Textdoc Id)
query Parameters
limit
integer (Limit) [ 1 .. 200 ]
Default: 50
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)

Responses

Response samples

Content type
application/json
{
  • "textdoc_id": "f7a1f879-a5ee-4bd7-bf59-497e3aeb3b8c",
  • "versions": [
    ]
}

Get Textdoc Version

Authorizations:
BearerAuth
path Parameters
textdoc_version_id
required
string <uuid> (Textdoc Version Id)
query Parameters
textdoc_id
required
string <uuid> (Textdoc Id)
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)

Responses

Response samples

Content type
application/json
{
  • "textdoc_version_id": "9cf6212f-8db6-4bb7-b97f-4ff2e8eea622",
  • "textdoc_id": "f7a1f879-a5ee-4bd7-bf59-497e3aeb3b8c",
  • "parent_textdoc_version_id": "4a7a8acc-620c-4446-b6dd-99d50c0460bd",
  • "source": "string",
  • "tool_call_id": "6786703c-7c59-49a0-b3ee-bc30b7ddc419",
  • "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
  • "content_markdown": "string",
  • "content_hash_hex": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "doc_type": "string"
}

Autosave Textdoc

Authorizations:
BearerAuth
path Parameters
textdoc_id
required
string <uuid> (Textdoc Id)
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
content_markdown
required
string (Content Markdown)

Responses

Request samples

Content type
application/json
{
  • "content_markdown": "string"
}

Response samples

Content type
application/json
{
  • "textdoc_id": "f7a1f879-a5ee-4bd7-bf59-497e3aeb3b8c",
  • "textdoc_version_id": "9cf6212f-8db6-4bb7-b97f-4ff2e8eea622",
  • "success": true
}

Restore Textdoc To New Thread

Authorizations:
BearerAuth
path Parameters
textdoc_version_id
required
string <uuid> (Textdoc Version Id)
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
source_thread_id
required
string <uuid> (Source Thread Id)
source_textdoc_id
required
string <uuid> (Source Textdoc Id)

Responses

Request samples

Content type
application/json
{
  • "source_thread_id": "b736ec5d-eb67-4368-a52e-4c5c02196509",
  • "source_textdoc_id": "06d81870-72d7-4d0f-97e3-d651a4b4240b"
}

Response samples

Content type
application/json
{
  • "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84"
}

Create Textdoc From Content

Authorizations:
BearerAuth
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
content_markdown
required
string (Content Markdown)
title
string (Title)
Default: "Untitled"
doc_type
string (Doc Type)
Default: "document"
thread_id
string <uuid> (Thread Id)
source_thread_id
string <uuid> (Source Thread Id)
linked_upload_id
string <uuid> (Linked Upload Id)
linked_prompt_id
string <uuid> (Linked Prompt Id)
generate_title
boolean (Generate Title)
Default: false

Responses

Request samples

Content type
application/json
{
  • "content_markdown": "string",
  • "title": "Untitled",
  • "doc_type": "document",
  • "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
  • "source_thread_id": "b736ec5d-eb67-4368-a52e-4c5c02196509",
  • "linked_upload_id": "0e42acb2-087c-4291-ab97-ae3218893c6e",
  • "linked_prompt_id": "5453a276-4e0d-492e-beb2-66eb82d3ee0a",
  • "generate_title": false
}

Response samples

Content type
application/json
{
  • "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
  • "textdoc": {
    },
  • "utterance": {
    },
  • "agent_action": {
    },
  • "tool_data": {
    }
}

Rename Textdoc

Authorizations:
BearerAuth
path Parameters
textdoc_id
required
string <uuid> (Textdoc Id)
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
title
required
string (Title) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "textdoc_id": "f7a1f879-a5ee-4bd7-bf59-497e3aeb3b8c",
  • "title": "string",
  • "success": true
}

Link Textdoc Upload

Authorizations:
BearerAuth
path Parameters
textdoc_id
required
string <uuid> (Textdoc Id)
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
thread_id
required
string <uuid> (Thread Id)
upload_id
required
string <uuid> (Upload Id)

Responses

Request samples

Content type
application/json
{
  • "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
  • "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb"
}

Response samples

Content type
application/json
{
  • "textdoc": {
    },
  • "success": true
}

Link Textdoc Prompt

Authorizations:
BearerAuth
path Parameters
textdoc_id
required
string <uuid> (Textdoc Id)
header Parameters
X-Redbelt-Organization-Id (string) or X-Redbelt-Organization-Id (null) (X-Redbelt-Organization-Id)
Request Body schema: application/json
required
thread_id
required
string <uuid> (Thread Id)
prompt_id
required
string <uuid> (Prompt Id)

Responses

Request samples

Content type
application/json
{
  • "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
  • "prompt_id": "24783230-27c2-455c-9de9-95bbdbb78c3d"
}

Response samples

Content type
application/json
{
  • "textdoc": {
    },
  • "success": true
}