{ "openapi": "3.1.0", "info": { "title": "Baseline Platform API", "version": "0.3.0" }, "paths": { "/health/ready": { "get": { "summary": "Ready", "operationId": "ready_health_ready_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Ready Health Ready Get" } } } } } } }, "/v1/me": { "get": { "summary": "Me", "operationId": "me_v1_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Me V1 Me Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/organizations": { "get": { "summary": "Organizations", "operationId": "organizations_v1_organizations_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "After" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Organizations V1 Organizations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "summary": "Create Organization", "operationId": "create_organization_v1_organizations_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Organization V1 Organizations Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/organizations/{organization_id}/members": { "get": { "summary": "Members", "operationId": "members_v1_organizations__organization_id__members_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Members V1 Organizations Organization Id Members Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/organizations/{organization_id}/members/{user_id}": { "put": { "summary": "Put Member", "operationId": "put_member_v1_organizations__organization_id__members__user_id__put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipPut" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Remove Member", "operationId": "remove_member_v1_organizations__organization_id__members__user_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/organizations/{organization_id}/ownership-transfer": { "post": { "summary": "Transfer", "operationId": "transfer_v1_organizations__organization_id__ownership_transfer_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnershipTransfer" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/organizations/{organization_id}/collections": { "get": { "summary": "Collections", "operationId": "collections_v1_organizations__organization_id__collections_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "After" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Collections V1 Organizations Organization Id Collections Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "summary": "Create Collection", "operationId": "create_collection_v1_organizations__organization_id__collections_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCreate" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Collection V1 Organizations Organization Id Collections Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/organizations/{organization_id}/collections/{collection_id}": { "get": { "summary": "Collection Status", "operationId": "collection_status_v1_organizations__organization_id__collections__collection_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } }, { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Collection Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Collection Status V1 Organizations Organization Id Collections Collection Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/organizations/{organization_id}/collections/{collection_id}/query": { "post": { "summary": "Query Collection", "operationId": "query_collection_v1_organizations__organization_id__collections__collection_id__query_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } }, { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Collection Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionQuery" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryEvidence" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tokens": { "post": { "summary": "Create Token", "operationId": "create_token_v1_tokens_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Token V1 Tokens Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "Tokens", "operationId": "tokens_v1_tokens_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tokens V1 Tokens Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tokens/{token_id}": { "delete": { "summary": "Revoke Token", "operationId": "revoke_token_v1_tokens__token_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "token_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Token Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/organizations/{organization_id}/collections/{collection_id}/submissions": { "post": { "summary": "Create Submission", "operationId": "create_submission_v1_organizations__organization_id__collections__collection_id__submissions_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } }, { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Collection Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/organizations/{organization_id}/collections/{collection_id}/submissions/{submission_id}": { "get": { "summary": "Submission", "operationId": "submission_v1_organizations__organization_id__collections__collection_id__submissions__submission_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } }, { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Collection Id" } }, { "name": "submission_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Submission Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/organizations/{organization_id}/collections/{collection_id}/submissions/{submission_id}/documents": { "post": { "summary": "Add Document", "operationId": "add_document_v1_organizations__organization_id__collections__collection_id__submissions__submission_id__documents_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } }, { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Collection Id" } }, { "name": "submission_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Submission Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/organizations/{organization_id}/collections/{collection_id}/submissions/{submission_id}/documents/{document_id}/content": { "put": { "summary": "Upload Document", "operationId": "upload_document_v1_organizations__organization_id__collections__collection_id__submissions__submission_id__documents__document_id__content_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } }, { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Collection Id" } }, { "name": "submission_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Submission Id" } }, { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Document Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/organizations/{organization_id}/collections/{collection_id}/submissions/{submission_id}/documents/{document_id}": { "delete": { "summary": "Remove Document", "operationId": "remove_document_v1_organizations__organization_id__collections__collection_id__submissions__submission_id__documents__document_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } }, { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Collection Id" } }, { "name": "submission_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Submission Id" } }, { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Document Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/organizations/{organization_id}/collections/{collection_id}/submissions/{submission_id}/commit": { "post": { "summary": "Commit", "operationId": "commit_v1_organizations__organization_id__collections__collection_id__submissions__submission_id__commit_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } }, { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Collection Id" } }, { "name": "submission_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Submission Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "CollectionQuery": { "properties": { "query": { "type": "string", "maxLength": 4000, "minLength": 1, "title": "Query" }, "mode": { "type": "string", "enum": [ "basic", "research", "agentic_research" ], "title": "Mode", "default": "basic" }, "effort": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "Effort", "default": "medium" }, "metadata_filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata Filters" }, "retrieval": { "$ref": "#/components/schemas/RetrievalControls" } }, "additionalProperties": false, "type": "object", "required": [ "query" ], "title": "CollectionQuery" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "MembershipPut": { "properties": { "role": { "type": "string", "enum": [ "owner", "admin", "member" ], "title": "Role" } }, "additionalProperties": false, "type": "object", "required": [ "role" ], "title": "MembershipPut" }, "OrganizationCreate": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "idempotency_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$", "title": "Idempotency Key" } }, "additionalProperties": false, "type": "object", "required": [ "name", "idempotency_key" ], "title": "OrganizationCreate" }, "OwnershipTransfer": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" } }, "additionalProperties": false, "type": "object", "required": [ "user_id" ], "title": "OwnershipTransfer" }, "PATCreate": { "properties": { "name": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Name" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "name", "expires_at" ], "title": "PATCreate" }, "PlanQuery": { "properties": { "query": { "type": "string", "maxLength": 16000, "title": "Query" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "applied_metadata_filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Applied Metadata Filters" } }, "additionalProperties": false, "type": "object", "required": [ "query" ], "title": "PlanQuery" }, "QueryEvidence": { "properties": { "request_id": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Request Id" }, "evidence": { "type": "string", "maxLength": 8388608, "title": "Evidence" }, "evidence_instructions": { "anyOf": [ { "type": "string", "maxLength": 65536 }, { "type": "null" } ], "title": "Evidence Instructions" }, "summary": { "$ref": "#/components/schemas/Summary" }, "retrieval_plan": { "anyOf": [ { "$ref": "#/components/schemas/RetrievalPlan" }, { "type": "null" } ] } }, "type": "object", "required": [ "request_id", "evidence", "summary" ], "title": "QueryEvidence" }, "RetrievalControls": { "properties": { "max_evidence": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Max Evidence", "default": 20 }, "max_evidence_tokens": { "type": "integer", "maximum": 64000.0, "minimum": 1.0, "title": "Max Evidence Tokens", "default": 16000 } }, "additionalProperties": false, "type": "object", "title": "RetrievalControls" }, "RetrievalPlan": { "properties": { "queries": { "items": { "$ref": "#/components/schemas/PlanQuery" }, "type": "array", "maxItems": 100, "title": "Queries" } }, "additionalProperties": false, "type": "object", "title": "RetrievalPlan" }, "Summary": { "properties": { "domain": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Domain" }, "mode": { "type": "string", "enum": [ "basic", "research", "agentic_research" ], "title": "Mode" }, "effort": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "Effort" }, "submitted_metadata_filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Submitted Metadata Filters" }, "applied_metadata_filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Applied Metadata Filters" }, "evidence_count": { "type": "integer", "minimum": 0.0, "title": "Evidence Count" }, "warnings": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "title": "Warnings" } }, "additionalProperties": false, "type": "object", "required": [ "domain", "mode", "effort", "evidence_count" ], "title": "Summary" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "HTTPBearer": { "type": "http", "description": "Hosted customer API access token or user PAT", "scheme": "bearer" } } } }