Structify chat API
Chat session management endpoints
Structify chat API is one of 32 APIs that Structify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Chat. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 33 operations across 28 paths, and defines 165 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.
Requests are made against 2 base URLs: https://api.structify.ai, http://localhost:8080.
33 operations
28 paths
165 schemas
2 DELETE13 GET3 PATCH14 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Structify chat API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as api_key (api_key).
It accepts HTTP bearer tokens (session_token).
By default, every request must be authenticated.
Paths & Operations 33
Across 28 paths, the API surfaces 33 operations — 2 DELETE, 13 GET, 3 PATCH, 14 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
chat 33
Chat session management endpoints
POST
/chat/add_code/{chat_id}
POST
/chat/copy
Copy a chat session with its workflows and git files
POST
/chat/files/load
Load files from a chat session's git repository
POST
/chat/input-files/delete/{chat_id}
Delete input files from a chat session
GET
/chat/input-files/download-all/{chat_id}
Download all input files for a chat session as base64-encoded JSON.
GET
/chat/input-files/download/{chat_id}/{filename}
Download a single input file by chat ID and filename
GET
/chat/input-files/list/{chat_id}
List input files for a chat session
POST
/chat/input-files/upload/{chat_id}
Upload an input file to a chat session's bucket storage
GET
/chat/sessions
List all chat sessions for the authenticated user within a specific team and project.
POST
/chat/sessions
Create a new chat session with an initial message
POST
/chat/sessions/{chat_id}/admin/issue_found
Add an IssueFound tool call as an admin-only auto-review message
POST
/chat/sessions/{chat_id}/admin_override
Grant temporary admin override access for the calling admin to a chat session
GET
/chat/sessions/{chat_id}/collaborators
List all users who have access to a chat session
POST
/chat/sessions/{chat_id}/collaborators
DELETE
/chat/sessions/{chat_id}/collaborators/{user_id}
GET
/chat/sessions/{chat_id}/commits/{commit_hash}
Get a specific git commit by its hash for a chat session
GET
/chat/sessions/{chat_id}/dashboards
List dashboard specs for a chat session at a specific commit hash.
DELETE
/chat/sessions/{session_id}
Delete a chat session
GET
/chat/sessions/{session_id}
Get a chat session with all its messages
PATCH
/chat/sessions/{session_id}
GET
/chat/sessions/{session_id}/commits
List git commits for a chat session
POST
/chat/sessions/{session_id}/commits
Add a git commit to a chat session
POST
/chat/sessions/{session_id}/compress
GET
/chat/sessions/{session_id}/dependencies
Get all dependencies for a chat session
PATCH
/chat/sessions/{session_id}/favorite
PATCH
/chat/sessions/{session_id}/make-permanent
Make an ephemeral chat session permanent
POST
/chat/sessions/{session_id}/nodes/by_code_hash
POST
/chat/sessions/{session_id}/revert
Revert a chat session to a specific commit
GET
/chat/sessions/{session_id}/timeline
Get chronological timeline of messages and commits for a chat session
PUT
/chat/sessions/{session_id}/visibility
Update visibility of a chat session
GET
/chat/ws
WebSocket endpoint for chat session events
GET
/chat/{chat_session_id}/partial-chats
Get all partial chats for a chat session
POST
/chat/{chat_session_id}/simulate-prompt
Generate a one-off assistant response from an edited prompt without persisting
Schemas 165
The contract defines 165 schemas that model the data the API accepts and returns. The most detailed are ChatSessionWithEvents (26 properties), ChatSessionWithMessages (24 properties), ChatSession (23 properties), ChatMessage (16 properties). Each schema is shown below with its type and property counts.
DecodingParams
object
1 property
1 required
ChatMessageId
string
InputFilesUploadForm
object
3 properties
3 required
ToolResult
VizFigureKind
string
Verbosity
string
ChatDependency
object
A chat session dependency
2 properties
1 required
VizFigure
object
5 properties
2 required
ChatSessionWithEvents
object
26 properties
14 required
ConnectorTableResult
object
6 properties
4 required
InputFilesDeleteRequest
object
1 property
1 required
SaveMemoryInput
object
2 properties
2 required
ExitInput
object
1 property
1 required
DeleteFileInput
object
1 property
1 required
InspectStepInput
object
1 property
1 required
VizDateControlType
string
AdminIssueFoundRequest
object
2 properties
2 required
ChatSession
object
23 properties
12 required
UpdateChatSessionRequest
object
4 properties
InputFilesDeleteResponse
object
1 property
1 required
WorkflowSession
object
12 properties
5 required
RequiredEntity
object
2 properties
1 required
ChatSessionTab
string
Tab filter for chat session listing
CompressChatResponse
object
1 property
1 required
ChatInputFile
object
5 properties
5 required
DashboardSpec
object
7 properties
7 required
RequiredProperty
object
2 properties
2 required
SaveRequirement
It's an OR statement across these.
ApiExecuteInput
object
1 property
1 required
SaveApiResourceInput
object
4 properties
2 required
SaveSchemaInput
object
3 properties
1 required
BasicPropValue
ImageMeta
object
4 properties
1 required
ViewPageInput
object
1 property
1 required
InternalErrorKind
string
Categorizes the kind of internal error that occurred during LLM generation. This allows the frontend to render appropriate error messages without regex matchin…
MergeStrategy
TimelineItem
NodeSummary
object
4 properties
2 required
RequestClarificationInput
object
3 properties
2 required
VizStringControlType
string
FormatterMeta
GetGitCommitsResponse
object
Response structure for getting git commits
1 property
1 required
GetChatSessionResponse
object
Response for getting a chat session
1 property
1 required
RevertToCommitRequest
object
Request structure for reverting to a git commit
1 property
1 required
ConnectorId
string
AddDependencyInput
object
2 properties
1 required
DeleteResponse
object
Success response for delete operations
2 properties
2 required
WorkflowScheduleId
string
SpeakerTag
string
VizControlOption
object
2 properties
2 required
ChatEvent
Events in a chat session timeline, including messages and unified tool calls/results
CreateChatSessionResponse
object
Response for creating a chat session
1 property
1 required
LLMRelationship
object
4 properties
3 required
VizParam
LLMEntity
object
3 properties
3 required
WorkflowSessionId
string
CreateConnectorInput
object
4 properties
2 required
ReadNodeLogsInput
object
2 properties
1 required
TextMeta
object
1 property
1 required
SimulatePromptRequest
object
1 property
1 required
ChatEventWithRole
object
Model-layer message representation - streamlined for LLM transmission
6 properties
4 required
ChatSessionId
string
CopyChatSessionRequest
object
6 properties
3 required
ChatVisibility
string
RevertToCommitApiResponse
object
Response structure for reverting to a git commit
2 properties
2 required
ChatCollaborator
object
DTO for chat collaborator with user email information
5 properties
5 required
RunBashInput
object
3 properties
1 required
VizBooleanControl
object
2 properties
2 required
InputFilesDownloadAllResponse
object
2 properties
1 required
CodeExecutionResult
object
3 properties
3 required
ListDashboardsResponse
object
2 properties
2 required
ChatTemplateId
string
SaveInput
object
3 properties
3 required
PropertyDescriptor
object
4 properties
2 required
AddGitCommitRequest
object
Request structure for adding a git commit to a chat session
1 property
1 required
SaveColumnInput
object
3 properties
2 required
ScraperMeta
object
2 properties
2 required
RequiredRelationship
object
1 property
1 required
WorkflowSessionNodeId
string
GetGitCommitByHashResponse
object
Response structure for getting a git commit by hash
1 property
1 required
VizFigureDefinition
object
2 properties
2 required
LLMKnowledgeGraph
object
Knowledge graph info structured to deserialize and display in the same format that the LLM outputs. Also the first representation of an LLM output in the pipel…
2 properties
1 required
VizStringControl
object
3 properties
3 required
AddCollaboratorRequest
object
2 properties
2 required
RelationshipMergeProbability
object
2 properties
ToolInvocation
WebSearchInput
object
1 property
1 required
WebMeta
object
4 properties
2 required
VizDateControl
object
2 properties
2 required
GrantAdminAccessRequest
object
2 properties
2 required
DocSnippet
object
3 properties
3 required
SearchConnectorTablesInput
object
2 properties
1 required
GetDependenciesResponse
object
Response structure for getting chat dependencies
1 property
1 required
AdminGrantAccessResponse
object
Response for granting temporary admin access
2 properties
2 required
ProjectId
string
ChatSessionRole
string
Flag
object
10 properties
4 required
ChatTabCounts
object
Per-tab counts for chat session listing
6 properties
6 required
ChatSessionWithMessages
object
24 properties
13 required
VizQuery
object
2 properties
2 required
CreateChatSessionRequest
object
4 properties
1 required
LLMKey
string
LLM model keys available in the system. Format: .
MergeConfig
object
The configuration for a probabilistic merge strategy
3 properties
2 required
UpdateChatSessionFavoriteRequest
object
1 property
1 required
DecodingParamEnum
ActionDef
object
Action definition
2 properties
2 required
InputFilesUploadResponse
object
1 property
1 required
LoadFilesRequest
object
2 properties
1 required
StreamChunkEntry
object
Entry for stream chunk logging - stored as JSONB array on chatmessage
2 properties
2 required
CopyNodeOutputByCodeHashResponse
object
1 property
ConnectorColumnResult
object
3 properties
2 required
GetSessionTimelineResponse
object
Response structure for getting session timeline
1 property
1 required
ChatPrompt
object
3 properties
3 required
ImageResult
object
2 properties
1 required
MessageContent
RunPythonInput
object
4 properties
1 required
ListCollaboratorsResponse
object
Response for listing collaborators
1 property
1 required
TeamId
string
SaveTableInput
object
3 properties
1 required
PartialChatWithMetadata
object
3 properties
2 required
InfiniteScrollInput
object
UpdateVisibilityResponse
object
1 property
1 required
ChatMessage
object
16 properties
6 required
EntityId
string
ComparisonStrategy
string
MoveFileInput
object
2 properties
2 required
RunPipelineInput
object
1 property
IssueFoundInput
object
3 properties
3 required
SelectDataInput
object
1 property
1 required
ChatSessionSummary
object
15 properties
9 required
AddGitCommitResponse
object
Response structure for adding a git commit
1 property
1 required
WebNavigateOutput
string
UserId
string
VizBooleanControlType
string
DatasetDescriptor
object
A dataset is where you put multiple referential schemas. A dataset is a complete namespace where all references between schemas are held within the dataset.
5 properties
4 required
GitCommit
object
4 properties
4 required
WebNavigateInput
object
2 properties
1 required
TableDescriptor
object
The full definition of what a schema is - without duplicate information.
5 properties
3 required
PropertyType
LoadFilesResponse
object
2 properties
2 required
SaveEntitiesInput
object
3 properties
3 required
ReasoningEffort
string
VizNumberControl
object
5 properties
4 required
SimulatePromptResponse
object
1 property
1 required
CodeAddResponse
object
3 properties
3 required
PinPreviousToolInput
object
1 property
1 required
NavigateToIFrameInput
object
1 property
1 required
AdminIssueFoundResponse
object
1 property
1 required
ListChatSessionsResponse
object
Response for listing chat sessions
3 properties
3 required
ApplyPatchEdit
object
2 properties
2 required
ErrorResponse
object
Standard error response
1 property
1 required
CodeAddForm
object
1 property
1 required
PromptMeta
object
All metadata required to generate a prompt for the LLM
5 properties
4 required
RelationshipDescriptor
object
6 properties
4 required
ChatSessionConfig
object
Configuration for chat session with system prompt and LLM key
4 properties
JavascriptInput
object
1 property
1 required
GetNodeByCodeHashRequest
object
2 properties
2 required
DashboardItem
object
2 properties
2 required
SaveDatabaseInput
object
3 properties
1 required
Message
object
Our generic definition of a message to a chat agent.
2 properties
2 required
RelationshipMergeStrategy
UpdateVisibilityRequest
object
1 property
1 required
SearchConnectorTypesInput
object
1 property
VizNumberControlType
string
ApplyPatchInput
object
3 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Structify 12
Other APIs Structify publishes across the network.
Structify account API
Structify admin API
Structify chat_templates API
Structify code API
Structify connector_catalog API
Structify connectors API
Structify dataset API
Structify documents API
Structify entity API
Structify jobs API
Structify match API
Structify Nango API
#Chat
Where this information came from
This is an independent, third-party profile of Structify chat API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.