{ "openapi": "3.1.0", "info": { "title": "Wispir Brain", "version": "1.0.0", "description": "Source-grounded memory intelligence. Server-to-server only. 4 MB JSON / 3 MB photos. 120 requests/minute per tenant. PLAN, WEAVE and COORDINATE retain existing app functionality and are experimental." }, "servers": [ { "url": "https://api.wispir.ai" } ], "paths": { "/v1/health": { "get": { "responses": { "200": { "description": "Ready" }, "503": { "description": "Not ready" } } } }, "/v1/extraction-jobs": { "post": { "security": [ { "serviceToken": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 160 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrainRequest" } } } }, "responses": { "202": { "description": "Persisted job; poll statusUrl", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/link-jobs": { "post": { "security": [ { "serviceToken": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 160 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrainRequest" } } } }, "responses": { "202": { "description": "Persisted job; poll statusUrl", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/jobs/{id}": { "get": { "security": [ { "serviceToken": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "billing", "required": false, "schema": { "type": "string", "enum": [ "refresh" ] }, "description": "Refresh pending Gateway cost receipts without invoking a model." } ], "responses": { "200": { "description": "Tenant-scoped job status and result", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "404": { "description": "Unknown, expired, deleted, or another tenant’s job" }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/collections/{id}": { "delete": { "security": [ { "serviceToken": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tombstone collection, cancel jobs, delete results and cache" }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/collections/{id}/analysis": { "delete": { "security": [ { "serviceToken": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Invalidate all jobs and cached results; allow fresh analysis" }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/faces": { "post": { "security": [ { "serviceToken": [] } ], "parameters": [ { "in": "header", "name": "X-Photo-Consent", "required": true, "schema": { "type": "string", "enum": [ "true" ] } } ], "requestBody": { "required": true, "content": { "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "PHIM v1 face boxes, normalized 128-dimensional embeddings, modelVersion, confidence and truncation flag. Does not identify names." }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/shadow/links": { "post": { "security": [ { "serviceToken": [] } ], "description": "Optional non-authoritative Jev pair evaluation. Requires X-TypeSafe-Consent:true; disabled unless server feature flag is enabled. No persistence.", "parameters": [ { "in": "header", "name": "X-TypeSafe-Consent", "required": true, "schema": { "type": "string", "enum": [ "true" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "caseId": { "type": "string", "minLength": 1, "maxLength": 160 }, "collectionId": { "type": "string", "minLength": 1, "maxLength": 160 }, "revision": { "type": "string", "minLength": 1, "maxLength": 160 }, "typesafeConsent": { "type": "boolean", "const": true }, "a": { "type": "string", "maxLength": 10000 }, "b": { "type": "string", "maxLength": 10000 }, "baselinePrediction": { "type": "boolean" } }, "required": [ "caseId", "collectionId", "revision", "typesafeConsent", "a", "b", "baselinePrediction" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Complete, unavailable or disabled shadow result; baseline remains authoritative" }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/shadow/photo": { "post": { "security": [ { "serviceToken": [] } ], "description": "Experimental visual usability evaluation, not identity matching. Requires both provider and photo consent.", "parameters": [ { "in": "header", "name": "X-TypeSafe-Consent", "required": true, "schema": { "type": "string", "enum": [ "true" ] } }, { "in": "header", "name": "X-Photo-Consent", "required": true, "schema": { "type": "string", "enum": [ "true" ] } } ], "requestBody": { "required": true, "content": { "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "Non-authoritative complete/unavailable/disabled result" }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/stages/extract": { "post": { "security": [ { "serviceToken": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 160 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrainRequest" } } } }, "responses": { "200": { "description": "Completed stage; result contains output, model, playbookVersion, revision, sourceRevisions, usage and a billing cost receipt (unknown costs remain null)", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "202": { "description": "Already processing; poll /v1/jobs/{id}", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/stages/link": { "post": { "security": [ { "serviceToken": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 160 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrainRequest" } } } }, "responses": { "200": { "description": "Completed stage; result contains output, model, playbookVersion, revision, sourceRevisions, usage and a billing cost receipt (unknown costs remain null)", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "202": { "description": "Already processing; poll /v1/jobs/{id}", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/stages/plan": { "post": { "security": [ { "serviceToken": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 160 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrainRequest" } } } }, "responses": { "200": { "description": "Completed stage; result contains output, model, playbookVersion, revision, sourceRevisions, usage and a billing cost receipt (unknown costs remain null)", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "202": { "description": "Already processing; poll /v1/jobs/{id}", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/stages/weave": { "post": { "security": [ { "serviceToken": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 160 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrainRequest" } } } }, "responses": { "200": { "description": "Completed stage; result contains output, model, playbookVersion, revision, sourceRevisions, usage and a billing cost receipt (unknown costs remain null)", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "202": { "description": "Already processing; poll /v1/jobs/{id}", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/stages/coordinate": { "post": { "security": [ { "serviceToken": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 160 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrainRequest" } } } }, "responses": { "200": { "description": "Completed stage; result contains output, model, playbookVersion, revision, sourceRevisions, usage and a billing cost receipt (unknown costs remain null)", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "202": { "description": "Already processing; poll /v1/jobs/{id}", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } }, "/v1/stages/chat": { "post": { "security": [ { "serviceToken": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 160 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRequest" } } } }, "responses": { "200": { "description": "Completed stage; result contains output, model, playbookVersion, revision, sourceRevisions, usage and a billing cost receipt (unknown costs remain null)", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "202": { "description": "Already processing; poll /v1/jobs/{id}", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "enum": [ "queued", "running", "complete", "failed" ] }, "statusUrl": { "type": "string" }, "revision": { "type": "string" }, "result": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "401": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "403": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "409": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "410": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "413": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "429": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "500": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "502": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } }, "503": { "description": "See error code in JSON response", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } } } } } } } }, "components": { "securitySchemes": { "serviceToken": { "type": "http", "scheme": "bearer" } }, "schemas": { "BrainRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "collectionId": { "type": "string", "minLength": 1, "maxLength": 160 }, "revision": { "type": "string", "minLength": 1, "maxLength": 160 }, "sources": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "revision": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "title": { "type": "string" }, "story": { "type": "string" }, "date": { "type": "string" }, "location": { "type": "string", "maxLength": 240 }, "dateSource": { "type": "string", "enum": [ "manual", "photo-capture" ] }, "isScan": { "type": "boolean" }, "people": { "type": "string" }, "tags": { "type": "string" }, "transcript": { "default": "", "type": "string", "maxLength": 30000 }, "sensitive": { "default": false, "type": "boolean" }, "aiProviders": { "default": [], "type": "array", "items": { "type": "string", "enum": [ "anthropic", "openai", "google" ] } } }, "required": [ "id", "revision", "name", "title", "story", "date", "people", "tags" ] } }, "route": { "type": "object", "properties": { "model": { "type": "string", "pattern": "^(anthropic|openai|google)\\/[a-zA-Z0-9._:-]+$" }, "fallbacks": { "default": [], "maxItems": 2, "type": "array", "items": { "type": "string", "pattern": "^(anthropic|openai|google)\\/[a-zA-Z0-9._:-]+$" } } }, "required": [ "model" ] }, "input": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "images": { "default": [], "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "sourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "frameId": { "type": "string", "maxLength": 160 }, "base64": { "type": "string", "maxLength": 1200000 } }, "required": [ "sourceId", "frameId", "base64" ] } }, "maxOutputTokens": { "default": 6000, "type": "integer", "minimum": 256, "maximum": 16000 }, "timeoutMs": { "default": 60000, "type": "integer", "minimum": 1000, "maximum": 120000 }, "corrections": { "default": { "mustLink": [], "mustNotLink": [] }, "type": "object", "properties": { "mustLink": { "default": [], "maxItems": 200, "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } ], "items": false, "minItems": 2, "maxItems": 2 } }, "mustNotLink": { "default": [], "maxItems": 200, "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } ], "items": false, "minItems": 2, "maxItems": 2 } } } } }, "required": [ "collectionId", "revision", "sources", "route" ], "additionalProperties": false }, "ChatRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "collectionId": { "type": "string", "minLength": 1, "maxLength": 160 }, "revision": { "type": "string", "minLength": 1, "maxLength": 160 }, "sources": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "revision": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "title": { "type": "string" }, "story": { "type": "string" }, "date": { "type": "string" }, "location": { "type": "string", "maxLength": 240 }, "dateSource": { "type": "string", "enum": [ "manual", "photo-capture" ] }, "isScan": { "type": "boolean" }, "people": { "type": "string" }, "tags": { "type": "string" }, "transcript": { "default": "", "type": "string", "maxLength": 30000 }, "sensitive": { "default": false, "type": "boolean" }, "aiProviders": { "default": [], "type": "array", "items": { "type": "string", "enum": [ "anthropic", "openai", "google" ] } } }, "required": [ "id", "revision", "name", "title", "story", "date", "people", "tags" ] } }, "route": { "type": "object", "properties": { "model": { "type": "string", "pattern": "^(anthropic|openai|google)\\/[a-zA-Z0-9._:-]+$" }, "fallbacks": { "default": [], "maxItems": 2, "type": "array", "items": { "type": "string", "pattern": "^(anthropic|openai|google)\\/[a-zA-Z0-9._:-]+$" } } }, "required": [ "model" ] }, "input": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "images": { "default": [], "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "sourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "frameId": { "type": "string", "maxLength": 160 }, "base64": { "type": "string", "maxLength": 1200000 } }, "required": [ "sourceId", "frameId", "base64" ] } }, "maxOutputTokens": { "default": 6000, "type": "integer", "minimum": 256, "maximum": 16000 }, "timeoutMs": { "default": 60000, "type": "integer", "minimum": 1000, "maximum": 120000 }, "corrections": { "default": { "mustLink": [], "mustNotLink": [] }, "type": "object", "properties": { "mustLink": { "default": [], "maxItems": 200, "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } ], "items": false, "minItems": 2, "maxItems": 2 } }, "mustNotLink": { "default": [], "maxItems": 200, "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } ], "items": false, "minItems": 2, "maxItems": 2 } } } } }, "required": [ "collectionId", "revision", "sources", "route" ], "additionalProperties": false }, "ExtractOutput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "people": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "places": { "type": "array", "items": { "type": "string" } }, "events": { "default": [], "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "editionHint": { "type": [ "string", "null" ] } }, "required": [ "label" ], "additionalProperties": false } }, "time": { "default": { "year": null, "source": "none", "confidence": 0 }, "type": "object", "properties": { "year": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "yearRange": { "anyOf": [ { "minItems": 2, "maxItems": 2, "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, { "type": "null" } ] }, "source": { "type": "string", "enum": [ "exif", "text", "relative", "contributor", "none" ] }, "confidence": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "year", "source", "confidence" ], "additionalProperties": false }, "summary": { "type": "string" }, "sensitive": { "type": "boolean" }, "offTopic": { "default": false, "type": "boolean" }, "quotes": { "maxItems": 3, "type": "array", "items": { "type": "string" } } }, "required": [ "id", "people", "places", "events", "time", "summary", "sensitive", "offTopic", "quotes" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "LinkOutput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "clusters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "default": "Shared moment", "type": "string" }, "year": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "sourceIds": { "minItems": 2, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "evidence": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "confidence": { "type": "number", "minimum": 0.6, "maximum": 1 }, "rationale": { "type": "string" } }, "required": [ "id", "label", "sourceIds", "evidence", "confidence" ], "additionalProperties": false } }, "unlinked": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "duplicates": { "default": [], "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } ], "items": false, "minItems": 2, "maxItems": 2 } }, "sensitiveSourceIds": { "default": [], "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "offTopicSourceIds": { "default": [], "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "clusters", "unlinked", "duplicates", "sensitiveSourceIds", "offTopicSourceIds" ], "additionalProperties": false }, "PlanOutput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "chapters": { "minItems": 1, "maxItems": 30, "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "sourceIds": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "title", "sourceIds" ], "additionalProperties": false } } }, "required": [ "chapters" ], "additionalProperties": false }, "WeaveOutput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "chapters": { "minItems": 1, "maxItems": 30, "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "bridge": { "type": "string", "maxLength": 6000 }, "sourceIds": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "quotes": { "type": "array", "items": { "type": "object", "properties": { "sourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "text": { "type": "string", "maxLength": 20000 } }, "required": [ "sourceId", "text" ], "additionalProperties": false } } }, "required": [ "title", "bridge", "sourceIds", "quotes" ], "additionalProperties": false } } }, "required": [ "title", "chapters" ], "additionalProperties": false }, "CoordinateOutput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "summary": { "type": "string", "minLength": 1, "maxLength": 6000 }, "timeline": { "maxItems": 60, "type": "array", "items": { "type": "object", "properties": { "date": { "type": [ "string", "null" ] }, "title": { "type": "string", "minLength": 1, "maxLength": 160 }, "description": { "type": "string", "minLength": 1, "maxLength": 3000 }, "sourceIds": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "date", "title", "description", "sourceIds" ], "additionalProperties": false } }, "themes": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "type": "string", "minLength": 1, "maxLength": 2000 }, "sourceIds": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "title", "description", "sourceIds" ], "additionalProperties": false } }, "questions": { "maxItems": 12, "type": "array", "items": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 500 }, "sourceIds": { "maxItems": 10, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "body", "sourceIds" ], "additionalProperties": false } } }, "required": [ "title", "summary", "timeline", "themes", "questions" ], "additionalProperties": false } } } }