{ "openapi": "3.1.1", "info": { "title": "Condens API", "version": "1.0.4" }, "servers": [ { "url": "https://api.condens.io", "description": "For accounts with EU server location. If you’re unsure which server your account uses, check the API & MCP-Server settings page in Condens to view the assigned base URL." }, { "url": "https://api-us.condens.io", "description": "For accounts with US server location. If you’re unsure which server your account uses, check the API & MCP-Server settings page in Condens to view the assigned base URL." } ], "paths": { "/v1/workspaces": { "get": { "summary": "List workspaces", "operationId": "getWorkspaces", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/sort" } ], "responses": { "200": { "description": "Workspaces page", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Pagination" }, { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Workspace" } } } } ] } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/workspaces/{id}": { "get": { "summary": "Get a workspace", "operationId": "getWorkspaceById", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "description": "Workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workspace" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/users": { "get": { "summary": "List users", "operationId": "getUsers", "parameters": [ { "$ref": "#/components/parameters/workspaceId" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/sort" } ], "responses": { "200": { "description": "Users page", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Pagination" }, { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserListItem" } } } } ] } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/users/{id}": { "get": { "summary": "Get a user", "operationId": "getUserById", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "description": "User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserItem" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/participants": { "get": { "summary": "List participants", "operationId": "getParticipants", "parameters": [ { "$ref": "#/components/parameters/workspaceId" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/sort" } ], "responses": { "200": { "description": "Participants page", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Pagination" }, { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ParticipantListItem" } } } } ] } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } }, "post": { "summary": "Create a participant", "operationId": "createParticipant", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateParticipant" } } } }, "responses": { "201": { "description": "Created participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParticipantItem" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/participants/{id}": { "get": { "summary": "Get a participant", "operationId": "getParticipantById", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "description": "Participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParticipantItem" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } }, "patch": { "summary": "Update a participant", "operationId": "updateParticipant", "parameters": [ { "$ref": "#/components/parameters/id" } ], "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateParticipant" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateParticipant" } } } }, "responses": { "200": { "description": "Updated participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParticipantItem" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } }, "delete": { "summary": "Delete a Participant", "description": "Deleted items can be restored from the trash in the Condens app for up to 30 days.", "operationId": "deleteParticipant", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "204": { "description": "Deleted" }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/projects": { "get": { "summary": "List projects", "operationId": "getProjects", "parameters": [ { "$ref": "#/components/parameters/projectFolderId" }, { "$ref": "#/components/parameters/workspaceId" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/sort" } ], "responses": { "200": { "description": "Projects page", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Pagination" }, { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectListItem" } } } } ] } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } }, "post": { "summary": "Create a project", "operationId": "createProject", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProject" } } } }, "responses": { "201": { "description": "Created project", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectItem" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/projects/{id}": { "get": { "summary": "Get a project", "operationId": "getProjectById", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "description": "Project", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectItem" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } }, "patch": { "summary": "Update a project", "operationId": "updateProject", "parameters": [ { "$ref": "#/components/parameters/id" } ], "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProject" } } } }, "responses": { "200": { "description": "Updated project", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectItem" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } }, "delete": { "summary": "Delete a project", "description": "Deleted items can be restored from the trash in the Condens app for up to 30 days.", "operationId": "deleteProject", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "204": { "description": "Deleted" }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/projectFolders": { "get": { "summary": "List project folders", "operationId": "getProjectFolders", "parameters": [ { "$ref": "#/components/parameters/workspaceId" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/sort" } ], "responses": { "200": { "description": "Project folders page", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Pagination" }, { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectFolder" } } } } ] } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } }, "post": { "summary": "Create a project folder", "operationId": "createProjectFolder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectFolder" } } } }, "responses": { "201": { "description": "Created project folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectFolder" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/projectFolders/{id}": { "get": { "summary": "Get a project folder", "operationId": "getProjectFolderById", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "description": "Project folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectFolder" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } }, "patch": { "summary": "Update a project folder", "operationId": "updateProjectFolder", "parameters": [ { "$ref": "#/components/parameters/id" } ], "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateProjectFolder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectFolder" } } } }, "responses": { "200": { "description": "Updated project folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectFolder" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } }, "delete": { "summary": "Delete a project folder", "description": "Deleted items can be restored from the trash in the Condens app for up to 30 days.", "operationId": "deleteProjectFolder", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "204": { "description": "Deleted" }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/sessions": { "get": { "summary": "List sessions", "operationId": "getSessions", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/workspaceId" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/sort" } ], "responses": { "200": { "description": "Sessions page", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Pagination" }, { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SessionListItem" } } } } ] } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } }, "post": { "summary": "Create a session", "operationId": "createSession", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSession" } } } }, "responses": { "201": { "description": "Created session", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionItem" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/sessions/{id}": { "get": { "summary": "Get a session", "operationId": "getSessionById", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "description": "Session", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionItem" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } }, "patch": { "summary": "Update a session", "operationId": "updateSession", "parameters": [ { "$ref": "#/components/parameters/id" } ], "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateSession" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSession" } } } }, "responses": { "200": { "description": "Updated session", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionItem" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } }, "delete": { "summary": "Delete a Session", "description": "Deleted items can be restored from the trash in the Condens app for up to 30 days.", "operationId": "deleteSession", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "204": { "description": "Deleted" }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/artifacts": { "get": { "summary": "List artifacts", "operationId": "getArtifacts", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/workspaceId" }, { "$ref": "#/components/parameters/artifactType" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/sort" } ], "responses": { "200": { "description": "Artifacts page", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Pagination" }, { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ArtifactListItem" } } } } ] } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } }, "/v1/artifacts/{id}": { "patch": { "summary": "Update an artifact", "description": "Update values of existing information fields for this artifact's type. Field names are matched ignoring case and surrounding whitespace. Unknown fields and mismatched field types return 400. Fields omitted from the request remain unchanged. This endpoint does not create field definitions or update artifact content.", "operationId": "updateArtifact", "parameters": [ { "$ref": "#/components/parameters/id" } ], "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateArtifact" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateArtifact" } } } }, "responses": { "200": { "description": "Updated artifact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactListItem" } } } }, "400": { "$ref": "#/components/responses/Error400" }, "403": { "$ref": "#/components/responses/Error403" }, "404": { "$ref": "#/components/responses/Error404" }, "429": { "$ref": "#/components/responses/Error429" }, "500": { "$ref": "#/components/responses/Error500" } } } } }, "components": { "parameters": { "id": { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, "workspaceId": { "name": "workspaceId", "in": "query", "schema": { "type": "string" } }, "projectFolderId": { "name": "projectFolderId", "in": "query", "schema": { "type": "string" } }, "projectId": { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string" } }, "artifactType": { "name": "type", "in": "query", "required": false, "description": "Optionally filter artifacts by type.", "schema": { "type": "string", "minLength": 1 } }, "page": { "name": "page", "in": "query", "schema": { "$ref": "#/components/schemas/Page" } }, "pageSize": { "name": "pageSize", "in": "query", "schema": { "$ref": "#/components/schemas/PageSize" } }, "filter": { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "description": "JSON-encoded filter object" } }, "sort": { "name": "sort", "in": "query", "schema": { "type": "string", "description": "Sort order: prefix with '-' for descending, omit for ascending.", "default": "name" }, "description": "Sort items by name or information field value." } }, "schemas": { "Page": { "type": "integer", "minimum": 1, "default": 1, "description": "Page number (starting at 1)." }, "PageSize": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100, "description": "Number of items per page." }, "Pagination": { "type": "object", "required": [ "page", "pageSize", "total", "totalPages", "hasNext" ], "properties": { "page": { "$ref": "#/components/schemas/Page" }, "pageSize": { "$ref": "#/components/schemas/PageSize" }, "total": { "type": "integer", "minimum": 0 }, "totalPages": { "type": "integer", "minimum": 0 }, "hasNext": { "type": "boolean" } } }, "UpdatedAt": { "type": "string", "format": "date-time", "description": "ISO-8601 timestamp of last update", "readOnly": true }, "Workspace": { "type": "object", "required": [ "id", "name", "updatedAt" ], "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/UpdatedAt" } }, "additionalProperties": false }, "UserRole": { "type": "string", "enum": [ "administrator", "non_research_administrator", "contributor", "limited_access_contributor", "full_access_viewer", "viewer" ] }, "UserListItem": { "type": "object", "required": [ "id", "name", "email", "role", "active", "updatedAt" ], "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "role": { "$ref": "#/components/schemas/UserRole" }, "active": { "type": "boolean" }, "updatedAt": { "$ref": "#/components/schemas/UpdatedAt" } }, "additionalProperties": false }, "UserItem": { "type": "object", "required": [ "id", "name", "email", "role", "workspaceIds", "active", "updatedAt" ], "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "role": { "$ref": "#/components/schemas/UserRole" }, "workspaceIds": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "updatedAt": { "$ref": "#/components/schemas/UpdatedAt" } }, "additionalProperties": false }, "ProjectFolder": { "type": "object", "required": [ "id", "workspaceId", "name", "updatedAt" ], "properties": { "id": { "type": "string", "readOnly": true }, "workspaceId": { "type": "string" }, "name": { "type": "string", "default": "" }, "updatedAt": { "$ref": "#/components/schemas/UpdatedAt" } }, "additionalProperties": false }, "CreateProjectFolder": { "type": "object", "required": [ "name" ], "properties": { "workspaceId": { "type": "string" }, "name": { "type": "string", "default": "" } }, "additionalProperties": false }, "UpdateProjectFolder": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false }, "ProjectListItem": { "type": "object", "required": [ "id", "name", "projectFolderId", "workspaceId", "informationFields", "updatedAt" ], "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "default": "" }, "projectFolderId": { "type": "string" }, "workspaceId": { "type": "string" }, "informationFields": { "$ref": "#/components/schemas/InformationFields" }, "updatedAt": { "$ref": "#/components/schemas/UpdatedAt" } }, "additionalProperties": false }, "ProjectItem": { "type": "object", "required": [ "id", "name", "projectFolderId", "workspaceId", "involvedContributorIds", "informationFields", "updatedAt" ], "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "default": "" }, "projectFolderId": { "type": [ "string", "null" ] }, "workspaceId": { "type": "string" }, "involvedContributorIds": { "type": "array", "items": { "type": "string" }, "default": [] }, "informationFields": { "$ref": "#/components/schemas/InformationFields" }, "updatedAt": { "$ref": "#/components/schemas/UpdatedAt" } }, "additionalProperties": false }, "CreateProject": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "default": "" }, "projectFolderId": { "type": "string" }, "workspaceId": { "type": "string" }, "involvedContributorIds": { "type": "array", "items": { "type": "string" }, "default": [] }, "informationFields": { "$ref": "#/components/schemas/InformationFields" } }, "additionalProperties": false }, "UpdateProject": { "type": "object", "properties": { "name": { "type": "string" }, "projectFolderId": { "type": "string" }, "involvedContributorIds": { "type": "array", "items": { "type": "string" } }, "informationFields": { "$ref": "#/components/schemas/InformationFields" } }, "additionalProperties": false }, "SessionListItem": { "type": "object", "required": [ "id", "name", "projectId", "workspaceId", "processed", "informationFields", "updatedAt" ], "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "default": "" }, "projectId": { "type": "string" }, "workspaceId": { "type": "string" }, "processed": { "type": "boolean" }, "informationFields": { "$ref": "#/components/schemas/InformationFields" }, "updatedAt": { "$ref": "#/components/schemas/UpdatedAt" } }, "additionalProperties": false }, "ArtifactListItem": { "type": "object", "required": [ "id", "name", "coverImageUrl", "projectId", "workspaceId", "summary", "isPublished", "type", "informationFields", "updatedAt" ], "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "default": "" }, "coverImageUrl": { "type": [ "string", "null" ], "format": "uri" }, "projectId": { "type": "string" }, "workspaceId": { "type": "string" }, "summary": { "type": "string", "default": "" }, "isPublished": { "type": "boolean" }, "type": { "type": "string" }, "informationFields": { "$ref": "#/components/schemas/InformationFields" }, "updatedAt": { "$ref": "#/components/schemas/UpdatedAt" } }, "additionalProperties": false }, "UpdateArtifact": { "type": "object", "required": [ "informationFields" ], "properties": { "informationFields": { "$ref": "#/components/schemas/InformationFields" } }, "additionalProperties": false }, "SessionItem": { "type": "object", "required": [ "id", "name", "projectId", "workspaceId", "processed", "informationFields", "attachments", "updatedAt" ], "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "default": "" }, "projectId": { "type": "string" }, "workspaceId": { "type": "string" }, "processed": { "type": "boolean" }, "informationFields": { "$ref": "#/components/schemas/InformationFields" }, "attachments": { "$ref": "#/components/schemas/Attachments" }, "updatedAt": { "$ref": "#/components/schemas/UpdatedAt" }, "failedUploadUrls": { "$ref": "#/components/schemas/FailedUploadUrls" } }, "additionalProperties": false }, "SessionMedia": { "type": "object", "required": [ "sourceUrl" ], "properties": { "name": { "type": "string" }, "sourceUrl": { "$ref": "#/components/schemas/SourceUrl" }, "sourceAuth": { "$ref": "#/components/schemas/SourceAuth" }, "transcription": { "type": "object", "required": [ "languages" ], "properties": { "languages": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageCode" }, "description": "When setting multiple languages for transcription, please refer the transcription settings in Condens to learn which languages support them.", "minItems": 1, "maxItems": 10 }, "numberOfSpeakers": { "type": "integer", "minimum": 1, "maximum": 25, "default": 2, "description": "If unspecified, number of speakers will be automatically detected." }, "generateBookmarks": { "type": "boolean", "default": false } }, "additionalProperties": false }, "anonymization": { "type": "object", "properties": { "blurMode": { "type": "string", "enum": [ "faces", "names", "faces_and_names", "video" ], "default": "video" }, "anonymizeAudio": { "type": "boolean", "default": false } }, "minProperties": 1, "additionalProperties": false } }, "additionalProperties": false }, "SessionNote": { "type": "object", "required": [ "content" ], "properties": { "name": { "type": "string" }, "content": { "type": "string" }, "type": { "type": "string", "enum": [ "plain", "markdown", "html" ], "default": "plain" } }, "additionalProperties": false }, "CreateSession": { "type": "object", "required": [ "name", "projectId" ], "properties": { "name": { "type": "string", "default": "" }, "projectId": { "type": "string" }, "informationFields": { "$ref": "#/components/schemas/InformationFields" }, "media": { "$ref": "#/components/schemas/SessionMedia" }, "note": { "$ref": "#/components/schemas/SessionNote" }, "attachments": { "$ref": "#/components/schemas/UploadAttachments" } }, "additionalProperties": false }, "UpdateSession": { "type": "object", "properties": { "name": { "type": "string" }, "informationFields": { "$ref": "#/components/schemas/InformationFields" }, "media": { "$ref": "#/components/schemas/SessionMedia" }, "note": { "$ref": "#/components/schemas/SessionNote" }, "attachments": { "$ref": "#/components/schemas/UploadAttachments" } }, "additionalProperties": false }, "ParticipantListItem": { "type": "object", "required": [ "id", "name", "workspaceId", "updatedAt" ], "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "default": "" }, "workspaceId": { "type": "string" }, "informationFields": { "$ref": "#/components/schemas/InformationFields" }, "updatedAt": { "$ref": "#/components/schemas/UpdatedAt" } }, "additionalProperties": false }, "ParticipantItem": { "type": "object", "required": [ "id", "name", "workspaceId", "informationFields", "attachments", "updatedAt" ], "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "default": "" }, "workspaceId": { "type": "string" }, "informationFields": { "$ref": "#/components/schemas/InformationFields" }, "attachments": { "$ref": "#/components/schemas/Attachments" }, "updatedAt": { "$ref": "#/components/schemas/UpdatedAt" }, "failedUploadUrls": { "$ref": "#/components/schemas/FailedUploadUrls" } }, "additionalProperties": false }, "CreateParticipant": { "type": "object", "required": [ "name" ], "properties": { "workspaceId": { "type": "string" }, "name": { "type": "string", "default": "" }, "informationFields": { "$ref": "#/components/schemas/InformationFields" }, "attachments": { "$ref": "#/components/schemas/UploadAttachments" } }, "additionalProperties": false }, "UpdateParticipant": { "type": "object", "properties": { "name": { "type": "string" }, "informationFields": { "$ref": "#/components/schemas/InformationFields" }, "attachments": { "$ref": "#/components/schemas/UploadAttachments" } }, "additionalProperties": false }, "TextInformationField": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "text" ] }, "value": { "type": "string" } }, "required": [ "fieldName", "fieldType", "value" ], "additionalProperties": false }, "NumberInformationField": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "number" ] }, "value": { "type": "integer" } }, "required": [ "fieldName", "fieldType", "value" ], "additionalProperties": false }, "DateInformationField": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "date" ] }, "value": { "type": "string", "format": "date" } }, "required": [ "fieldName", "fieldType", "value" ], "additionalProperties": false }, "CheckboxInformationField": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "checkbox" ] }, "value": { "type": "boolean" } }, "required": [ "fieldName", "fieldType", "value" ], "additionalProperties": false }, "SingleSelectInformationField": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "single_select" ] }, "value": { "type": "string" } }, "required": [ "fieldName", "fieldType", "value" ], "additionalProperties": false }, "MultiSelectInformationField": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "multi_select" ] }, "value": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } }, "required": [ "fieldName", "fieldType", "value" ], "additionalProperties": false }, "ParticipantsInformationField": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "participant" ] }, "value": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "anyOf": [ { "required": [ "id" ] }, { "required": [ "name" ] } ], "additionalProperties": false } } }, "required": [ "fieldName", "fieldType", "value" ], "additionalProperties": false }, "UserInformationField": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "user" ] }, "value": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } }, "anyOf": [ { "required": [ "id" ] }, { "required": [ "email" ] }, { "required": [ "name" ] } ], "additionalProperties": false } } }, "required": [ "fieldName", "fieldType", "value" ], "additionalProperties": false }, "UrlInformationField": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "url" ] }, "value": { "type": "string", "format": "uri" } }, "required": [ "fieldName", "fieldType", "value" ], "additionalProperties": false }, "EmailInformationField": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "email" ] }, "value": { "type": "string", "format": "email" } }, "required": [ "fieldName", "fieldType", "value" ], "additionalProperties": false }, "NpsInformationField": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "nps" ] }, "value": { "type": "integer", "minimum": 0, "maximum": 10 } }, "required": [ "fieldName", "fieldType", "value" ], "additionalProperties": false }, "InformationField": { "oneOf": [ { "$ref": "#/components/schemas/TextInformationField" }, { "$ref": "#/components/schemas/NumberInformationField" }, { "$ref": "#/components/schemas/DateInformationField" }, { "$ref": "#/components/schemas/CheckboxInformationField" }, { "$ref": "#/components/schemas/SingleSelectInformationField" }, { "$ref": "#/components/schemas/MultiSelectInformationField" }, { "$ref": "#/components/schemas/ParticipantsInformationField" }, { "$ref": "#/components/schemas/UserInformationField" }, { "$ref": "#/components/schemas/UrlInformationField" }, { "$ref": "#/components/schemas/EmailInformationField" }, { "$ref": "#/components/schemas/NpsInformationField" } ], "discriminator": { "propertyName": "fieldType", "mapping": { "text": "#/components/schemas/TextInformationField", "number": "#/components/schemas/NumberInformationField", "date": "#/components/schemas/DateInformationField", "checkbox": "#/components/schemas/CheckboxInformationField", "single_select": "#/components/schemas/SingleSelectInformationField", "multi_select": "#/components/schemas/MultiSelectInformationField", "participant": "#/components/schemas/ParticipantsInformationField", "user": "#/components/schemas/UserInformationField", "url": "#/components/schemas/UrlInformationField", "email": "#/components/schemas/EmailInformationField", "nps": "#/components/schemas/NpsInformationField" } } }, "InformationFields": { "type": "array", "items": { "$ref": "#/components/schemas/InformationField" } }, "LanguageCode": { "description": "BCP-47 language/locale code for transcription.", "oneOf": [ { "type": "string", "enum": [ "af-ZA" ], "title": "Afrikaans" }, { "type": "string", "enum": [ "sq-AL" ], "title": "Albanian" }, { "type": "string", "enum": [ "am-ET" ], "title": "Amharic" }, { "type": "string", "enum": [ "ar-EG" ], "title": "Arabic (Egypt)" }, { "type": "string", "enum": [ "ar-MA" ], "title": "Arabic (Morocco)" }, { "type": "string", "enum": [ "ar-SA" ], "title": "Arabic (Saudi Arabia)" }, { "type": "string", "enum": [ "hy-AM" ], "title": "Armenian" }, { "type": "string", "enum": [ "az-AZ" ], "title": "Azerbaijani" }, { "type": "string", "enum": [ "eu-ES" ], "title": "Basque" }, { "type": "string", "enum": [ "bn-IN" ], "title": "Bengali" }, { "type": "string", "enum": [ "bs-BA" ], "title": "Bosnian" }, { "type": "string", "enum": [ "bg-BG" ], "title": "Bulgarian" }, { "type": "string", "enum": [ "my-MM" ], "title": "Burmese" }, { "type": "string", "enum": [ "ca-ES" ], "title": "Catalan" }, { "type": "string", "enum": [ "zh-CN" ], "title": "Chinese (Mandarin, Simplified)" }, { "type": "string", "enum": [ "zh-HK" ], "title": "Chinese (Cantonese, Traditional)" }, { "type": "string", "enum": [ "zh-TW" ], "title": "Chinese (Mandarin, Traditional)" }, { "type": "string", "enum": [ "yue-CN" ], "title": "Chinese (Cantonese, Simplified)" }, { "type": "string", "enum": [ "hr-HR" ], "title": "Croatian" }, { "type": "string", "enum": [ "cs-CZ" ], "title": "Czech" }, { "type": "string", "enum": [ "da-DK" ], "title": "Danish" }, { "type": "string", "enum": [ "nl-NL" ], "title": "Dutch" }, { "type": "string", "enum": [ "nl-BE" ], "title": "Dutch (Belgium)" }, { "type": "string", "enum": [ "en-US" ], "title": "English (US)" }, { "type": "string", "enum": [ "en-GB" ], "title": "English (United Kingdom)" }, { "type": "string", "enum": [ "en-AU" ], "title": "English (Oceania)" }, { "type": "string", "enum": [ "en-IN" ], "title": "English (India)" }, { "type": "string", "enum": [ "en-NG" ], "title": "English (West Africa)" }, { "type": "string", "enum": [ "en-KE" ], "title": "English (East Africa)" }, { "type": "string", "enum": [ "en-ZA" ], "title": "English (South Africa)" }, { "type": "string", "enum": [ "et-EE" ], "title": "Estonian" }, { "type": "string", "enum": [ "fil-PH" ], "title": "Filipino" }, { "type": "string", "enum": [ "fi-FI" ], "title": "Finnish" }, { "type": "string", "enum": [ "fr-FR" ], "title": "French" }, { "type": "string", "enum": [ "fr-BE" ], "title": "French (Belgium)" }, { "type": "string", "enum": [ "fr-CA" ], "title": "French (Canada)" }, { "type": "string", "enum": [ "gl-ES" ], "title": "Galician" }, { "type": "string", "enum": [ "ka-GE" ], "title": "Georgian" }, { "type": "string", "enum": [ "de-DE" ], "title": "German" }, { "type": "string", "enum": [ "de-AT" ], "title": "German (Austria)" }, { "type": "string", "enum": [ "de-CH" ], "title": "German (Switzerland)" }, { "type": "string", "enum": [ "el-GR" ], "title": "Greek" }, { "type": "string", "enum": [ "gu-IN" ], "title": "Gujarati" }, { "type": "string", "enum": [ "he-IL" ], "title": "Hebrew" }, { "type": "string", "enum": [ "hi-IN" ], "title": "Hindi" }, { "type": "string", "enum": [ "hu-HU" ], "title": "Hungarian" }, { "type": "string", "enum": [ "is-IS" ], "title": "Icelandic" }, { "type": "string", "enum": [ "id-ID" ], "title": "Indonesian" }, { "type": "string", "enum": [ "ga-IE" ], "title": "Irish" }, { "type": "string", "enum": [ "it-IT" ], "title": "Italian" }, { "type": "string", "enum": [ "ja-JP" ], "title": "Japanese" }, { "type": "string", "enum": [ "jv-ID" ], "title": "Javanese" }, { "type": "string", "enum": [ "kn-IN" ], "title": "Kannada" }, { "type": "string", "enum": [ "kk-KZ" ], "title": "Kazakh" }, { "type": "string", "enum": [ "km-KH" ], "title": "Khmer" }, { "type": "string", "enum": [ "ko-KR" ], "title": "Korean" }, { "type": "string", "enum": [ "lo-LA" ], "title": "Lao" }, { "type": "string", "enum": [ "lv-LV" ], "title": "Latvian" }, { "type": "string", "enum": [ "lt-LT" ], "title": "Lithuanian" }, { "type": "string", "enum": [ "mk-MK" ], "title": "Macedonian" }, { "type": "string", "enum": [ "ms-MY" ], "title": "Malay" }, { "type": "string", "enum": [ "ml-IN" ], "title": "Malayalam" }, { "type": "string", "enum": [ "mt-MT" ], "title": "Maltese" }, { "type": "string", "enum": [ "mr-IN" ], "title": "Marathi" }, { "type": "string", "enum": [ "mn-MN" ], "title": "Mongolian" }, { "type": "string", "enum": [ "ne-NP" ], "title": "Nepali" }, { "type": "string", "enum": [ "nb-NO" ], "title": "Norwegian" }, { "type": "string", "enum": [ "ps-AF" ], "title": "Pashto" }, { "type": "string", "enum": [ "fa-IR" ], "title": "Persian" }, { "type": "string", "enum": [ "pl-PL" ], "title": "Polish" }, { "type": "string", "enum": [ "pt-BR" ], "title": "Portuguese (Brazil)" }, { "type": "string", "enum": [ "pt-PT" ], "title": "Portuguese (Portugal)" }, { "type": "string", "enum": [ "pa-IN" ], "title": "Punjabi" }, { "type": "string", "enum": [ "ro-RO" ], "title": "Romanian" }, { "type": "string", "enum": [ "ru-RU" ], "title": "Russian" }, { "type": "string", "enum": [ "sr-RS" ], "title": "Serbian" }, { "type": "string", "enum": [ "si-LK" ], "title": "Sinhala" }, { "type": "string", "enum": [ "sk-SK" ], "title": "Slovak" }, { "type": "string", "enum": [ "sl-SI" ], "title": "Slovenian" }, { "type": "string", "enum": [ "so-SO" ], "title": "Somali" }, { "type": "string", "enum": [ "es-MX" ], "title": "Spanish (Latin America)" }, { "type": "string", "enum": [ "es-ES" ], "title": "Spanish (Spain)" }, { "type": "string", "enum": [ "sw-KE" ], "title": "Swahili" }, { "type": "string", "enum": [ "sv-SE" ], "title": "Swedish" }, { "type": "string", "enum": [ "ta-IN" ], "title": "Tamil" }, { "type": "string", "enum": [ "te-IN" ], "title": "Telugu" }, { "type": "string", "enum": [ "th-TH" ], "title": "Thai" }, { "type": "string", "enum": [ "tr-TR" ], "title": "Turkish" }, { "type": "string", "enum": [ "uk-UA" ], "title": "Ukrainian" }, { "type": "string", "enum": [ "ur-IN" ], "title": "Urdu" }, { "type": "string", "enum": [ "uz-UZ" ], "title": "Uzbek" }, { "type": "string", "enum": [ "vi-VN" ], "title": "Vietnamese" }, { "type": "string", "enum": [ "cy-GB" ], "title": "Welsh" }, { "type": "string", "enum": [ "zu-ZA" ], "title": "Zulu" } ] }, "SourceUrl": { "type": "string", "format": "uri", "description": "URL of the source to be fetched. Must be accessible from the internet." }, "SourceAuth": { "oneOf": [ { "title": "Bearer", "type": "object", "required": [ "type", "token" ], "properties": { "type": { "type": "string", "enum": [ "bearer" ] }, "token": { "type": "string", "description": "Bearer token to be sent as 'Authorization: Bearer '" } }, "additionalProperties": false }, { "title": "API Key", "type": "object", "required": [ "type", "key" ], "properties": { "type": { "type": "string", "enum": [ "apiKey" ] }, "key": { "type": "string", "description": "API key to be sent as 'x-api-key: '" } }, "additionalProperties": false } ] }, "Attachments": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } }, "additionalProperties": false } }, "FailedUploadUrls": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "URLs of files that failed to upload. Only present if one or more uploads failed." }, "UploadAttachments": { "type": "array", "items": { "type": "object", "required": [ "sourceUrl" ], "properties": { "sourceUrl": { "$ref": "#/components/schemas/SourceUrl" }, "sourceAuth": { "$ref": "#/components/schemas/SourceAuth" }, "name": { "type": "string" } }, "additionalProperties": false } }, "Error": { "type": "object", "required": [ "code", "reason" ], "properties": { "code": { "type": "integer" }, "reason": { "type": "string" }, "details": { "type": "object" } }, "additionalProperties": false } }, "responses": { "Error400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Error403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Error404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Error429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Error500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "bearerAuth": [] } ], "x-ext-urls": {} }