Sojo Industries Chat API
Orchestration / streaming chat
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/sojo-industries:sojo-industries-chat-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Victoria Planning Assistant Chat API
version: langgraph-production
description: HTTP surface for the Victoria (victoria-agent) planning assistant.
servers:
- url: https://victoria-agent.sojoshield.com
description: This host
- url: https://victoria-agent.sojoshield.dev
description: Staging
tags:
- name: Chat
description: Orchestration / streaming chat
paths:
/orchestrate:
post:
tags:
- Chat
summary: Run a (non-streaming) orchestration turn
description: Routes a user message + optional files through the unified LangGraph pipeline and returns a structured result.
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
message:
type: string
session_id:
type:
- string
- 'null'
files:
type: array
items:
type: object
description: 'Reference an uploaded file by exactly one of: `file_path` (preferred — the S3 key returned after uploading via Shield''s `/cloud/access-url`, e.g. `victoria/<org>/<user>/<filename>`; the server reads the bytes through Shield S3) or `data` (inline base64 fallback). The chat surface also accepts these as `file` message parts: `{type:"file", url, mediaType, filename}`.'
properties:
type:
type: string
media_type:
type: string
file_path:
type: string
description: S3 key from Shield's access-url flow; preferred reference
filename:
type: string
description: leaf filename; display name shown in the UI
data:
type: string
description: base64-encoded bytes (inline fallback path)
required:
- message
responses:
'200':
description: Orchestration result
content:
application/json:
schema:
type: object
properties:
response:
type: string
session_id:
type: string
tool_used:
type:
- string
- 'null'
metadata:
type: object
needs_input:
type: boolean
'400':
description: Message or files required
'401':
description: Missing/invalid token (when auth enabled)
'422':
description: An attached file could not be read (out-of-scope key or unreadable object) — re-upload and retry
'503':
description: Retrieval failed at the connector level (treated as infra error)
operationId: postOrchestrate
x-operation-id-source: derived
/api/chat:
post:
tags:
- Chat
summary: Streaming chat (Server-Sent Events)
description: 'SSE wrapper around orchestration, speaking the **AI SDK UI Message Stream Protocol** (`@ai-sdk/react`). The response is a `text/event-stream` of `data: {json}\n\n` frames: `data-conversation` (the very first frame, before `start` — only when chat history is enabled), `start`, `data-plan`, `data-thinking`, `text-start`/`text-delta`/`text-end`, `tool-input-available`, `tool-output-available`/`tool-output-error`, `data-artifact`, `data-final-text`, `data-cancelled`, `data-debug` (dev-only, off by default), `error`, and exactly one terminal `finish`. See `contracts/frontend-streaming-contract.md`.'
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
messages:
type: array
description: Chat history (AI SDK shape); the latest user message is used.
items:
type: object
message:
type: string
description: 'Alternative to messages: a single user message.'
runConfig:
type: object
description: AI SDK run config — the FE's native way to pass the conversation id.
properties:
sessionId:
type: string
description: 'Conversation id (the contract field). Omit (or send empty) to start a NEW conversation — the server mints a uuid and returns it on the first SSE frame (data-conversation). Precedence: runConfig.sessionId > runConfig.conversation_id (forward-compat alias for the sc-20601 rename) > server-generated.'
conversation_id:
type: string
description: Forward-compat alias of runConfig.sessionId (the future sc-20601 rename); same value. sessionId wins when both are sent.
files:
type: array
items:
type: object
description: 'Reference an uploaded file by exactly one of: `file_path` (preferred — the S3 key returned after uploading via Shield''s `/cloud/access-url`, e.g. `victoria/<org>/<user>/<filename>`; the server reads the bytes through Shield S3) or `data` (inline base64 fallback). The chat surface also accepts these as `file` message parts: `{type:"file", url, mediaType, filename}`.'
properties:
type:
type: string
media_type:
type: string
file_path:
type: string
description: S3 key from Shield's access-url flow; preferred reference
filename:
type: string
description: leaf filename; display name shown in the UI
data:
type: string
description: base64-encoded bytes (inline fallback path)
responses:
'200':
description: SSE stream (AI SDK UI Message Stream Protocol)
content:
text/event-stream:
schema:
type: string
'400':
description: No user message provided
'401':
description: Missing/invalid token (when auth enabled)
operationId: postApiChat
x-operation-id-source: derived
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Stytch session JWT. Pass as ''Authorization: Bearer <token>''.'
x-provenance:
method: harvested
publisher: Sojo Industries
source: https://victoria-agent.sojoshield.com/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)