{"openapi": "3.0.4", "info": {"title": "Rapidata API", "description": "The API for the Rapidata Asset service", "version": "v1"}, "servers": [{"url": "https://api.rapidata.ai/"}], "tags": [{"name": "Asset", "x-displayName": "Asset"}, {"name": "BatchUpload", "x-displayName": "BatchUpload"}, {"name": "Audience", "x-displayName": "Audience"}, {"name": "Examples", "x-displayName": "Examples"}, {"name": "Cache", "x-displayName": "Cache"}, {"name": "Campaign", "x-displayName": "Campaign"}, {"name": "ExternalAudience", "x-displayName": "ExternalAudience"}, {"name": "ContextShortening", "x-displayName": "ContextShortening"}, {"name": "Datapoints", "x-displayName": "Datapoints"}, {"name": "Dataset", "x-displayName": "Dataset"}, {"name": "DatasetGroup", "x-displayName": "DatasetGroup"}, {"name": "Flow", "x-displayName": "Flow"}, {"name": "FlowItem", "x-displayName": "FlowItem"}, {"name": "RankingFlow", "x-displayName": "RankingFlow"}, {"name": "RankingFlowItem", "x-displayName": "RankingFlowItem"}, {"name": "Rapidata.Identity.API", "x-displayName": "Rapidata.Identity.API"}, {"name": "Client", "x-displayName": "Client"}, {"name": "Customer", "x-displayName": "Customer"}, {"name": "Identity", "x-displayName": "Identity"}, {"name": "Newsletter", "x-displayName": "Newsletter"}, {"name": "Organization", "x-displayName": "Organization"}, {"name": "Survey", "x-displayName": "Survey"}, {"name": "Benchmark", "x-displayName": "Benchmark"}, {"name": "SampleGeneration", "x-displayName": "SampleGeneration"}, {"name": "Faucet", "x-displayName": "Faucet"}, {"name": "Replicate", "x-displayName": "Replicate"}, {"name": "Leaderboard", "x-displayName": "Leaderboard"}, {"name": "Participant", "x-displayName": "Participant"}, {"name": "Prompt", "x-displayName": "Prompt"}, {"name": "Sample", "x-displayName": "Sample"}, {"name": "Feedback", "x-displayName": "Feedback"}, {"name": "Job", "x-displayName": "Job"}, {"name": "Order", "x-displayName": "Order"}, {"name": "Pipeline", "x-displayName": "Pipeline"}, {"name": "CustomerRapid", "x-displayName": "CustomerRapid"}, {"name": "GlobalText", "x-displayName": "GlobalText"}, {"name": "Rapid", "x-displayName": "Rapid"}, {"name": "UserRapid", "x-displayName": "UserRapid"}, {"name": "ValidationFeedback", "x-displayName": "ValidationFeedback"}, {"name": "Signal", "x-displayName": "Signal"}, {"name": "Translation", "x-displayName": "Translation"}, {"name": "ValidationSet", "x-displayName": "ValidationSet"}, {"name": "Evaluation", "x-displayName": "Evaluation"}, {"name": "GroupedRanking", "x-displayName": "GroupedRanking"}, {"name": "Ranking", "x-displayName": "Ranking"}, {"name": "SimpleWorkflow", "x-displayName": "SimpleWorkflow"}, {"name": "Workflow", "x-displayName": "Workflow"}], "paths": {"/asset/compress": {"post": {"tags": ["Asset"], "summary": "Compresses an uploaded image and returns the WebP result.", "description": "Compression metrics are returned in response headers: X-Original-Size, X-Compressed-Size,\n X-Processing-Time-Ms, X-Original-Dimensions, X-Output-Dimensions.", "parameters": [{"name": "quality", "in": "query", "description": "The compression quality from 1 to 100.", "schema": {"type": "integer", "format": "int32", "default": 85}}, {"name": "maxdim", "in": "query", "description": "The maximum dimension (width or height) of the output image.", "schema": {"type": "integer", "format": "int32", "default": 800}}], "requestBody": {"description": "The image file to compress.", "content": {"multipart/form-data": {"schema": {"required": ["file"], "type": "object", "properties": {"file": {"$ref": "#/components/schemas/IFormFile"}}}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/octet-stream": {"schema": {"type": "string", "format": "binary"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"type": "string"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/asset/file": {"post": {"tags": ["Asset"], "summary": "Uploads a file to our system and returns the new file name used internally.", "parameters": [{"name": "compress", "in": "query", "description": "When set, forces image compression on or off for this upload, overriding the configured default.", "schema": {"type": "boolean"}}, {"name": "quality", "in": "query", "description": "WebP quality (1..100) to use when compression runs. Falls back to the configured default when null.", "schema": {"type": "integer", "format": "int32"}}, {"name": "maxdim", "in": "query", "description": "Maximum width or height in pixels when compression runs. Falls back to the configured default when null.", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "The file to upload", "content": {"multipart/form-data": {"schema": {"required": ["file"], "type": "object", "properties": {"file": {"$ref": "#/components/schemas/IFormFile"}}}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UploadFileEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/asset/url": {"post": {"tags": ["Asset"], "summary": "Downloads a file from the provided URL, stores it in our system and returns the new file name used internally.", "parameters": [{"name": "url", "in": "query", "description": "The url of the file to upload.", "required": true, "schema": {"type": "string", "format": "uri"}}, {"name": "compress", "in": "query", "description": "When set, forces image compression on or off for this upload, overriding the configured default.", "schema": {"type": "boolean"}}, {"name": "quality", "in": "query", "description": "WebP quality (1..100) to use when compression runs. Falls back to the configured default when null.", "schema": {"type": "integer", "format": "int32"}}, {"name": "maxdim", "in": "query", "description": "Maximum width or height in pixels when compression runs. Falls back to the configured default when null.", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UploadFileFromUrlEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/asset/batch-upload/{batchUploadId}/abort": {"post": {"tags": ["BatchUpload"], "summary": "Aborts the specified batch upload.", "description": "URLs already processed will not be reverted. Only remaining URLs are prevented from processing.", "parameters": [{"name": "batchUploadId", "in": "path", "description": "The identifier of the batch upload to abort.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/asset/batch-upload": {"post": {"tags": ["BatchUpload"], "summary": "Creates a batch upload and queues processing for each URL.", "description": "Each URL is processed asynchronously. Use the batch upload status or result endpoints to track progress.", "requestBody": {"description": "The list of URLs to include in the batch upload.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateBatchUploadEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateBatchUploadEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/asset/batch-upload/{batchUploadId}": {"get": {"tags": ["BatchUpload"], "summary": "Gets the full result of a batch upload including all items.", "parameters": [{"name": "batchUploadId", "in": "path", "description": "The identifier of the batch upload to retrieve.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetBatchUploadResultEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/asset/batch-upload/status": {"get": {"tags": ["BatchUpload"], "summary": "Gets aggregated status for batch uploads identified by IDs or a correlation ID.", "parameters": [{"name": "batchUploadIds", "in": "query", "description": "The identifiers of the batch uploads to query.", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "correlationId", "in": "query", "description": "A client-supplied identifier to look up related batch uploads.", "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetBatchUploadStatusEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/owner": {"patch": {"tags": ["Audience"], "summary": "Changes the owner of the specified audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The new owner information.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ChangeAudienceOwnerEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience": {"post": {"tags": ["Audience"], "summary": "Creates a new empty audience.", "requestBody": {"description": "The properties of the audience to create.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateAudienceEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateAudienceEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{baseAudienceId}/filter": {"post": {"tags": ["Audience"], "summary": "Creates a filtered view on the given base audience by applying a filter on top of its\n graduates. Returns an audience id that can be used in job creation just like a regular\n audience id; no new onboarding is required.", "parameters": [{"name": "baseAudienceId", "in": "path", "description": "The id of the dimension audience whose graduates the filter is applied on top of.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The filter to apply to the base audience.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateFilteredAudienceEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateFilteredAudienceEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}": {"delete": {"tags": ["Audience"], "summary": "Deletes the specified audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Audience"], "summary": "Returns the audience with the specified id.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetAudienceByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "patch": {"tags": ["Audience"], "summary": "Patches an existing audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The audience properties to update.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateAudienceEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateAudienceEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/inactivity-sync/{syncId}": {"get": {"tags": ["Audience"], "summary": "Returns the audience inactivity sync with the given id.", "parameters": [{"name": "syncId", "in": "path", "description": "The unique identifier of the inactivity sync.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetAudienceInactivitySyncByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/state-recalculation/{recalculationId}": {"get": {"tags": ["Audience"], "summary": "Returns the audience state recalculation with the given id.", "parameters": [{"name": "recalculationId", "in": "path", "description": "The unique identifier of the recalculation.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetAudienceStateRecalculationByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/user-metrics": {"get": {"tags": ["Audience"], "summary": "Gets the count of users in each state for the specified audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetAudienceUserStateMetricsResult"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/inactivity-sync": {"get": {"tags": ["Audience"], "summary": "Returns the most recent audience inactivity sync for the given audience, regardless of state.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetLatestAudienceInactivitySyncEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "post": {"tags": ["Audience"], "summary": "Starts a new inactivity sync for the given audience.", "description": "Returns 400 if the audience does not have inactivity drop days configured.\n If a sync is already Pending for this audience, its id is returned and no new run is\n created. If one is currently Processing, it is aborted and replaced. Failed,\n Completed, and Aborted runs are left untouched and a fresh run is created.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/StartAudienceInactivitySyncEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/state-recalculation": {"get": {"tags": ["Audience"], "summary": "Returns the most recent audience state recalculation for the given audience, regardless of state.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetLatestAudienceStateRecalculationEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "post": {"tags": ["Audience"], "summary": "Starts a new audience state recalculation for the given audience.", "description": "If a recalculation is already Pending for this audience, its id is returned and no new\n run is created. If one is currently Processing, it is aborted and replaced. Failed,\n Completed, and Aborted runs are left untouched and a fresh run is created.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/StartAudienceStateRecalculationEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/initialize-users": {"post": {"tags": ["Audience"], "summary": "Uploads a CSV file containing user IDs and scores, then processes it in the background\n to seed the audience with those users.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience to initialize.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "A CSV file with columns: userId, score.", "content": {"multipart/form-data": {"schema": {"required": ["file"], "type": "object", "properties": {"file": {"$ref": "#/components/schemas/IFormFile"}}}}}, "required": true}, "responses": {"202": {"description": "Accepted"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/pause-distillation": {"post": {"tags": ["Audience"], "summary": "Pauses the distillation campaign for the specified audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/jobs": {"get": {"tags": ["Audience"], "summary": "Queries jobs for the specified audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["name", "-name", "created_at", "-created_at", "status", "-status"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "job_id", "in": "query", "description": "Filter by job_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "definition_id", "in": "query", "description": "Filter by definition_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "status", "in": "query", "description": "Filter by status.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryAudienceJobsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audiences": {"get": {"tags": ["Audience"], "summary": "Queries all audiences visible to the caller.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["name", "-name", "created_at", "-created_at", "status", "-status", "qualified_user_count", "-qualified_user_count"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "status", "in": "query", "description": "Filter by status.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "is_public", "in": "query", "description": "Filter by is_public.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "is_distilling", "in": "query", "description": "Filter by is_distilling.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_mail", "in": "query", "description": "Filter by owner_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryAudiencesEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/rebuild-distilling-campaign": {"post": {"tags": ["Audience"], "summary": "Rebuilds the distilling campaign for the specified audience.", "description": "Recalculates campaign filters and selections based on the audience's current settings\n (demographic filters, exit conditions, etc.).", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/reconcile-user-counts": {"post": {"tags": ["Audience"], "summary": "Enqueues a background job that reconciles audience-row state derived\n from audience_state_counts.", "responses": {"202": {"description": "Accepted"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/recreate-external-audiences": {"post": {"tags": ["Audience"], "summary": "Recreates external audiences for the specified audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Configuration for which external audiences to recreate.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecreateExternalAudiencesEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/resume-distillation": {"post": {"tags": ["Audience"], "summary": "Resumes the distillation campaign for the specified audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/recruit": {"post": {"tags": ["Audience"], "summary": "Starts recruiting users for the specified audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/boost-config": {"patch": {"tags": ["Audience"], "summary": "Updates the boost configuration for the specified audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The boost configuration values to update.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateBoostConfigEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateBoostConfigEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/example": {"post": {"tags": ["Examples"], "summary": "Adds a new example to an audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The example data to add.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AddExampleToAudienceEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AddExampleToAudienceEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/example/{exampleId}": {"delete": {"tags": ["Examples"], "summary": "Deletes the specified audience example.", "parameters": [{"name": "exampleId", "in": "path", "description": "The unique identifier of the example to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeleteAudienceExampleEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/examples": {"get": {"tags": ["Examples"], "summary": "Queries all examples for the specified audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["sort_index", "-sort_index"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "visibility", "in": "query", "description": "Filter by visibility.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "is_common_sense", "in": "query", "description": "Filter by is_common_sense.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryExamplesForAudienceEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/audience/{audienceId}/example/{exampleId}": {"patch": {"tags": ["Examples"], "summary": "Updates an example's properties within an audience.", "parameters": [{"name": "audienceId", "in": "path", "description": "The unique identifier of the audience.", "required": true, "schema": {"type": "string"}}, {"name": "exampleId", "in": "path", "description": "The unique identifier of the example to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The example properties to update.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateAudienceExampleEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/cache/campaigns": {"get": {"tags": ["Cache"], "summary": "Returns the current state of the in-memory campaign cache.", "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetCampaignCacheEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/cache/user-scores": {"get": {"tags": ["Cache"], "summary": "Returns the current state of the in-memory default user score cache.", "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetUserScoreCacheEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/boost": {}, "/campaign/boost/insights": {"get": {"tags": ["Campaign"], "summary": "Returns an attributed view of the aggregated boosting profile.", "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetBoostInsightsEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/boost/status": {"get": {"tags": ["Campaign"], "summary": "Returns the current boost status including active and inactive campaigns.", "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetBoostStatusEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/{campaignId}": {"get": {"tags": ["Campaign"], "summary": "Retrieves the details of a specific campaign.", "parameters": [{"name": "campaignId", "in": "path", "description": "The ID of the campaign.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetCampaignByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "patch": {"tags": ["Campaign"], "summary": "Updates the specified campaign's properties.", "parameters": [{"name": "campaignId", "in": "path", "description": "The identifier of the campaign to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The properties to update.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateCampaignEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/boost/{externalCampaignId}/fast-bid-multiplier": {"get": {"tags": ["Campaign"], "summary": "Returns the fast bid multiplier currently applied to an external booster campaign.", "description": "Returns the downstream system's default (1.0) if the multiplier has never been set\n for the campaign.", "parameters": [{"name": "externalCampaignId", "in": "path", "description": "The external booster campaign id to read.", "required": true, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetFastBidMultiplierEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "put": {"tags": ["Campaign"], "summary": "Sets the fast bid multiplier for a single external booster campaign to an arbitrary value.", "description": "Bypasses the level\u2192multiplier mapping. Intended for live testing and one-off\n operational tweaks. Value must be in [0, 50]; 0 effectively pauses delivery on the\n campaign without changing its status. The response reports the multiplier the\n downstream system confirms is applied.", "parameters": [{"name": "externalCampaignId", "in": "path", "description": "The external booster campaign id to update.", "required": true, "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"description": "The desired multiplier value.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SetFastBidMultiplierEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SetFastBidMultiplierEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/monitor": {"get": {"tags": ["Campaign"], "summary": "Exercises the rapid-bag pipeline with a synthetic user profile so the health of\n the campaign monitoring path can be probed externally.", "responses": {"200": {"description": "OK"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/{campaignId}/pause": {"post": {"tags": ["Campaign"], "summary": "Pauses the specified campaign.", "parameters": [{"name": "campaignId", "in": "path", "description": "The identifier of the campaign to pause.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/boost/preheat": {"post": {"tags": ["Campaign"], "summary": "Triggers a preheat pass for the boost subsystem so warm caches are ready before\n traffic spikes.", "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaigns": {"get": {"tags": ["Campaign"], "summary": "Queries campaigns with optional filtering, sorting, and pagination.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["name", "-name", "priority", "-priority", "status", "-status", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "status", "in": "query", "description": "Filter by status.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "priority", "in": "query", "description": "Filter by priority.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_mail", "in": "query", "description": "Filter by owner_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryCampaignsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/{campaignId}/resume": {"post": {"tags": ["Campaign"], "summary": "Resumes the specified campaign.", "parameters": [{"name": "campaignId", "in": "path", "description": "The identifier of the campaign to resume.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/boost/global-level": {"put": {"tags": ["Campaign"], "summary": "Sets or clears the manual global boost level.", "requestBody": {"description": "The manual global boost level to apply. Null clears the manual override.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SetManualGlobalBoostLevelEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/external-audiences": {"get": {"tags": ["ExternalAudience"], "summary": "Queries the cached external audiences available for targeting.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "name", "-name", "count", "-count"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "count", "in": "query", "description": "Filter by count.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryExternalAudiencesEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/campaign/external-audiences/sync": {"post": {"tags": ["ExternalAudience"], "summary": "Enqueues a background job that synchronises external audiences with the cache.", "responses": {"202": {"description": "Accepted"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/datasets/shorten-context": {"post": {"tags": ["ContextShortening"], "summary": "Shortens each context to the parts relevant to its question, returning results in input order.", "description": "Results are cached per (context, question, prompt version), so repeated requests do not re-call the model.", "requestBody": {"description": "The context/question pairs to shorten.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ShortenContextEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ShortenContextEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/dataset/{datasetId}/datapoint": {"post": {"tags": ["Datapoints"], "summary": "Creates a new datapoint in the specified dataset.", "parameters": [{"name": "datasetId", "in": "path", "description": "The id of the dataset to create the datapoint in.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The datapoint model containing asset, metadata, and sort index.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateDatapointEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateDatapointEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/datapoint/{datapointId}": {"delete": {"tags": ["Datapoints"], "summary": "Deletes the specified datapoint.", "parameters": [{"name": "datapointId", "in": "path", "description": "The unique identifier of the datapoint to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Datapoints"], "summary": "Gets the details of a datapoint by its id.", "parameters": [{"name": "datapointId", "in": "path", "description": "The id of the datapoint to get.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetDatapointEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/dataset/{datasetId}/datapoints/failed": {"get": {"tags": ["Datapoints"], "summary": "Gets a list of all datapoints that failed to upload.", "description": "A datapoint usually fails to upload when using a deferred upload mechanism such as when providing a URL\n and the URL is not accessible.", "parameters": [{"name": "datasetId", "in": "path", "description": "The id of the dataset to get the failed datapoints of.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetFailedDatapointsEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/dataset/{datasetId}/datapoints": {"get": {"tags": ["Datapoints"], "summary": "Queries all datapoints of a dataset.", "parameters": [{"name": "datasetId", "in": "path", "description": "The id of the dataset to get the datapoints of.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryDatapointsByDatasetIdEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/dataset": {"post": {"tags": ["Dataset"], "summary": "Creates a new empty dataset.", "requestBody": {"description": "The dataset creation parameters.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateDatasetEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateDatasetEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/dataset/{datasetId}": {"get": {"tags": ["Dataset"], "summary": "Gets a dataset by its id.", "parameters": [{"name": "datasetId", "in": "path", "description": "The id of the dataset to get.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetDatasetByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/dataset/{datasetId}/progress": {"get": {"tags": ["Dataset"], "summary": "Gets the upload progress of a dataset.", "parameters": [{"name": "datasetId", "in": "path", "description": "The id of the dataset to get the progress of.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetDatasetProgressEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/dataset/{datasetId}/name": {"patch": {"tags": ["Dataset"], "summary": "Updates the name of a dataset.", "parameters": [{"name": "datasetId", "in": "path", "description": "The id of the dataset to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The new name for the dataset.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateDatasetNameEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/dataset/{datasetId}/group": {"post": {"tags": ["DatasetGroup"], "summary": "Creates a new dataset group.", "parameters": [{"name": "datasetId", "in": "path", "description": "The id of the dataset to create the group for.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The dataset group creation parameters.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateDatasetGroupEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow/{flowId}": {"delete": {"tags": ["Flow"], "summary": "Deletes a flow.", "parameters": [{"name": "flowId", "in": "path", "description": "The ID of the flow to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Flow"], "summary": "Retrieves a flow by its ID.", "parameters": [{"name": "flowId", "in": "path", "description": "The ID of the flow to retrieve.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IFlowModel"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow/ranking/{flowId}/completion-time-histogram": {"get": {"tags": ["Flow"], "summary": "Returns the distribution of completion durations (in seconds) per completed flow item.", "parameters": [{"name": "flowId", "in": "path", "description": "The ID of the flow.", "required": true, "schema": {"type": "string"}}, {"name": "from", "in": "query", "description": "Optional start of the date range filter (inclusive).", "schema": {"type": "string", "format": "date-time"}}, {"name": "to", "in": "query", "description": "Optional end of the date range filter (inclusive).", "schema": {"type": "string", "format": "date-time"}}, {"name": "bucketCount", "in": "query", "description": "Number of histogram buckets (default 10, max 100).", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetCompletionTimeHistogramEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow/ranking/{flowId}/flow-item-creation-timeseries": {"get": {"tags": ["Flow"], "summary": "Returns flow item creation counts bucketed over time.", "parameters": [{"name": "flowId", "in": "path", "description": "The ID of the flow.", "required": true, "schema": {"type": "string"}}, {"name": "from", "in": "query", "description": "Optional start of the date range filter (inclusive).", "schema": {"type": "string", "format": "date-time"}}, {"name": "to", "in": "query", "description": "Optional end of the date range filter (exclusive).", "schema": {"type": "string", "format": "date-time"}}, {"name": "datapoints", "in": "query", "description": "Number of time buckets (default 100, max 1000).", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetFlowItemCreationTimeseriesEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow/ranking/{flowId}/response-count-histogram": {"get": {"tags": ["Flow"], "summary": "Returns the distribution of total votes per completed flow item.", "parameters": [{"name": "flowId", "in": "path", "description": "The ID of the flow.", "required": true, "schema": {"type": "string"}}, {"name": "from", "in": "query", "description": "Optional start of the date range filter (inclusive).", "schema": {"type": "string", "format": "date-time"}}, {"name": "to", "in": "query", "description": "Optional end of the date range filter (inclusive).", "schema": {"type": "string", "format": "date-time"}}, {"name": "bucketCount", "in": "query", "description": "Number of histogram buckets (default 10, max 100).", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetResponseCountHistogramEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow/ranking/{flowId}/response-count-timeseries": {"get": {"tags": ["Flow"], "summary": "Returns average response counts bucketed over time for completed flow items.", "parameters": [{"name": "flowId", "in": "path", "description": "The ID of the flow.", "required": true, "schema": {"type": "string"}}, {"name": "from", "in": "query", "description": "Optional start of the date range filter (inclusive).", "schema": {"type": "string", "format": "date-time"}}, {"name": "to", "in": "query", "description": "Optional end of the date range filter (exclusive).", "schema": {"type": "string", "format": "date-time"}}, {"name": "datapoints", "in": "query", "description": "Number of time buckets (default 100, max 1000).", "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetResponseCountTimeseriesEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow": {"get": {"tags": ["Flow"], "summary": "Queries flows with filtering and pagination.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["name", "-name", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryFlowsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow/item/{flowItemId}/stop": {"post": {"tags": ["FlowItem"], "summary": "Stops the specified flow item and triggers partial result processing.", "parameters": [{"name": "flowItemId", "in": "path", "description": "The ID of the flow item to stop.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow/ranking": {"post": {"tags": ["RankingFlow"], "summary": "Creates a new ranking flow.", "requestBody": {"description": "The ranking flow creation parameters.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateFlowEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateFlowEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow/ranking/{flowId}/config": {"patch": {"tags": ["RankingFlow"], "summary": "Updates the configuration of a ranking flow.", "parameters": [{"name": "flowId", "in": "path", "description": "The ID of the ranking flow to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The configuration fields to update.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateConfigEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow/ranking/{flowId}/item": {"post": {"tags": ["RankingFlowItem"], "summary": "Creates a new flow item for the specified flow.", "parameters": [{"name": "flowId", "in": "path", "description": "The ID of the flow to create the item in.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The flow item creation parameters.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateFlowItemEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateFlowItemEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["RankingFlowItem"], "summary": "Queries flow items for a flow.", "parameters": [{"name": "flowId", "in": "path", "description": "The ID of the flow to query items for.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["state", "-state", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "state", "in": "query", "description": "Filter by state.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryFlowItemsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow/ranking/item/{flowItemId}": {"get": {"tags": ["RankingFlowItem"], "summary": "Retrieves a flow item by its ID.", "parameters": [{"name": "flowItemId", "in": "path", "description": "The ID of the flow item to retrieve.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetFlowItemByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow/ranking/item/{flowItemId}/results": {"get": {"tags": ["RankingFlowItem"], "summary": "Returns ranking results with Elo scores for a completed flow item.", "description": "Returns 409 Conflict if the flow item is not yet completed or has no associated workflow.", "parameters": [{"name": "flowItemId", "in": "path", "description": "The ID of the flow item to get results for.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetRankingFlowItemResultsEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}, "409": {"description": "Conflict", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProblemDetails"}}}}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/flow/ranking/item/{flowItemId}/vote-matrix": {"get": {"tags": ["RankingFlowItem"], "summary": "Retrieves the pairwise vote matrix for a completed flow item.", "description": "Returns 409 Conflict if the flow item is not completed or has no associated workflow.", "parameters": [{"name": "flowItemId", "in": "path", "description": "The ID of the flow item to get the vote matrix for.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetRankingFlowItemVoteMatrixEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}, "409": {"description": "Conflict", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProblemDetails"}}}}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/": {"get": {"tags": ["Rapidata.Identity.API"], "responses": {"200": {"description": "OK"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/client": {"post": {"tags": ["Client"], "summary": "Creates a new client for the current customer.", "requestBody": {"description": "The client creation payload.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateClientEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateClientEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/client/{clientId}": {"delete": {"tags": ["Client"], "summary": "Deletes a client.", "parameters": [{"name": "clientId", "in": "path", "description": "The id of the client to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Client"], "summary": "Gets the details of a specific client.", "operationId": "Identity.GetClient", "parameters": [{"name": "clientId", "in": "path", "description": "The id of the client to retrieve.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClientModel"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/clients": {"get": {"tags": ["Client"], "summary": "Queries clients for the current customer.", "description": "Clients are service credentials that allow automated processes to authenticate against the API.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["display_name", "-display_name", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "client_id", "in": "query", "description": "Filter by client_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "display_name", "in": "query", "description": "Filter by display_name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryClientsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/client/register": {"post": {"tags": ["Client"], "summary": "Registers a new client using the OpenID Connect Dynamic Client Registration protocol.", "description": "Follows RFC 7591.", "requestBody": {"description": "The dynamic client registration request.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DynamicClientRegistrationRequest"}}}, "required": true}, "responses": {"200": {"description": "OK"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/customers": {"get": {"tags": ["Customer"], "summary": "Queries customers with filtering and pagination.", "description": "Results are scoped to customers that belong to the caller's organization.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["email", "-email", "organization_name", "-organization_name"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "email", "in": "query", "description": "Filter by email.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "organization_name", "in": "query", "description": "Filter by organization_name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "organization_id", "in": "query", "description": "Filter by organization_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryCustomersEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/identity/bridge-token": {"post": {"tags": ["Identity"], "summary": "Creates a pair of read and write bridge token keys for a client.", "description": "The write key stores the authentication result and the read key retrieves it.", "parameters": [{"name": "clientId", "in": "query", "description": "The client ID to create the keys for.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateBridgeTokenEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Identity"], "summary": "Reads the bridge token keys for a given read key.", "description": "Returns 200 with the keys when available, 202 when they are not yet available, or 404 when not found.", "parameters": [{"name": "readKey", "in": "query", "description": "The read key to read the bridge token keys for.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadBridgeTokenEndpoint_KeysOutput"}}}}, "202": {"description": "Accepted", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadBridgeTokenEndpoint_NotAvailableOutput"}}}}, "404": {"description": "Not Found", "content": {"application/json": {"schema": {"type": "string"}}}}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/identity/google-one-tap": {"post": {"tags": ["Identity"], "summary": "Signs in a user using a token received from Google One Tap.", "description": "Redirects to the register confirmation page when the account requires email confirmation.", "requestBody": {"description": "The body of the request containing the id token.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GoogleOneTapLoginEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GoogleOneTapLoginEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/identity/referrer": {"post": {"tags": ["Identity"], "summary": "Stores the referrer in a cookie for later use during sign-up.", "parameters": [{"name": "referrer", "in": "query", "description": "The referrer value to store.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/newsletter/subscribe": {"post": {"tags": ["Newsletter"], "summary": "Signs an email address up to the newsletter.", "requestBody": {"description": "The email to subscribe and a recaptcha token.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SubscribeToNewsletterEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/newsletter/unsubscribe": {"post": {"tags": ["Newsletter"], "summary": "Removes an email address from the newsletter.", "requestBody": {"description": "The email to unsubscribe and a recaptcha token.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnsubscribeFromNewsletterEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/organizations/mine": {"get": {"tags": ["Organization"], "summary": "Returns the organization resolved from the calling customer's email domain.", "description": "Responds with 404 when the caller's email domain does not match a registered organization.", "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetMyOrganizationEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/organizations": {"get": {"tags": ["Organization"], "summary": "Returns a paged list of organizations.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["name", "-name", "domain", "-domain"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "domain", "in": "query", "description": "Filter by domain.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner", "in": "query", "description": "Filter by owner.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryOrganizationsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/organizations/{owner}/support-slack-channel": {"put": {"tags": ["Organization"], "summary": "Sets the support Slack channel URL for the organization owned by the given customer.", "description": "A null or empty URL clears the channel. Responds with 404 when no organization is owned by the given customer.", "parameters": [{"name": "owner", "in": "path", "description": "The customer ID that owns the organization.", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"description": "The support Slack channel URL to set or clear.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SetOrganizationSupportSlackChannelEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/identity/survey": {"post": {"tags": ["Survey"], "summary": "Submits a survey for the calling customer.", "requestBody": {"description": "The survey fields to submit.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SendSurveyEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark": {"post": {"tags": ["Benchmark"], "summary": "Creates a benchmark.", "requestBody": {"description": "The payload describing the benchmark to create.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateBenchmarkEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateBenchmarkEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/participants": {"post": {"tags": ["Benchmark"], "summary": "Creates a participant in a benchmark.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark the participant will be added to.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The payload describing the participant to create.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateBenchmarkParticipantEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateBenchmarkParticipantEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Benchmark"], "summary": "Queries all participants within a benchmark.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark whose participants will be returned.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "name", "-name", "status", "-status"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "status", "in": "query", "description": "Filter by status.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryParticipantsByBenchmarkEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/prompt": {"post": {"tags": ["Benchmark"], "summary": "Adds a new prompt to a benchmark.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark to add the prompt to.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The payload describing the prompt to create.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreatePromptForBenchmarkEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreatePromptForBenchmarkEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}": {"delete": {"tags": ["Benchmark"], "summary": "Deletes a benchmark.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Benchmark"], "summary": "Returns a single benchmark by its id.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark to load.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetBenchmarkByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "patch": {"tags": ["Benchmark"], "summary": "Updates a benchmark using patch semantics.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The patch payload describing which fields should change.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateBenchmarkEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/participant/{participantId}": {"delete": {"tags": ["Benchmark"], "summary": "Deletes a participant on a benchmark.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark the participant belongs to.", "required": true, "schema": {"type": "string"}}, {"name": "participantId", "in": "path", "description": "The id of the participant to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/fork": {"post": {"tags": ["Benchmark"], "summary": "Creates a copy of a public benchmark and all of its related entities.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark to fork.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ForkBenchmarkEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/matrix": {"get": {"tags": ["Benchmark"], "summary": "Returns the pairwise vote matrix for a benchmark.", "description": "The matrix is returned in pandas split format.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The identifier of the benchmark.", "required": true, "schema": {"type": "string"}}, {"name": "tags", "in": "query", "description": "Optional tags to filter the matrix entries.", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "participantIds", "in": "query", "description": "Optional participant identifiers to include in the matrix.", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "leaderboardIds", "in": "query", "description": "Optional leaderboard identifiers to scope the matrix.", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "useWeightedScoring", "in": "query", "description": "Whether to apply weighted scoring to the matrix values.", "schema": {"type": "boolean", "default": false}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/VoteMatrixResult"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/combined-matrix": {"get": {"tags": ["Benchmark"], "summary": "Returns the combined pairwise vote matrix for multiple benchmarks.", "parameters": [{"name": "benchmarkIds", "in": "query", "description": "The identifiers of the benchmarks to combine.", "required": true, "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "useWeightedScoring", "in": "query", "description": "Whether to apply weighted scoring to the matrix values.", "schema": {"type": "boolean", "default": false}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetCombinedBenchmarkMatrixEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/combined-standings": {"get": {"tags": ["Benchmark"], "summary": "Returns the combined standings for multiple benchmarks.", "parameters": [{"name": "benchmarkIds", "in": "query", "description": "The identifiers of the benchmarks to combine.", "required": true, "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "useWeightedScoring", "in": "query", "description": "Whether to apply weighted scoring.", "schema": {"type": "boolean", "default": false}}, {"name": "includeConfidenceIntervals", "in": "query", "description": "Whether to include confidence intervals in results.", "schema": {"type": "boolean", "default": false}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetCombinedBenchmarkStandingsEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/prompts": {"get": {"tags": ["Benchmark"], "summary": "Returns the paged prompts of a benchmark.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark to query.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "identifier", "in": "query", "description": "Filter by identifier.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "english_prompt", "in": "query", "description": "Filter by english_prompt.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "original_prompt", "in": "query", "description": "Filter by original_prompt.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetPromptsByBenchmarkEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/standings": {"get": {"tags": ["Benchmark"], "summary": "Queries all standings for a benchmark.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark whose standings should be queried.", "required": true, "schema": {"type": "string"}}, {"name": "tags", "in": "query", "description": "The tags to filter the standings by.", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "participantIds", "in": "query", "description": "The participant ids to filter by; leave empty for no filter.", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "leaderboardIds", "in": "query", "description": "The leaderboard ids to filter by; leave empty for no filter.", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "useWeightedScoring", "in": "query", "description": "Whether to apply weighted scoring based on user scores.", "schema": {"type": "boolean", "default": false}}, {"name": "includeConfidenceIntervals", "in": "query", "description": "Whether to include confidence intervals in results.", "schema": {"type": "boolean", "default": false}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryBenchmarkStandingsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmarks": {"get": {"tags": ["Benchmark"], "summary": "Queries all benchmarks of the current user.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "name", "-name", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_mail", "in": "query", "description": "Filter by owner_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryBenchmarksEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/leaderboards": {"get": {"tags": ["Benchmark"], "summary": "Queries all leaderboards for the given benchmark.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark whose leaderboards will be returned.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "name", "-name"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryLeaderboardsByBenchmarkEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmarks/managed": {"get": {"tags": ["Benchmark"], "summary": "Queries the curated benchmarks available to every customer.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "name", "-name", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_mail", "in": "query", "description": "Filter by owner_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryManagedBenchmarksEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmarks/published": {"get": {"tags": ["Benchmark"], "summary": "Queries the benchmarks surfaced in the public benchmark repository.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "name", "-name", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_mail", "in": "query", "description": "Filter by owner_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryPublishedBenchmarksEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/tags": {"get": {"tags": ["Benchmark"], "summary": "Queries all tags within a benchmark.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark whose tags will be returned.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryTagsByBenchmarkEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/sample-generation": {"post": {"tags": ["Benchmark", "SampleGeneration"], "summary": "Starts an asynchronous sample generation run.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The benchmark whose participants should run their faucets.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The generation configuration.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSampleGenerationEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSampleGenerationEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/participants/{participantId}/submit": {"post": {"tags": ["Benchmark"], "summary": "Submits a participant to a benchmark.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark the participant belongs to.", "required": true, "schema": {"type": "string"}}, {"name": "participantId", "in": "path", "description": "The id of the participant to submit.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SubmitParticipantByBenchmarkEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/name": {"put": {"tags": ["Benchmark"], "summary": "Updates the name of a benchmark.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The payload describing the new name.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateBenchmarkNameEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/faucet/replicate/models/{modelOwner}/{modelName}": {"get": {"tags": ["Faucet", "Replicate"], "summary": "Returns a single Replicate model with its input parameter schema.", "description": "When supportsImageReference is true the model accepts a reference image that the\n platform auto-fills with a prompt's attached media; that input is excluded from the returned\n parameters and must not be configured by the customer.", "parameters": [{"name": "modelOwner", "in": "path", "description": "The owner of the hosted model.", "required": true, "schema": {"type": "string"}}, {"name": "modelName", "in": "path", "description": "The model name.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetReplicateModelEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/faucet/replicate/models": {"get": {"tags": ["Faucet", "Replicate"], "summary": "Searches Replicate models by free-text term.", "description": "Results are cursor-paginated: pass the returned nextCursor back as cursor to\n fetch the next page.", "parameters": [{"name": "search", "in": "query", "description": "The free-text term to search models by.", "required": true, "schema": {"type": "string"}}, {"name": "cursor", "in": "query", "description": "Cursor continuing a previous search; omit for the first page.", "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SearchReplicateModelsEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/{leaderboardId}/boost": {"post": {"tags": ["Leaderboard"], "summary": "Boosts a subset of participants within a leaderboard.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard to boost.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The payload describing the boost to apply.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BoostLeaderboardEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard": {"post": {"tags": ["Leaderboard"], "summary": "Creates a new leaderboard.", "requestBody": {"description": "The current HTTP context, used for user claims.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateLeaderboardEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateLeaderboardEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/{leaderboardId}/participants": {"post": {"tags": ["Leaderboard"], "summary": "Creates a participant in a leaderboard.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard the participant will be added to.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The payload describing the participant to create.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateLeaderboardParticipantEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateLeaderboardParticipantEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Leaderboard"], "summary": "Queries all participants connected to a leaderboard.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard whose participants should be queried.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryParticipantsObsoleteEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/{leaderboardId}/prompts": {"post": {"tags": ["Leaderboard"], "summary": "Adds a new prompt to a leaderboard.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard to add the prompt to.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The prompt text.", "content": {"application/json": {"schema": {"type": "string"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreatePromptForLeaderboardEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/{leaderboardId}": {"delete": {"tags": ["Leaderboard"], "summary": "Deletes a leaderboard by its id.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Leaderboard"], "summary": "Gets a leaderboard by its id.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard to retrieve.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetLeaderboardByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "patch": {"tags": ["Leaderboard"], "summary": "Updates a leaderboard using patch semantics.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The patch payload describing which fields should change.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateLeaderboardEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/combined-matrix": {"get": {"tags": ["Leaderboard"], "summary": "Returns the combined pairwise vote matrix for multiple leaderboards.", "parameters": [{"name": "leaderboardIds", "in": "query", "description": "The identifiers of the leaderboards to combine.", "required": true, "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "useWeightedScoring", "in": "query", "description": "Whether to apply weighted scoring to the matrix values.", "schema": {"type": "boolean", "default": false}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetCombinedLeaderboardMatrixEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/combined-standings": {"get": {"tags": ["Leaderboard"], "summary": "Returns the combined standings for multiple leaderboards.", "parameters": [{"name": "leaderboardIds", "in": "query", "description": "The identifiers of the leaderboards to combine.", "required": true, "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "useWeightedScoring", "in": "query", "description": "Whether to apply weighted scoring.", "schema": {"type": "boolean", "default": false}}, {"name": "includeConfidenceIntervals", "in": "query", "description": "Whether to include confidence intervals in results.", "schema": {"type": "boolean", "default": false}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetCombinedLeaderboardStandingsEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/{leaderboardId}/matrix": {"get": {"tags": ["Leaderboard"], "summary": "Returns the pairwise vote matrix for a leaderboard.", "description": "The matrix is returned in pandas split format.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The identifier of the leaderboard.", "required": true, "schema": {"type": "string"}}, {"name": "tags", "in": "query", "description": "Optional tags to filter the matrix entries.", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "useWeightedScoring", "in": "query", "description": "Whether to apply weighted scoring to the matrix values.", "schema": {"type": "boolean", "default": false}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/VoteMatrixResult"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/{leaderboardId}/participant/{participantId}": {"get": {"tags": ["Leaderboard"], "summary": "Gets a participant by its id.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard the participant belongs to.", "required": true, "schema": {"type": "string"}}, {"name": "participantId", "in": "path", "description": "The id of the participant to retrieve.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetParticipantByIdObsoleteEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/standing/{leaderboardId}/{participantId}": {"get": {"tags": ["Leaderboard"], "summary": "Gets a standing by leaderboard id and participant id.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard the standing belongs to.", "required": true, "schema": {"type": "string"}}, {"name": "participantId", "in": "path", "description": "The id of the participant whose standing should be retrieved.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetStandingByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/{leaderboardId}/runs": {"get": {"tags": ["Leaderboard"], "summary": "Queries the runs related to a leaderboard.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard whose runs should be queried.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "name", "-name", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "status", "in": "query", "description": "Filter by status.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_mail", "in": "query", "description": "Filter by owner_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryLeaderboardRunsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboards": {"get": {"tags": ["Leaderboard"], "summary": "Queries all leaderboards accessible to the current user.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "name", "-name", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "benchmark_id", "in": "query", "description": "Filter by benchmark_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryLeaderboardsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/{leaderboardId}/standings": {"get": {"tags": ["Leaderboard"], "summary": "Queries all standings for a leaderboard by its id.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard whose standings should be queried.", "required": true, "schema": {"type": "string"}}, {"name": "tags", "in": "query", "description": "The tags the standings should be filtered by.", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "useWeightedScoring", "in": "query", "description": "Whether to use weighted scoring based on user scores.", "schema": {"type": "boolean", "default": false}}, {"name": "includeConfidenceIntervals", "in": "query", "description": "Whether to include confidence intervals in results.", "schema": {"type": "boolean", "default": false}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryStandingsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/{leaderboardId}/participants/{participantId}/submit": {"post": {"tags": ["Leaderboard"], "summary": "Submits a participant to a leaderboard.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard the participant belongs to.", "required": true, "schema": {"type": "string"}}, {"name": "participantId", "in": "path", "description": "The id of the participant to submit.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SubmitParticipantEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/{leaderboardId}/name": {"put": {"tags": ["Leaderboard"], "summary": "Updates the name of a leaderboard.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The payload describing the new name.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateLeaderboardNameEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/leaderboard/{leaderboardId}/response-config": {"put": {"tags": ["Leaderboard"], "summary": "Updates the response configuration of a leaderboard.", "parameters": [{"name": "leaderboardId", "in": "path", "description": "The id of the leaderboard to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The payload describing the new response configuration.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateLeaderboardResponseConfigEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/participant/{participantId}/sample": {"post": {"tags": ["Participant"], "summary": "Adds a sample to a participant.", "parameters": [{"name": "participantId", "in": "path", "description": "The id of the participant to add the sample to.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The payload describing the sample to create.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSampleEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSampleEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/participant/{participantId}/sample-new": {"post": {"tags": ["Participant"], "summary": "Adds a sample to a participant.", "parameters": [{"name": "participantId", "in": "path", "description": "The id of the participant to add the sample to.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The payload describing the sample to create.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSampleNewEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSampleNewEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/participant/{participantId}": {"delete": {"tags": ["Participant"], "summary": "Deletes a participant.", "parameters": [{"name": "participantId", "in": "path", "description": "The id of the participant to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Participant"], "summary": "Gets a participant by its id.", "parameters": [{"name": "participantId", "in": "path", "description": "The id of the participant to query.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetParticipantByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "patch": {"tags": ["Participant"], "summary": "Updates a participant using patch semantics.", "parameters": [{"name": "participantId", "in": "path", "description": "The id of the participant to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The patch payload describing which fields should change.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateParticipantEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/participant-sample/{sampleId}": {"delete": {"tags": ["Participant"], "summary": "Deletes a participant sample.", "parameters": [{"name": "sampleId", "in": "path", "description": "The id of the sample to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/participant/{participantId}/disable": {"post": {"tags": ["Participant"], "summary": "Disables a participant in a benchmark.", "parameters": [{"name": "participantId", "in": "path", "description": "The id of the participant to disable.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/participant/{participantId}/enable": {"post": {"tags": ["Participant"], "summary": "Enables a previously disabled participant in a benchmark.", "description": "Fails with 400 if the participant is not currently disabled.", "parameters": [{"name": "participantId", "in": "path", "description": "The id of the participant to enable.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/participant/{participantId}/faucet": {"delete": {"tags": ["Participant", "Faucet"], "summary": "Removes the faucet configuration from a participant.", "parameters": [{"name": "participantId", "in": "path", "description": "The id of the participant.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "put": {"tags": ["Participant", "Faucet"], "summary": "Sets the faucet used to auto-generate samples for a participant.", "parameters": [{"name": "participantId", "in": "path", "description": "The id of the participant whose faucet to set.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The faucet configuration payload.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IFaucetInput"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/participants/{participantId}/submit": {"post": {"tags": ["Participant"], "summary": "Submits a participant to a benchmark.", "parameters": [{"name": "participantId", "in": "path", "description": "The id of the participant to submit.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SubmitParticipantEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/participant/{participantId}/name": {"put": {"tags": ["Participant"], "summary": "Updates the name of a participant.", "parameters": [{"name": "participantId", "in": "path", "description": "The id of the participant whose name should be updated.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The payload containing the new participant name.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateParticipantNameEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark-prompt/{promptId}": {"delete": {"tags": ["Prompt"], "summary": "Deletes a prompt.", "description": "Also removes every sample generated for the prompt across the benchmark.", "parameters": [{"name": "promptId", "in": "path", "description": "The id of the prompt to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark-prompt/{promptId}/tags": {"put": {"tags": ["Prompt"], "summary": "Updates the tags associated with a prompt.", "parameters": [{"name": "promptId", "in": "path", "description": "The id of the prompt to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The new list of tags.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdatePromptTagsEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark-sample/{sampleId}": {"get": {"tags": ["Sample"], "summary": "Gets a benchmark sample by its id.", "parameters": [{"name": "sampleId", "in": "path", "description": "The id of the sample to be retrieved.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetSampleByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark-sample/{sampleId}/navigation": {"get": {"tags": ["Sample"], "summary": "Gets navigation context (previous, next, related samples) for a sample.", "parameters": [{"name": "sampleId", "in": "path", "description": "The id of the sample to anchor navigation on.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetSampleNavigationEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/samples/{identifier}": {"get": {"tags": ["Sample"], "summary": "Returns the paged samples of a benchmark filtered by an identifier.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark to query.", "required": true, "schema": {"type": "string"}}, {"name": "identifier", "in": "path", "description": "The identifier to filter all samples for.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "participant_id", "in": "query", "description": "Filter by participant_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetSamplesByIdentifierEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/participant/{participantId}/samples": {"get": {"tags": ["Sample"], "summary": "Queries all samples of a participant.", "parameters": [{"name": "participantId", "in": "path", "description": "The id of the participant to query samples for.", "required": true, "schema": {"type": "string"}}, {"name": "fillMissing", "in": "query", "description": "Whether to fill missing samples with placeholders.", "schema": {"type": "boolean", "default": false}}, {"name": "tags", "in": "query", "description": "The tags to filter the samples by; a sample matches when any of its prompt tags is in this list.", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["identifier", "-identifier", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "identifier", "in": "query", "description": "Filter by identifier.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetSamplesByParticipantEndpoint_PagedResultOfISampleOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/sample-generation/{sampleGenerationId}": {"get": {"tags": ["SampleGeneration"], "summary": "Returns the current status and progress of a sample generation request.", "parameters": [{"name": "sampleGenerationId", "in": "path", "description": "The id of the sample generation request.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetSampleGenerationEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/sample-generation/{sampleGenerationId}/items": {"get": {"tags": ["SampleGeneration"], "summary": "Returns the per-item audit trail for a sample generation request.", "parameters": [{"name": "sampleGenerationId", "in": "path", "description": "The id of the sample generation request.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["created_at", "-created_at", "prompt_identifier", "-prompt_identifier"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "status", "in": "query", "description": "Filter by status.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "participant_id", "in": "query", "description": "Filter by participant_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "prompt_identifier", "in": "query", "description": "Filter by prompt_identifier.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetSampleGenerationItemsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/{benchmarkId}/sample-generations": {"get": {"tags": ["SampleGeneration"], "summary": "Lists historical sample generation runs for the given benchmark.", "description": "Results are sorted by creation time (newest first) by default.", "parameters": [{"name": "benchmarkId", "in": "path", "description": "The id of the benchmark whose sample generations should be listed.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "status", "in": "query", "description": "Filter by status.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QuerySampleGenerationsByBenchmarkEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/benchmark/sample-generation/{sampleGenerationId}/retry": {"post": {"tags": ["SampleGeneration"], "summary": "Re-queues failed items of a sample generation so they run again.", "description": "When no item ids are supplied, every failed item of the generation is retried. Item ids that\n do not belong to the generation or are not in a failed state are ignored. Returns the ids\n that were re-queued; a generation with no failed items yields an empty result.", "parameters": [{"name": "sampleGenerationId", "in": "path", "description": "The id of the sample generation request.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Optional payload restricting the retry to specific item ids.", "content": {"application/json": {"schema": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/RetrySampleGenerationEndpoint_Input"}]}}}}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RetrySampleGenerationEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/feedback": {"post": {"tags": ["Feedback"], "summary": "Submits feedback about our services.", "requestBody": {"description": "The feedback payload.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SubmitFeedbackEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/{jobId}/approve": {"post": {"tags": ["Job"], "summary": "Approves a job in manual review so its pipeline can start processing.", "parameters": [{"name": "jobId", "in": "path", "description": "The ID of the job to approve.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/definition": {"post": {"tags": ["Job"], "summary": "Creates a new job definition.", "description": "A preview pipeline is automatically created and returned in the response.", "requestBody": {"description": "The job definition parameters.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateJobDefinitionEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateJobDefinitionEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job": {"post": {"tags": ["Job"], "summary": "Creates a new job from a job definition and audience.", "description": "If the audience is not already recruiting, recruiting is started automatically.\n The RecruitingStarted field indicates whether this happened.", "requestBody": {"description": "The job creation parameters.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateJobEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateJobEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/definition/{definitionId}/revision": {"post": {"tags": ["Job"], "summary": "Creates a new revision for an existing job definition.", "description": "Unspecified fields are inherited from the previous revision. Workflow and Referee must be\n provided together if either is specified.", "parameters": [{"name": "definitionId", "in": "path", "description": "The id of the job definition to create a revision for.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The revision parameters.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateJobRevisionEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateJobRevisionEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Job"], "summary": "Gets the latest revision for a job definition.", "parameters": [{"name": "definitionId", "in": "path", "description": "The id of the job definition.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetJobRevisionEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/definition/{definitionId}": {"delete": {"tags": ["Job"], "summary": "Deletes a job definition and all its revisions.", "parameters": [{"name": "definitionId", "in": "path", "description": "The id of the job definition to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Job"], "summary": "Gets a job definition by its id.", "parameters": [{"name": "definitionId", "in": "path", "description": "The id of the job definition to retrieve.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetJobDefinitionByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "patch": {"tags": ["Job"], "summary": "Updates a job definition.", "parameters": [{"name": "definitionId", "in": "path", "description": "The id of the job definition to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The fields to update.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateJobDefinitionEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/{jobId}": {"delete": {"tags": ["Job"], "summary": "Deletes a job.", "parameters": [{"name": "jobId", "in": "path", "description": "The id of the job to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Job"], "summary": "Gets a job by its id.", "parameters": [{"name": "jobId", "in": "path", "description": "The id of the job to retrieve.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetJobByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "patch": {"tags": ["Job"], "summary": "Updates a job.", "parameters": [{"name": "jobId", "in": "path", "description": "The id of the job to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The fields to update.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateJobEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/{jobId}/download-results": {"get": {"tags": ["Job"], "summary": "Downloads the results of a job as a file attachment.", "parameters": [{"name": "jobId", "in": "path", "description": "The id of the job to download results for.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/octet-stream": {"schema": {"type": "string", "format": "binary"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/{jobId}/results": {"get": {"tags": ["Job"], "summary": "Gets the results of a job as a JSON string.", "description": "For file download, use the download-results endpoint instead.", "parameters": [{"name": "jobId", "in": "path", "description": "The id of the job to get results for.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"type": "string"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/definition/{definitionId}/revision/{revisionNumber}": {"get": {"tags": ["Job"], "summary": "Gets a specific revision for a job definition.", "parameters": [{"name": "definitionId", "in": "path", "description": "The id of the job definition.", "required": true, "schema": {"type": "string"}}, {"name": "revisionNumber", "in": "path", "description": "The revision number to retrieve.", "required": true, "schema": {"type": "integer", "format": "int32"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetJobRevisionEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/{jobId}/pause": {"post": {"tags": ["Job"], "summary": "Pauses a job, stopping all of its campaigns from processing.", "parameters": [{"name": "jobId", "in": "path", "description": "The ID of the job to pause.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/jobs/aggregated-overview": {"get": {"tags": ["Job"], "summary": "Retrieves jobs aggregated by customer with total counts and most recent job information.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["amount", "-amount", "last7_days", "-last7_days", "last_job_date", "-last_job_date", "owner_mail", "-owner_mail"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "owner_mail", "in": "query", "description": "Filter by owner_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "last_job_date", "in": "query", "description": "Filter by last_job_date.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "last_job_name", "in": "query", "description": "Filter by last_job_name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryAggregatedJobsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/definitions": {"get": {"tags": ["Job"], "summary": "Queries job definitions visible to the caller.", "description": "Results are scoped to the caller's customer unless the caller is allowed to view all job definitions.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["name", "-name", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "definition_id", "in": "query", "description": "Filter by definition_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "definition_type", "in": "query", "description": "Filter by definition_type.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_id", "in": "query", "description": "Filter by owner_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_mail", "in": "query", "description": "Filter by owner_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryJobDefinitionsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/definition/{definitionId}/revisions": {"get": {"tags": ["Job"], "summary": "Queries the revisions of a specific job definition.", "parameters": [{"name": "definitionId", "in": "path", "description": "The id of the job definition.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["revision_number", "-revision_number", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "revision_number", "in": "query", "description": "Filter by revision_number.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "state", "in": "query", "description": "Filter by state.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryJobRevisionsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/jobs": {"get": {"tags": ["Job"], "summary": "Queries jobs visible to the caller.", "description": "Results are scoped to the caller's customer unless the caller is allowed to view all jobs.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["name", "-name", "created_at", "-created_at", "state", "-state", "owner_mail", "-owner_mail"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "job_definition_id", "in": "query", "description": "Filter by job_definition_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "audience_id", "in": "query", "description": "Filter by audience_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "state", "in": "query", "description": "Filter by state.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_mail", "in": "query", "description": "Filter by owner_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryJobsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/definitions/public": {"get": {"tags": ["Job"], "summary": "Queries job definitions that have been shared publicly, regardless of owner, so they can be\n reused as templates.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["name", "-name", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "definition_id", "in": "query", "description": "Filter by definition_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "definition_type", "in": "query", "description": "Filter by definition_type.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_id", "in": "query", "description": "Filter by owner_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_mail", "in": "query", "description": "Filter by owner_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryPublicJobDefinitionsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/{jobId}/resume": {"post": {"tags": ["Job"], "summary": "Resumes a job, restarting all of its campaigns.", "parameters": [{"name": "jobId", "in": "path", "description": "The ID of the job to resume.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/{jobId}/retry": {"post": {"tags": ["Job"], "summary": "Retries processing of a failed job.", "parameters": [{"name": "jobId", "in": "path", "description": "The ID of the job to retry.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/definition/{definitionId}/share": {"patch": {"tags": ["Job"], "summary": "Marks or unmarks a job definition as a public template that other users can discover and run.", "parameters": [{"name": "definitionId", "in": "path", "description": "The ID of the job definition.", "required": true, "schema": {"type": "string"}}, {"name": "isPublic", "in": "query", "description": "Whether to mark or unmark the definition as public.", "schema": {"type": "boolean", "default": true}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/job/{jobId}/share": {"patch": {"tags": ["Job"], "summary": "Marks or unmarks a job as public so its results can be shared with other users.", "parameters": [{"name": "jobId", "in": "path", "description": "The ID of the job.", "required": true, "schema": {"type": "string"}}, {"name": "isPublic", "in": "query", "description": "Whether to mark or unmark the job as public.", "schema": {"type": "boolean", "default": true}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}/approve": {"post": {"tags": ["Order"], "summary": "Approves a submitted order so the pipeline can start processing it.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order to approve.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}/clone": {"post": {"tags": ["Order"], "summary": "Clones an existing public order.", "description": "The order to clone must be marked as public.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order to clone.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The clone order details.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CloneOrderEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CloneOrderEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/complex": {"post": {"tags": ["Order"], "summary": "Creates a new order with a custom pipeline configuration.", "requestBody": {"description": "The complex order creation details.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateComplexOrderEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateComplexOrderEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order": {"post": {"tags": ["Order"], "summary": "Creates a new order with the given configuration.", "description": "Once created, use the returned dataset ID to fill the dataset with datapoints,\n then submit the order for processing.", "requestBody": {"description": "The order creation configuration.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateOrderModel"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateOrderEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/unsupported": {"post": {"tags": ["Order"], "summary": "Creates a notification for an unsupported order type.", "requestBody": {"description": "The unsupported order details.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateUnsupportedOrderEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}": {"delete": {"tags": ["Order"], "summary": "Deletes an order and its associated resources.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Order"], "summary": "Retrieves the details of a specific order.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetOrderByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "patch": {"tags": ["Order"], "summary": "Updates the name or preceding order of an order.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The properties to update.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateOrderEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}/download-results": {"get": {"tags": ["Order"], "summary": "Aggregates the results of an order and returns them as a file attachment.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/octet-stream": {"schema": {"type": "string", "format": "binary"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}/results": {"get": {"tags": ["Order"], "summary": "Aggregates the results of an order and returns them as a JSON string.", "description": "For file download, use the download-results endpoint instead.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"type": "string"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/orders/public": {"get": {"tags": ["Order"], "summary": "Retrieves all publicly available orders.", "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetPublicOrdersEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}/demo": {"patch": {"tags": ["Order"], "summary": "Marks or unmarks an order as a demo.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order.", "required": true, "schema": {"type": "string"}}, {"name": "isDemo", "in": "query", "description": "Whether to mark or unmark the order as a demo.", "schema": {"type": "boolean", "default": true}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}/pause": {"post": {"tags": ["Order"], "summary": "Pauses an order, stopping all campaigns from processing.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order to pause.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}/preview": {"post": {"tags": ["Order"], "summary": "Starts preview mode for an order so labelers' experience can be inspected.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order to preview.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Optional preview configuration.", "content": {"application/json": {"schema": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/PreviewOrderEndpoint_Input"}]}}}}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/orders/aggregated-overview": {"get": {"tags": ["Order"], "summary": "Retrieves orders aggregated by customer with total amounts and most recent order information.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["amount", "-amount", "last7_days", "-last7_days", "last_order_date", "-last_order_date", "customer_mail", "-customer_mail"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "customer_mail", "in": "query", "description": "Filter by customer_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "last_order_date", "in": "query", "description": "Filter by last_order_date.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "last_order_name", "in": "query", "description": "Filter by last_order_name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryAggregatedOrdersEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/orders": {"get": {"tags": ["Order"], "summary": "Queries orders with filtering and pagination.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["order_name", "-order_name", "order_date", "-order_date", "state", "-state"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "order_name", "in": "query", "description": "Filter by order_name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "state", "in": "query", "description": "Filter by state.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "order_date", "in": "query", "description": "Filter by order_date.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "customer_mail", "in": "query", "description": "Filter by customer_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "is_public", "in": "query", "description": "Filter by is_public.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryOrdersEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}/resume": {"post": {"tags": ["Order"], "summary": "Resumes a paused order, restarting all campaigns.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order to resume.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}/retry": {"post": {"tags": ["Order"], "summary": "Retries processing of a failed order.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order to retry.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}/share": {"patch": {"tags": ["Order"], "summary": "Marks or unmarks an order as public.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order.", "required": true, "schema": {"type": "string"}}, {"name": "isPublic", "in": "query", "description": "Whether to mark or unmark the order as public.", "schema": {"type": "boolean", "default": true}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}/submit": {"post": {"tags": ["Order"], "summary": "Submits an order for processing.", "description": "Once submitted, the order will be locked and no further changes can be made.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order to submit.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Optional submission configuration.", "content": {"application/json": {"schema": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/SubmitOrderEndpoint_Input"}]}}}}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/order/{orderId}/unlock": {"post": {"tags": ["Order"], "summary": "Unlocks a cloned order so it can be modified.", "description": "Unlocking clones the entire dataset and its datapoints.", "parameters": [{"name": "orderId", "in": "path", "description": "The ID of the order to unlock.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnlockOrderEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/pipeline/{pipelineId}": {"get": {"tags": ["Pipeline"], "summary": "Gets a pipeline by its id.", "parameters": [{"name": "pipelineId", "in": "path", "description": "The id of the pipeline to get.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetPipelineByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/pipeline/preliminary-download/{preliminaryDownloadId}": {"get": {"tags": ["Pipeline"], "summary": "Streams the preliminary download file when ready.", "description": "Returns 202 while the download is still processing.", "parameters": [{"name": "preliminaryDownloadId", "in": "path", "description": "The id of the preliminary download to get.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"type": "string"}}}}, "202": {"description": "Accepted"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/pipeline/{pipelineId}/preliminary-download": {"post": {"tags": ["Pipeline"], "summary": "Initiates a preliminary download of the pipeline.", "parameters": [{"name": "pipelineId", "in": "path", "description": "The id of the pipeline to initiate the download for.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Whether to email the caller when the download is ready.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/StartPreliminaryDownloadEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/StartPreliminaryDownloadEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/demographic": {"post": {"tags": ["CustomerRapid"], "summary": "Creates a new demographic rapid.", "requestBody": {"description": "The demographic rapid payload.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateDemographicRapidEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateDemographicRapidEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/{rapidId}": {"delete": {"tags": ["CustomerRapid"], "summary": "Deletes a rapid.", "parameters": [{"name": "rapidId", "in": "path", "description": "The id of the rapid to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/global-responses": {"get": {"tags": ["CustomerRapid"], "summary": "Gets the most recent public responses across all customers.", "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetGlobalResponsesEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/{rapidId}/responses": {"get": {"tags": ["CustomerRapid"], "summary": "Gets all responses for a given rapid.", "parameters": [{"name": "rapidId", "in": "path", "description": "The rapid to get the responses for.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetResponsesForRapidEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapids/flagged": {"get": {"tags": ["CustomerRapid"], "summary": "Queries all rapids that have been flagged.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "completed_at", "-completed_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "correlation_id", "in": "query", "description": "Filter by correlation_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_id", "in": "query", "description": "Filter by owner_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "key", "in": "query", "description": "Filter by key.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "completed_at", "in": "query", "description": "Filter by completed_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryFlaggedRapidsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/{correlationId}/validation-potential": {"get": {"tags": ["CustomerRapid"], "summary": "Queries rapids that may be eligible for validation-set creation.", "parameters": [{"name": "correlationId", "in": "path", "description": "The correlation id whose rapids should be considered.", "required": true, "schema": {"type": "string"}}, {"name": "minResponses", "in": "query", "description": "The minimum response count for a rapid to qualify.", "schema": {"type": "integer", "format": "int32"}}, {"name": "minConfidence", "in": "query", "description": "The minimum confidence for a rapid to qualify.", "schema": {"type": "number", "format": "double"}}, {"name": "targetGroupId", "in": "query", "description": "An optional subgroup of rapids to restrict the query to.", "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "rapid_id", "in": "query", "description": "Filter by rapid_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "response_count", "in": "query", "description": "Filter by response_count.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "confidence", "in": "query", "description": "Filter by confidence.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryValidationRapidEligibilityEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/{rapidId}/unflag": {"post": {"tags": ["CustomerRapid"], "summary": "Unflags a flagged rapid.", "description": "The rapid is returned to the active labeling pool and cannot be flagged again.", "parameters": [{"name": "rapidId", "in": "path", "description": "The id of the rapid to unflag.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/validation/{rapidId}": {"patch": {"tags": ["CustomerRapid"], "summary": "Updates the validation information of a rapid.", "parameters": [{"name": "rapidId", "in": "path", "description": "The id of the rapid to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The fields to update.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateValidationRapidEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/global-text": {"post": {"tags": ["GlobalText"], "summary": "Creates a new global text entry.", "requestBody": {"description": "The payload describing the entry to create.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateGlobalTextEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateGlobalTextEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["GlobalText"], "summary": "Returns every global text entry.", "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetAllGlobalTextsEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/global-text/{globalTextId}": {"delete": {"tags": ["GlobalText"], "summary": "Deletes a global text entry.", "parameters": [{"name": "globalTextId", "in": "path", "description": "The id of the global text entry to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "patch": {"tags": ["GlobalText"], "summary": "Updates a global text entry using patch semantics.", "parameters": [{"name": "globalTextId", "in": "path", "description": "The id of the global text entry to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The patch payload describing which fields should change.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateGlobalTextEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/{rapidId}/reject": {"post": {"tags": ["Rapid"], "summary": "Rejects a completed rapid, marking its results as invalid.", "description": "The rapid must be in the Done state. Rejection propagates staleness to dependent entities.", "parameters": [{"name": "rapidId", "in": "path", "description": "The identifier of the rapid to reject.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/response": {"post": {"tags": ["UserRapid"], "summary": "Submits a response for a rapid.", "requestBody": {"description": "The submitted result and session index.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AddUserResponseEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AddUserResponseEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/report/{reportId}": {"get": {"tags": ["UserRapid"], "summary": "Inspects a report's dump so that it can be replayed or restored.", "parameters": [{"name": "reportId", "in": "path", "description": "The id of the report to inspect.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InspectReportEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/rapid-bag/is-valid": {"get": {"tags": ["UserRapid"], "summary": "Returns whether the rapid bag associated with the current user is still valid.", "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IsRapidBagValidEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/{rapidId}/report": {"post": {"tags": ["UserRapid"], "summary": "Reports an issue with a rapid.", "parameters": [{"name": "rapidId", "in": "path", "description": "The rapid to report.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The report payload.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReportRapidEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/skip": {"post": {"tags": ["UserRapid"], "summary": "Records that the user skipped the specified rapid.", "requestBody": {"description": "The id of the rapid being skipped and the session index.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SkipRapidEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SkipRapidEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/rapid/{rapidId}/validation-feedback": {"post": {"tags": ["ValidationFeedback"], "summary": "Submits feedback for a validation rapid outcome.", "parameters": [{"name": "rapidId", "in": "path", "description": "The ID of the rapid to provide feedback for.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The feedback input.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateValidationFeedbackEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["ValidationFeedback"], "summary": "Queries validation feedbacks for a rapid.", "parameters": [{"name": "rapidId", "in": "path", "description": "The ID of the rapid to query feedbacks for.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "user_id", "in": "query", "description": "Filter by user_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "feedback", "in": "query", "description": "Filter by feedback.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryValidationFeedbacksEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/signal": {"post": {"tags": ["Signal"], "summary": "Creates a new signal.", "requestBody": {"description": "The payload describing the signal to create.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSignalEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSignalEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Signal"], "summary": "Queries the signals visible to the current caller.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "name", "-name", "created_at", "-created_at", "next_run_at", "-next_run_at", "last_run_at", "-last_run_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_id", "in": "query", "description": "Filter by owner_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "audience_id", "in": "query", "description": "Filter by audience_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "job_definition_id", "in": "query", "description": "Filter by job_definition_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "is_paused", "in": "query", "description": "Filter by is_paused.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "is_public", "in": "query", "description": "Filter by is_public.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "next_run_at", "in": "query", "description": "Filter by next_run_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QuerySignalsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/signal/{signalId}": {"delete": {"tags": ["Signal"], "summary": "Deletes a signal by its id.", "description": "Soft-deleted signals (and every run they spawned) are hidden from all view / list\n endpoints \u2014 including admin endpoints \u2014 per the cascade policy.", "parameters": [{"name": "signalId", "in": "path", "description": "The id of the signal to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Signal"], "summary": "Gets a signal by its id.", "parameters": [{"name": "signalId", "in": "path", "description": "The id of the signal to retrieve.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetSignalByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "patch": {"tags": ["Signal"], "summary": "Updates a signal using patch semantics.", "parameters": [{"name": "signalId", "in": "path", "description": "The id of the signal to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The patch payload describing which fields should change.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateSignalEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/signal/run/{runId}": {"get": {"tags": ["Signal"], "summary": "Gets a single signal run by its id.", "parameters": [{"name": "runId", "in": "path", "description": "The id of the run to retrieve.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetSignalRunByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/signal/{signalId}/pause": {"post": {"tags": ["Signal"], "summary": "Pauses a signal.", "description": "Manual triggers still fire on a paused signal \u2014 pause only affects the scheduler.", "parameters": [{"name": "signalId", "in": "path", "description": "The id of the signal to pause.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/signal/{signalId}/run": {"get": {"tags": ["Signal"], "summary": "Queries the runs spawned by a signal.", "parameters": [{"name": "signalId", "in": "path", "description": "The id of the signal whose runs to query.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["started_at", "-started_at", "completed_at", "-completed_at", "status", "-status"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "status", "in": "query", "description": "Filter by status.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "trigger_source", "in": "query", "description": "Filter by trigger_source.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "started_at", "in": "query", "description": "Filter by started_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "completed_at", "in": "query", "description": "Filter by completed_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "audience_job_id", "in": "query", "description": "Filter by audience_job_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QuerySignalRunsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/signal/{signalId}/resume": {"post": {"tags": ["Signal"], "summary": "Resumes a paused signal.", "parameters": [{"name": "signalId", "in": "path", "description": "The id of the signal to resume.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/signal/{signalId}/trigger": {"post": {"tags": ["Signal"], "summary": "Manually triggers a signal.", "description": "Manual triggers fire even when the signal is paused. They are queued via the broker\n and will be skipped (with a recorded reason) if another run is already in flight.", "parameters": [{"name": "signalId", "in": "path", "description": "The id of the signal to trigger.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TriggerSignalEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/translation/ensure-english": {"post": {"tags": ["Translation"], "summary": "Ensures the provided text is in English, returning a suggested English text when it isn't.", "requestBody": {"description": "The text to verify.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EnsureEnglishEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EnsureEnglishEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/translation": {"post": {"tags": ["Translation"], "summary": "Translates text from one language to another using the specified translator.", "requestBody": {"description": "The translation request body.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TranslateEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TranslateEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-set/{validationSetId}/rapid": {"post": {"tags": ["ValidationSet"], "summary": "Adds a new validation rapid to a validation set using a JSON body.", "parameters": [{"name": "validationSetId", "in": "path", "description": "The validation set to add a rapid to.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The validation rapid data including asset, payload, and metadata.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AddValidationRapidEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-set": {"post": {"tags": ["ValidationSet"], "summary": "Creates a new empty validation set.", "requestBody": {"description": "The body describing the validation set to create.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateValidationSetEndpoint_Input"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateValidationSetEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-set/{validationSetId}": {"delete": {"tags": ["ValidationSet"], "summary": "Deletes a validation set by id.", "parameters": [{"name": "validationSetId", "in": "path", "description": "The id of the validation set to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["ValidationSet"], "summary": "Gets a validation set by id.", "parameters": [{"name": "validationSetId", "in": "path", "description": "The id of the validation set to get.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetValidationSetByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "patch": {"tags": ["ValidationSet"], "summary": "Updates different characteristics of a validation set using patch semantics.", "parameters": [{"name": "validationSetId", "in": "path", "description": "The id of the validation set to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The patch payload describing which fields should change.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateValidationSetEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-set/{validationSetId}/export": {"get": {"tags": ["ValidationSet"], "summary": "Exports all rapids of a validation set to a file.", "parameters": [{"name": "validationSetId", "in": "path", "description": "The id of the validation set to export.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-sets/available": {"get": {"tags": ["ValidationSet"], "summary": "Gets the available validation sets for the current user.", "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetAvailableValidationSetsEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-sets/compatible": {"get": {"tags": ["ValidationSet"], "summary": "Gets all validation sets available to the user that a rapid with the provided parameters can be added to.", "description": "Matching is strict: a validation set is only returned when its asset type, modality, and prompt type\n equal the provided parameters exactly \u2014 the same constraint enforced when actually adding a rapid.\n This differs from /validation-set/recommended, which uses loose overlap matching and may return\n sets that then reject the rapid. Returns an empty array when no compatible set exists.", "parameters": [{"name": "assetType", "in": "query", "description": "The asset type that the validation set must contain.\n An asset type can be an image, video, audio, text, or any combination of these.", "schema": {"$ref": "#/components/schemas/AssetType"}}, {"name": "modality", "in": "query", "description": "The rapid modality that the validation set must contain.\n The modality is the type of rapid such as classify, compare, locate, etc.", "schema": {"$ref": "#/components/schemas/RapidModality"}}, {"name": "promptType", "in": "query", "description": "The prompt type that the validation set must contain.\n A prompt type is the additional information that is presented to the user when solving a rapid.\n For example, a prompt type can be either text or an asset if the context is an image or video.", "schema": {"$ref": "#/components/schemas/PromptType"}}, {"name": "instruction", "in": "query", "description": "An instruction used to find validation sets that have the same instruction.\n An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.", "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetCompatibleValidationSetsEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-set/recommended": {"get": {"tags": ["ValidationSet"], "summary": "Gets a validation set that is available to the user and best matches the provided parameters.", "parameters": [{"name": "assetType", "in": "query", "description": "The types of assets that the validation set should contain.\n An asset type can be an image, video, audio, text, or any combination of these.\n \n This parameter is a flag, meaning that it can be null or contain multiple values.\n If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.", "schema": {"$ref": "#/components/schemas/AssetType"}}, {"name": "modality", "in": "query", "description": "The rapid modalities that the validation set should contain.\n The modality is the type of rapid such as classify, compare, locate, etc.\n \n This parameter is a flag, meaning that it can be null or contain multiple values.\n If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.", "schema": {"$ref": "#/components/schemas/RapidModality"}}, {"name": "promptType", "in": "query", "description": "The prompt types that the validation set should contain.\n A prompt type is the additional information that is presented to the user when solving a rapid.\n For example, a prompt type can be either text or an asset if the context is an image or video.\n \n This parameter is a flag, meaning that it can be null or contain multiple values.\n If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.", "schema": {"$ref": "#/components/schemas/PromptType"}}, {"name": "instruction", "in": "query", "description": "An instruction used to find validation sets that have similar instructions.\n An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.", "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetRecommendedValidationSetEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-set/{validationSetId}/rapids": {"get": {"tags": ["ValidationSet"], "summary": "Queries the validation rapids for a specific validation set.", "parameters": [{"name": "validationSetId", "in": "path", "description": "The validation set to query.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "correct_validation_count", "-correct_validation_count", "invalid_validation_count", "-invalid_validation_count"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "type", "in": "query", "description": "Filter by type.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "state", "in": "query", "description": "Filter by state.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetValidationRapidsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-sets": {"get": {"tags": ["ValidationSet"], "summary": "Queries available validation sets based on the provided filter, paging and sorting criteria.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["name", "-name", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "asset_type", "in": "query", "description": "Filter by asset_type.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "modality", "in": "query", "description": "Filter by modality.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "prompt_type", "in": "query", "description": "Filter by prompt_type.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "is_public", "in": "query", "description": "Filter by is_public.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_id", "in": "query", "description": "Filter by owner_id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_mail", "in": "query", "description": "Filter by owner_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "created_at", "in": "query", "description": "Filter by created_at.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryValidationSetsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-set/{validationSetId}/update-labeling-hints": {"post": {"tags": ["ValidationSet"], "summary": "Refreshes the labeling hints for a validation set.", "description": "This endpoint is a no-op. Labeling hints are now managed automatically.", "parameters": [{"name": "validationSetId", "in": "path", "description": "The id of the validation set to update the labeling hints for.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-set/{validationSetId}/dimensions": {"patch": {"tags": ["ValidationSet"], "summary": "Updates the dimensions of all rapids within a validation set.", "parameters": [{"name": "validationSetId", "in": "path", "description": "The id of the validation set to update the dimensions for.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The body describing the new dimensions.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateValidationSetDimensionsEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-set/{validationSetId}/shouldAlert": {"patch": {"tags": ["ValidationSet"], "summary": "Updates the shouldAlert field on all rapids within a validation set.", "parameters": [{"name": "validationSetId", "in": "path", "description": "The id of the validation set to update.", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The body describing the new shouldAlert value.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateValidationSetShouldAlertEndpoint_Input"}}}, "required": true}, "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/validation-set/{validationSetId}/visibility": {"patch": {"tags": ["ValidationSet"], "summary": "Updates the visibility of a validation set.", "description": "Public validation sets are used to automatically add a validation set to an order if no validation set is specified.", "parameters": [{"name": "validationSetId", "in": "path", "description": "The id of the validation set to update the visibility for.", "required": true, "schema": {"type": "string"}}, {"name": "isPublic", "in": "query", "description": "Whether the validation set should be public or private.", "required": true, "schema": {"type": "boolean"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/workflow/evaluation/{workflowId}/results": {"get": {"tags": ["Evaluation"], "summary": "Gets the results for an evaluation workflow.", "parameters": [{"name": "workflowId", "in": "path", "description": "The ID of the workflow to get the results for.", "required": true, "schema": {"type": "string"}}, {"name": "states", "in": "query", "description": "Optional list of rapid states to filter by. If not provided, all states are included.", "schema": {"type": "array", "items": {"$ref": "#/components/schemas/RapidState"}}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id"], "type": "string"}}, "x-parameter-group": "sort"}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetWorkflowResultsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/workflow/grouped-ranking/{workflowId}/results": {"get": {"tags": ["GroupedRanking"], "summary": "Gets the result overview for a grouped ranking workflow.", "parameters": [{"name": "workflowId", "in": "path", "description": "The ID of the workflow to get the results for.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["name", "-name", "state", "-state", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "state", "in": "query", "description": "Filter by state.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetGroupedRankingWorkflowResultsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/workflow/compare/{workflowId}/results": {"get": {"tags": ["Ranking"], "summary": "Gets the result overview for a ranking workflow.", "parameters": [{"name": "workflowId", "in": "path", "description": "The ID of the workflow to get the results for.", "required": true, "schema": {"type": "string"}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "score", "-score"], "type": "string"}}, "x-parameter-group": "sort"}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetRankingWorkflowResultsEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/workflow/simple/{workflowId}/results": {"get": {"tags": ["SimpleWorkflow"], "summary": "Gets the result overview for a simple workflow.", "parameters": [{"name": "workflowId", "in": "path", "description": "The ID of the workflow to get the results for.", "required": true, "schema": {"type": "string"}}, {"name": "states", "in": "query", "description": "Optional list of rapid states to include in the results.", "schema": {"type": "array", "items": {"$ref": "#/components/schemas/RapidState"}}}, {"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["id", "-id", "state", "-state", "decisiveness", "-decisiveness"], "type": "string"}}, "x-parameter-group": "sort"}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetSimpleWorkflowResultsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/workflow/{workflowId}": {"delete": {"tags": ["Workflow"], "summary": "Deletes a workflow by its id.", "parameters": [{"name": "workflowId", "in": "path", "description": "The ID of the workflow to delete.", "required": true, "schema": {"type": "string"}}], "responses": {"204": {"description": "No Content"}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}, "get": {"tags": ["Workflow"], "summary": "Returns the workflow identified by .", "parameters": [{"name": "workflowId", "in": "path", "description": "Identifier of the workflow to fetch.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetWorkflowByIdEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/workflow/{workflowId}/compare-ab-summary": {"get": {"tags": ["Workflow"], "summary": "Returns the number of times each asset index won across the workflow's rapids.", "parameters": [{"name": "workflowId", "in": "path", "description": "The ID of the workflow to get the summary for.", "required": true, "schema": {"type": "string"}}, {"name": "useUserScore", "in": "query", "description": "Whether to use the user score to determine the winner.", "schema": {"type": "boolean", "default": false}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetCompareAbSummaryEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/workflow/{workflowId}/progress": {"get": {"tags": ["Workflow"], "summary": "Gets the progress of a workflow.", "parameters": [{"name": "workflowId", "in": "path", "description": "The ID of the workflow to get the progress for.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetWorkflowProgressEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/workflow/{workflowId}/responses": {"get": {"tags": ["Workflow"], "summary": "Gets the most recent or oldest responses for a workflow, across any rapid.", "parameters": [{"name": "workflowId", "in": "path", "description": "The ID of the workflow to get the responses for.", "required": true, "schema": {"type": "string"}}, {"name": "limit", "in": "query", "description": "The maximum number of responses to return.", "schema": {"type": "integer", "format": "int32", "default": 100}}, {"name": "sort", "in": "query", "description": "Whether the oldest or most recent responses should be returned.", "schema": {"$ref": "#/components/schemas/SortDirection"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetWorkflowResponsesEndpoint_Output"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}, "/workflows": {"get": {"tags": ["Workflow"], "summary": "Queries workflows based on the provided filter, page, and sort criteria.", "parameters": [{"name": "page", "in": "query", "description": "The 1-based page index.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "page_size", "in": "query", "description": "The number of items per page.", "schema": {"type": "integer"}, "x-parameter-group": "page"}, {"name": "sort", "in": "query", "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", "schema": {"type": "array", "items": {"enum": ["name", "-name", "state", "-state", "created_at", "-created_at"], "type": "string"}}, "x-parameter-group": "sort"}, {"name": "id", "in": "query", "description": "Filter by id.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "name", "in": "query", "description": "Filter by name.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "state", "in": "query", "description": "Filter by state.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "owner_mail", "in": "query", "description": "Filter by owner_mail.", "style": "deepObject", "explode": true, "schema": {"type": "object", "properties": {"eq": {"type": "string"}, "neq": {"type": "string"}, "gt": {"type": "string"}, "gte": {"type": "string"}, "lt": {"type": "string"}, "lte": {"type": "string"}, "contains": {"type": "string"}, "starts_with": {"type": "string"}, "ends_with": {"type": "string"}, "in": {"type": "string"}, "not_contains": {"type": "string"}}}, "x-parameter-group": "filters"}, {"name": "logic", "in": "query", "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", "schema": {"enum": ["and", "or"], "type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryWorkflowsEndpoint_PagedResultOfOutput"}}}}, "400": {"description": "Bad Request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ValidationProblemDetails"}}}}, "401": {"description": "Unauthenticated"}, "403": {"description": "Forbidden"}}, "security": [{"OpenIdConnect": ["openid", "profile", "email", "offline_access"]}]}}}, "components": {"schemas": {"BatchUploadStatus": {"enum": ["Processing", "Completed", "Aborted"]}, "BatchUploadUrlStatus": {"enum": ["Pending", "Completed", "Failed"]}, "CompressionOverride": {"type": "object", "properties": {"enabled": {"type": "boolean", "nullable": true}, "quality": {"type": "integer", "format": "int32", "nullable": true}, "maxDimension": {"type": "integer", "format": "int32", "nullable": true}}}, "CreateBatchUploadEndpoint_Input": {"required": ["urls"], "type": "object", "properties": {"urls": {"allOf": [{"type": "array", "items": {"type": "string", "format": "uri"}}], "description": "The URLs to download and process."}, "correlationId": {"type": "string", "description": "Optional client-supplied identifier to group related batch uploads.", "nullable": true}, "compression": {"allOf": [{"$ref": "#/components/schemas/CompressionOverride"}], "description": "Optional per-call override for image compression applied to every URL in the batch.\n Null means use the configured defaults."}}}, "CreateBatchUploadEndpoint_Output": {"required": ["batchUploadId"], "type": "object", "properties": {"batchUploadId": {"type": "string", "description": "The identifier of the created batch upload."}}}, "GetBatchUploadResultEndpoint_Output": {"required": ["batchUploadId", "status", "totalCount", "completedCount", "failedCount", "items"], "type": "object", "properties": {"batchUploadId": {"type": "string", "description": "The identifier of the batch upload."}, "status": {"allOf": [{"$ref": "#/components/schemas/BatchUploadStatus"}], "description": "The current status of the batch upload."}, "totalCount": {"type": "integer", "description": "The total number of URLs in the batch.", "format": "int32"}, "completedCount": {"type": "integer", "description": "The number of URLs that have been successfully processed.", "format": "int32"}, "failedCount": {"type": "integer", "description": "The number of URLs that failed to process.", "format": "int32"}, "items": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetBatchUploadResultEndpoint_UrlOutput"}}], "description": "The individual results for each URL in the batch."}}}, "GetBatchUploadResultEndpoint_UrlOutput": {"required": ["url", "status"], "type": "object", "properties": {"url": {"type": "string"}, "fileName": {"type": "string", "nullable": true}, "status": {"$ref": "#/components/schemas/BatchUploadUrlStatus"}, "errorMessage": {"type": "string", "nullable": true}}}, "GetBatchUploadStatusEndpoint_Output": {"required": ["status", "totalCount", "completedCount", "failedCount", "completedBatches"], "type": "object", "properties": {"status": {"allOf": [{"$ref": "#/components/schemas/BatchUploadStatus"}], "description": "The aggregated status across all queried batch uploads."}, "totalCount": {"type": "integer", "description": "The total number of URLs across all queried batches.", "format": "int32"}, "completedCount": {"type": "integer", "description": "The number of URLs that have been successfully processed.", "format": "int32"}, "failedCount": {"type": "integer", "description": "The number of URLs that failed to process.", "format": "int32"}, "completedBatches": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The identifiers of batch uploads that have fully completed."}}}, "IFormFile": {"type": "string", "format": "binary"}, "UploadFileEndpoint_Output": {"required": ["fileName", "warnings", "wasCompressed"], "type": "object", "properties": {"fileName": {"type": "string", "description": "The generated file name used internally to reference the uploaded asset.\n This is not the original file name and should be used for all subsequent operations on this asset."}, "warnings": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "Any warnings that might have occurred during the upload."}, "wasCompressed": {"type": "boolean", "description": "Whether the uploaded file was compressed during processing."}, "originalSizeBytes": {"type": "integer", "description": "The original size of the uploaded file in bytes, if available. This may be null if the size could not be determined.", "format": "int64", "nullable": true}, "finalSizeBytes": {"type": "integer", "description": "The final size of the stored file in bytes after processing (e.g., compression), if available.\n This may be null if the size could not be determined. If compression was applied, this size may be smaller than the original size.", "format": "int64", "nullable": true}}}, "UploadFileFromUrlEndpoint_Output": {"required": ["fileName", "warnings", "wasCompressed"], "type": "object", "properties": {"fileName": {"type": "string", "description": "The generated file name used internally to reference the uploaded asset.\n This is not the original file name and should be used for all subsequent operations on this asset."}, "warnings": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "Any warnings that might have occurred during the upload."}, "wasCompressed": {"type": "boolean", "description": "Whether the uploaded file was compressed during processing."}, "originalSizeBytes": {"type": "integer", "description": "The original size of the uploaded file in bytes, if available. This may be null if the size could not be determined.", "format": "int64", "nullable": true}, "finalSizeBytes": {"type": "integer", "description": "The final size of the stored file in bytes after processing (e.g., compression), if available.\n This may be smaller than the original size if compression was applied.", "format": "int64", "nullable": true}}}, "ValidationProblemDetails": {"type": "object", "properties": {"type": {"type": "string", "nullable": true}, "title": {"type": "string", "nullable": true}, "status": {"type": "integer", "format": "int32", "nullable": true}, "detail": {"type": "string", "nullable": true}, "instance": {"type": "string", "nullable": true}, "errors": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}}}, "AddExampleToAudienceEndpoint_Input": {"required": ["asset", "payload", "randomCorrectProbability"], "type": "object", "properties": {"asset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "The asset to use for the example."}, "payload": {"allOf": [{"$ref": "#/components/schemas/IExamplePayload"}], "description": "The payload to use for the example."}, "truth": {"allOf": [{"$ref": "#/components/schemas/IExampleTruth"}], "description": "The ground truth for the example."}, "randomCorrectProbability": {"type": "number", "description": "The probability for an answer to be correct when randomly guessing.", "format": "double"}, "explanation": {"type": "string", "description": "An explanation for the users if they answer the example incorrectly.", "nullable": true}, "context": {"type": "string", "description": "An optional textual context that provides additional information to the user.", "nullable": true}, "contextAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "An optional asset that provides additional context to the user."}, "sortIndex": {"type": "integer", "description": "The sort index that controls the serving order of this example within the audience.\n When null, the next sort index is automatically calculated.", "format": "int32", "nullable": true}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}, "nullable": true}], "description": "The feature flags to enable for the example."}, "isCommonSense": {"type": "boolean", "description": "Whether this example should be treated as commonsense validation.\n When true, incorrect answers are not accepted and the example affects global score.\n When null, AI auto-detection will determine if the example is common sense.", "nullable": true}, "visibility": {"allOf": [{"$ref": "#/components/schemas/ExampleVisibility"}], "description": "Controls who can see this example. Public examples are visible to all customers.\n Private examples are only visible to the customer who created them and admins.\n Defaults to Private."}}, "description": "Input model for adding an example to an audience."}, "AddExampleToAudienceEndpoint_Output": {"type": "object", "properties": {"recalculationId": {"type": "string", "description": "The id of the audience state recalculation dispatched as a result of adding this example.\n Null when the example addition cannot transition any user's state (e.g. the audience\n already has more examples than MaxDistillingResponses + 1).", "nullable": true}}}, "AudienceInactivitySyncPhase": {"enum": ["MarkingInactiveUsers", "Finalizing", "Done"]}, "AudienceInactivitySyncState": {"enum": ["Pending", "Processing", "Completed", "Failed", "Aborted"]}, "AudienceJobState": {"enum": ["Submitted", "Running", "Completed", "Failed", "ManualApproval", "Queued", "Paused", "StaleResults", "SpendLimited"]}, "AudienceStateRecalculationPhase": {"enum": ["RecalculatingUsers", "Finalizing", "Done"]}, "AudienceStateRecalculationState": {"enum": ["Pending", "Processing", "Completed", "Failed", "Aborted"]}, "AudienceStatus": {"enum": ["Created", "Pending", "Recruiting", "Ready"]}, "BoostLevel": {"enum": ["None", "Stable", "Distilling", "Global"]}, "ChangeAudienceOwnerEndpoint_Input": {"required": ["ownerId", "ownerMail"], "type": "object", "properties": {"ownerId": {"type": "string", "description": "The unique identifier of the new owner.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The email address of the new owner."}}}, "CreateAudienceEndpoint_Input": {"required": ["name"], "type": "object", "properties": {"name": {"type": "string", "description": "The name to give the newly created audience."}, "description": {"type": "string", "description": "An optional markdown-supported description of the audience's purpose.", "nullable": true}, "filters": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/IAudienceFilter"}, "nullable": true}], "description": "The filters to apply to any orders created for this audience.\n A filter can be used to restrict the audience to a specific subset of users."}, "graduationScore": {"type": "number", "description": "The score used to determine whether a user graduates from the distilling campaign.", "format": "double", "nullable": true}, "demotionScore": {"type": "number", "description": "Score below which a graduated user is demoted back to distilling.\n Must be less than or equal to GraduationScore. Defaults to null (uses GraduationScore).", "format": "double", "nullable": true}, "minimumSizeForActivation": {"type": "integer", "description": "The minimum number of users required for an audience to be activated.", "format": "int64", "nullable": true}, "logo": {"allOf": [{"$ref": "#/components/schemas/ExistingAssetInput"}], "description": "An optional logo image for the audience. Must be an existing image asset."}, "maxDistillingResponses": {"type": "integer", "description": "Maximum responses before user exits the distilling campaign.\n Defaults to 10. Set to null to disable this exit condition.", "format": "uint32", "nullable": true}, "minResponsesToGraduate": {"type": "integer", "description": "Minimum responses required before a user can graduate into the audience.\n Even if the user's score is at or above the graduation threshold, they will\n remain in distilling until they have answered at least this many responses.\n Must be strictly less than MaxDistillingResponses when both are set.\n Defaults to null (no minimum \u2014 users graduate as soon as the score is reached).", "format": "uint32", "nullable": true}, "dropMinResponses": {"type": "integer", "description": "Minimum responses before the drop score check applies.\n Users need at least this many responses before they can be kicked out for low score.\n Defaults to 3. Set to null to apply drop score check from the first response.", "format": "uint32", "nullable": true}, "dropScore": {"type": "number", "description": "Score floor - users below this score exit the distilling campaign\n (only after completing DropMinResponses).\n Defaults to 0.2. Set to null to disable this exit condition.", "format": "double", "nullable": true}, "isDistillingCampaignSticky": {"type": "boolean", "description": "Whether the distilling campaign should be sticky (users stay until filters don't match).\n Defaults to true (Temporary sticky)."}, "maxDistillingSessions": {"type": "integer", "description": "Maximum sessions (rapid retrievals) before user exits the distilling campaign.\n Defaults to null (disabled). Set to a value to enable session-based exit condition.", "format": "uint32", "nullable": true}, "inactivityDropDays": {"type": "integer", "description": "Number of days of inactivity before a distilling user is dropped.\n Defaults to null (disabled).", "format": "uint32", "nullable": true}, "minSubmissionRate": {"type": "number", "description": "Minimum submission rate (responses / sessions) before a user is dropped.\n Defaults to null (disabled).", "format": "double", "nullable": true}, "minSessionsForSubmissionRate": {"type": "integer", "description": "Minimum number of sessions before the submission rate check applies.\n Defaults to null (applies from first session).", "format": "uint32", "nullable": true}, "minSubmissionRateGraduated": {"type": "number", "description": "Minimum submission rate for graduated users. If null, MinSubmissionRate applies to graduated users.\n Set a lower value to be more lenient with graduated users.", "format": "double", "nullable": true}, "distillingRetrievalMode": {"allOf": [{"$ref": "#/components/schemas/RetrievalMode"}], "description": "The retrieval mode used by the distilling campaign to select rapids for users.\n Defaults to Shuffled."}, "minDistillingForGlobalBoost": {"type": "integer", "description": "Minimum distilling users before disabling global boost.\n Defaults to 200. Admin-only override.", "format": "int32", "nullable": true}, "minGraduatedForDistillingBoost": {"type": "integer", "description": "Minimum graduated users before disabling distilling boost.\n Defaults to 100. Admin-only override.", "format": "int32", "nullable": true}}}, "CreateAudienceEndpoint_Output": {"required": ["audienceId"], "type": "object", "properties": {"audienceId": {"type": "string", "description": "The unique identifier of the newly created audience."}}}, "CreateFilteredAudienceEndpoint_Input": {"required": ["filter"], "type": "object", "properties": {"filter": {"allOf": [{"$ref": "#/components/schemas/IAudienceFilter"}], "description": "The filter that restricts the base audience's graduates to a subset (e.g. by language,\n country or demographic value). Multiple criteria can be combined with And / Or / Not."}}}, "CreateFilteredAudienceEndpoint_Output": {"required": ["audienceId"], "type": "object", "properties": {"audienceId": {"type": "string", "description": "The unique identifier of the filtered audience. Use this id in job creation."}}}, "DeleteAudienceExampleEndpoint_Output": {"type": "object", "properties": {"recalculationId": {"type": "string", "description": "The id of the audience state recalculation dispatched as a result of this deletion.\n Null when the deletion cannot transition any user's state (e.g. the audience still has\n more examples than MaxDistillingResponses + 1 after the delete).", "nullable": true}}}, "ExampleBoxShape": {"type": "object", "properties": {"xMin": {"type": "number", "format": "double", "nullable": true}, "yMin": {"type": "number", "format": "double", "nullable": true}, "xMax": {"type": "number", "format": "double", "nullable": true}, "yMax": {"type": "number", "format": "double", "nullable": true}}}, "ExampleCategory": {"required": ["label", "value"], "type": "object", "properties": {"label": {"type": "string"}, "value": {"type": "string"}}}, "ExampleScrubRange": {"required": ["start", "end"], "type": "object", "properties": {"start": {"type": "integer", "format": "int32"}, "end": {"type": "integer", "format": "int32"}}}, "ExampleTranscriptionWord": {"required": ["word", "wordIndex"], "type": "object", "properties": {"word": {"type": "string"}, "wordIndex": {"type": "integer", "format": "int32"}}}, "ExampleVisibility": {"enum": ["Private", "Public"]}, "ExistingAssetInput": {"required": ["name"], "type": "object", "properties": {"name": {"type": "string"}, "metadata": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/MetadataInputCollection"}]}, "identifier": {"type": "string", "nullable": true}}}, "FeatureFlag": {"required": ["key", "value"], "type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string"}}}, "FileType": {"enum": ["Unknown", "Image", "Video", "Audio"]}, "GetAudienceByIdEndpoint_Output": {"required": ["id", "name", "status", "qualifiedUserCount", "filters", "createdAt", "ownerId", "ownerMail", "isPublic", "isDistilling", "distillingCampaignId", "graduationScore", "distillingRetrievalMode", "boostLevel"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the audience."}, "name": {"type": "string", "description": "The name of the audience."}, "description": {"type": "string", "description": "The markdown-supported description of the audience.", "nullable": true}, "status": {"allOf": [{"$ref": "#/components/schemas/AudienceStatus"}], "description": "The current status of the audience."}, "qualifiedUserCount": {"type": "integer", "description": "The number of users that have qualified for this audience.", "format": "int64"}, "filters": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/IAudienceFilter"}}], "description": "The filters applied to this audience."}, "logo": {"type": "string", "description": "The URL of the audience logo, if any.", "nullable": true}, "createdAt": {"type": "string", "description": "The timestamp when the audience was created.", "format": "date-time"}, "ownerId": {"type": "string", "description": "The unique identifier of the audience owner.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The email of the audience owner."}, "isPublic": {"type": "boolean", "description": "Whether the audience is publicly visible."}, "isDistilling": {"type": "boolean", "description": "Whether the audience is currently distilling users."}, "distillingCampaignId": {"type": "string", "description": "The id of the distilling campaign associated with the audience."}, "minGraduatedForDistillingBoost": {"type": "integer", "description": "Minimum graduated users before disabling distilling boost.", "format": "int32", "nullable": true}, "minDistillingForGlobalBoost": {"type": "integer", "description": "Minimum distilling users before disabling global boost.", "format": "int32", "nullable": true}, "graduationScore": {"type": "number", "description": "The score used to determine whether a user graduates from the distilling campaign.", "format": "double"}, "demotionScore": {"type": "number", "description": "Score below which a graduated user is demoted back to distilling.", "format": "double", "nullable": true}, "maxDistillingResponses": {"type": "integer", "description": "Maximum responses before user exits the distilling campaign.", "format": "uint32", "nullable": true}, "minResponsesToGraduate": {"type": "integer", "description": "Minimum responses required before a user can graduate into the audience.\n Even if the user's score is at or above the graduation threshold, they will\n remain in distilling until they have answered at least this many responses.\n Null when no minimum is configured.", "format": "uint32", "nullable": true}, "dropMinResponses": {"type": "integer", "description": "Minimum responses before the drop score check applies.", "format": "uint32", "nullable": true}, "dropScore": {"type": "number", "description": "Score floor - users below this score exit the distilling campaign.", "format": "double", "nullable": true}, "maxDistillingSessions": {"type": "integer", "description": "Maximum sessions before user exits the distilling campaign.", "format": "uint32", "nullable": true}, "inactivityDropDays": {"type": "integer", "description": "Number of days of inactivity before a distilling user is dropped.", "format": "uint32", "nullable": true}, "minSubmissionRate": {"type": "number", "description": "Minimum submission rate before a user is dropped.", "format": "double", "nullable": true}, "minSessionsForSubmissionRate": {"type": "integer", "description": "Minimum number of sessions before the submission rate check applies.", "format": "uint32", "nullable": true}, "minSubmissionRateGraduated": {"type": "number", "description": "Minimum submission rate for graduated users.", "format": "double", "nullable": true}, "distillingRetrievalMode": {"allOf": [{"$ref": "#/components/schemas/RetrievalMode"}], "description": "The retrieval mode used by the distilling campaign to select rapids for users."}, "boostLevel": {"allOf": [{"$ref": "#/components/schemas/BoostLevel"}], "description": "The current boost level applied to the audience."}, "randomAdmissionProbability": {"type": "number", "description": "The probability of admitting a random user to the audience.", "format": "double", "nullable": true}, "health": {"type": "number", "description": "The health score of the audience.", "format": "double", "nullable": true}, "graduated": {"type": "integer", "description": "The number of graduated users.", "format": "int64"}, "dropped": {"type": "integer", "description": "The number of dropped users.", "format": "int64"}}}, "GetAudienceInactivitySyncByIdEndpoint_Output": {"required": ["id", "audienceId", "state", "phase", "cutoff", "processedCount", "changedCount", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the inactivity sync."}, "audienceId": {"type": "string", "description": "The audience this inactivity sync belongs to."}, "state": {"allOf": [{"$ref": "#/components/schemas/AudienceInactivitySyncState"}], "description": "The current state of the inactivity sync."}, "phase": {"allOf": [{"$ref": "#/components/schemas/AudienceInactivitySyncPhase"}], "description": "The current phase within the inactivity sync lifecycle."}, "cutoff": {"type": "string", "description": "The cutoff captured at run creation time. Users with last_seen_at older than this are marked inactive.", "format": "date-time"}, "lastProcessedUserId": {"type": "string", "description": "The id of the last user that was processed (progress cursor).", "nullable": true}, "processedCount": {"type": "integer", "description": "The number of users processed so far.", "format": "int64"}, "changedCount": {"type": "integer", "description": "The number of users whose state was changed by the sync.", "format": "int64"}, "errorMessage": {"type": "string", "description": "Error message populated when the sync transitioned to Failed.", "nullable": true}, "startedAt": {"type": "string", "description": "When the sync began processing (null while still Pending).", "format": "date-time", "nullable": true}, "lastHeartbeatAt": {"type": "string", "description": "Timestamp of the last heartbeat received from the worker.", "format": "date-time", "nullable": true}, "completedAt": {"type": "string", "description": "When the sync reached a terminal state (Completed, Failed, Aborted).", "format": "date-time", "nullable": true}, "createdAt": {"type": "string", "description": "When the sync was created.", "format": "date-time"}}}, "GetAudienceStateRecalculationByIdEndpoint_Output": {"required": ["id", "audienceId", "state", "phase", "processedCount", "changedCount", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the recalculation."}, "audienceId": {"type": "string", "description": "The audience this recalculation belongs to."}, "state": {"allOf": [{"$ref": "#/components/schemas/AudienceStateRecalculationState"}], "description": "The current state of the recalculation."}, "phase": {"allOf": [{"$ref": "#/components/schemas/AudienceStateRecalculationPhase"}], "description": "The current phase within the recalculation lifecycle."}, "lastProcessedUserId": {"type": "string", "description": "The id of the last user that was processed (progress cursor).", "nullable": true}, "processedCount": {"type": "integer", "description": "The number of users processed so far.", "format": "int64"}, "changedCount": {"type": "integer", "description": "The number of users whose state was changed by the recalculation.", "format": "int64"}, "errorMessage": {"type": "string", "description": "Error message populated when the recalculation transitioned to Failed.", "nullable": true}, "startedAt": {"type": "string", "description": "When the recalculation began processing (null while still Pending).", "format": "date-time", "nullable": true}, "lastHeartbeatAt": {"type": "string", "description": "Timestamp of the last heartbeat received from the worker.", "format": "date-time", "nullable": true}, "completedAt": {"type": "string", "description": "When the recalculation reached a terminal state (Completed, Failed, Aborted).", "format": "date-time", "nullable": true}, "createdAt": {"type": "string", "description": "When the recalculation was created.", "format": "date-time"}}}, "GetAudienceUserStateMetricsResult": {"required": ["usersPerState"], "type": "object", "properties": {"usersPerState": {"type": "object", "additionalProperties": {"type": "integer", "format": "int32"}}}}, "GetLatestAudienceInactivitySyncEndpoint_Output": {"required": ["id", "audienceId", "state", "phase", "cutoff", "processedCount", "changedCount", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the inactivity sync."}, "audienceId": {"type": "string", "description": "The audience this inactivity sync belongs to."}, "state": {"allOf": [{"$ref": "#/components/schemas/AudienceInactivitySyncState"}], "description": "The current state of the inactivity sync."}, "phase": {"allOf": [{"$ref": "#/components/schemas/AudienceInactivitySyncPhase"}], "description": "The current phase within the inactivity sync lifecycle."}, "cutoff": {"type": "string", "description": "The cutoff captured at run creation time. Users with last_seen_at older than this are marked inactive.", "format": "date-time"}, "lastProcessedUserId": {"type": "string", "description": "The id of the last user that was processed (progress cursor).", "nullable": true}, "processedCount": {"type": "integer", "description": "The number of users processed so far.", "format": "int64"}, "changedCount": {"type": "integer", "description": "The number of users whose state was changed by the sync.", "format": "int64"}, "errorMessage": {"type": "string", "description": "Error message populated when the sync transitioned to Failed.", "nullable": true}, "startedAt": {"type": "string", "description": "When the sync began processing (null while still Pending).", "format": "date-time", "nullable": true}, "lastHeartbeatAt": {"type": "string", "description": "Timestamp of the last heartbeat received from the worker.", "format": "date-time", "nullable": true}, "completedAt": {"type": "string", "description": "When the sync reached a terminal state (Completed, Failed, Aborted).", "format": "date-time", "nullable": true}, "createdAt": {"type": "string", "description": "When the sync was created.", "format": "date-time"}}}, "GetLatestAudienceStateRecalculationEndpoint_Output": {"required": ["id", "audienceId", "state", "phase", "processedCount", "changedCount", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the recalculation."}, "audienceId": {"type": "string", "description": "The audience this recalculation belongs to."}, "state": {"allOf": [{"$ref": "#/components/schemas/AudienceStateRecalculationState"}], "description": "The current state of the recalculation."}, "phase": {"allOf": [{"$ref": "#/components/schemas/AudienceStateRecalculationPhase"}], "description": "The current phase within the recalculation lifecycle."}, "lastProcessedUserId": {"type": "string", "description": "The id of the last user that was processed (progress cursor).", "nullable": true}, "processedCount": {"type": "integer", "description": "The number of users processed so far.", "format": "int64"}, "changedCount": {"type": "integer", "description": "The number of users whose state was changed by the recalculation.", "format": "int64"}, "errorMessage": {"type": "string", "description": "Error message populated when the recalculation transitioned to Failed.", "nullable": true}, "startedAt": {"type": "string", "description": "When the recalculation began processing (null while still Pending).", "format": "date-time", "nullable": true}, "lastHeartbeatAt": {"type": "string", "description": "Timestamp of the last heartbeat received from the worker.", "format": "date-time", "nullable": true}, "completedAt": {"type": "string", "description": "When the recalculation reached a terminal state (Completed, Failed, Aborted).", "format": "date-time", "nullable": true}, "createdAt": {"type": "string", "description": "When the recalculation was created.", "format": "date-time"}}}, "IAssetInput": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IAssetInputExistingAssetInput"}, {"$ref": "#/components/schemas/IAssetInputMultiAssetInput"}, {"$ref": "#/components/schemas/IAssetInputTextAssetInput"}], "discriminator": {"propertyName": "_t", "mapping": {"ExistingAssetInput": "#/components/schemas/IAssetInputExistingAssetInput", "MultiAssetInput": "#/components/schemas/IAssetInputMultiAssetInput", "TextAssetInput": "#/components/schemas/IAssetInputTextAssetInput"}}}, "IAssetInputExistingAssetInput": {"required": ["name", "_t"], "properties": {"_t": {"enum": ["ExistingAssetInput"], "type": "string"}, "name": {"type": "string"}, "metadata": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/MetadataInputCollection"}]}, "identifier": {"type": "string", "nullable": true}}}, "IAssetInputMultiAssetInput": {"required": ["assets", "_t"], "properties": {"_t": {"enum": ["MultiAssetInput"], "type": "string"}, "assets": {"type": "array", "items": {"$ref": "#/components/schemas/IAssetInput"}}, "metadata": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/MetadataInputCollection"}]}, "identifier": {"type": "string", "nullable": true}}}, "IAssetInputTextAssetInput": {"required": ["text", "_t"], "properties": {"_t": {"enum": ["TextAssetInput"], "type": "string"}, "text": {"type": "string"}, "metadata": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/MetadataInputCollection"}]}, "identifier": {"type": "string", "nullable": true}}}, "IAssetModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IAssetModelFileAssetModel"}, {"$ref": "#/components/schemas/IAssetModelMultiAssetModel"}, {"$ref": "#/components/schemas/IAssetModelNullAssetModel"}, {"$ref": "#/components/schemas/IAssetModelTextAssetModel"}], "discriminator": {"propertyName": "_t", "mapping": {"FileAsset": "#/components/schemas/IAssetModelFileAssetModel", "MultiAsset": "#/components/schemas/IAssetModelMultiAssetModel", "NullAsset": "#/components/schemas/IAssetModelNullAssetModel", "TextAsset": "#/components/schemas/IAssetModelTextAssetModel"}}}, "IAssetModelFileAssetModel": {"required": ["fileName", "metadata", "identifier", "_t"], "properties": {"_t": {"enum": ["FileAsset"], "type": "string"}, "fileName": {"type": "string"}, "metadata": {"$ref": "#/components/schemas/MetadataModelCollection"}, "identifier": {"type": "string"}}}, "IAssetModelMultiAssetModel": {"required": ["assets", "metadata", "identifier", "_t"], "properties": {"_t": {"enum": ["MultiAsset"], "type": "string"}, "assets": {"type": "array", "items": {"$ref": "#/components/schemas/IAssetModel"}}, "metadata": {"$ref": "#/components/schemas/MetadataModelCollection"}, "identifier": {"type": "string"}}}, "IAssetModelNullAssetModel": {"required": ["metadata", "identifier", "_t"], "properties": {"_t": {"enum": ["NullAsset"], "type": "string"}, "metadata": {"$ref": "#/components/schemas/MetadataModelCollection"}, "identifier": {"type": "string"}}}, "IAssetModelTextAssetModel": {"required": ["text", "metadata", "identifier", "_t"], "properties": {"_t": {"enum": ["TextAsset"], "type": "string"}, "text": {"type": "string"}, "metadata": {"$ref": "#/components/schemas/MetadataModelCollection"}, "identifier": {"type": "string"}}}, "IAudienceFilter": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IAudienceFilterAndAudienceFilter"}, {"$ref": "#/components/schemas/IAudienceFilterCountryAudienceFilter"}, {"$ref": "#/components/schemas/IAudienceFilterDemographicAudienceFilter"}, {"$ref": "#/components/schemas/IAudienceFilterLanguageAudienceFilter"}, {"$ref": "#/components/schemas/IAudienceFilterNotAudienceFilter"}, {"$ref": "#/components/schemas/IAudienceFilterOrAudienceFilter"}], "discriminator": {"propertyName": "_t", "mapping": {"AndFilter": "#/components/schemas/IAudienceFilterAndAudienceFilter", "CountryFilter": "#/components/schemas/IAudienceFilterCountryAudienceFilter", "DemographicFilter": "#/components/schemas/IAudienceFilterDemographicAudienceFilter", "LanguageFilter": "#/components/schemas/IAudienceFilterLanguageAudienceFilter", "NotFilter": "#/components/schemas/IAudienceFilterNotAudienceFilter", "OrFilter": "#/components/schemas/IAudienceFilterOrAudienceFilter"}}}, "IAudienceFilterAndAudienceFilter": {"required": ["filters", "_t"], "properties": {"_t": {"enum": ["AndFilter"], "type": "string"}, "filters": {"type": "array", "items": {"$ref": "#/components/schemas/IAudienceFilter"}}}}, "IAudienceFilterCountryAudienceFilter": {"required": ["countries", "_t"], "properties": {"_t": {"enum": ["CountryFilter"], "type": "string"}, "countries": {"type": "array", "items": {"type": "string"}}}}, "IAudienceFilterDemographicAudienceFilter": {"required": ["identifier", "values", "_t"], "properties": {"_t": {"enum": ["DemographicFilter"], "type": "string"}, "identifier": {"type": "string"}, "values": {"type": "array", "items": {"type": "string"}}}}, "IAudienceFilterLanguageAudienceFilter": {"required": ["languages", "_t"], "properties": {"_t": {"enum": ["LanguageFilter"], "type": "string"}, "languages": {"type": "array", "items": {"type": "string"}}}}, "IAudienceFilterNotAudienceFilter": {"required": ["filter", "_t"], "properties": {"_t": {"enum": ["NotFilter"], "type": "string"}, "filter": {"$ref": "#/components/schemas/IAudienceFilter"}}}, "IAudienceFilterOrAudienceFilter": {"required": ["filters", "_t"], "properties": {"_t": {"enum": ["OrFilter"], "type": "string"}, "filters": {"type": "array", "items": {"$ref": "#/components/schemas/IAudienceFilter"}}}}, "IExamplePayload": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IExamplePayloadClassifyExamplePayload"}, {"$ref": "#/components/schemas/IExamplePayloadCompareExamplePayload"}, {"$ref": "#/components/schemas/IExamplePayloadLineExamplePayload"}, {"$ref": "#/components/schemas/IExamplePayloadLocateExamplePayload"}, {"$ref": "#/components/schemas/IExamplePayloadScrubExamplePayload"}, {"$ref": "#/components/schemas/IExamplePayloadTranscriptionExamplePayload"}], "discriminator": {"propertyName": "_t", "mapping": {"ClassifyExamplePayload": "#/components/schemas/IExamplePayloadClassifyExamplePayload", "CompareExamplePayload": "#/components/schemas/IExamplePayloadCompareExamplePayload", "LineExamplePayload": "#/components/schemas/IExamplePayloadLineExamplePayload", "LocateExamplePayload": "#/components/schemas/IExamplePayloadLocateExamplePayload", "ScrubExamplePayload": "#/components/schemas/IExamplePayloadScrubExamplePayload", "TranscriptionExamplePayload": "#/components/schemas/IExamplePayloadTranscriptionExamplePayload"}}}, "IExamplePayloadClassifyExamplePayload": {"required": ["categories", "title", "_t"], "properties": {"_t": {"enum": ["ClassifyExamplePayload"], "type": "string"}, "categories": {"type": "array", "items": {"$ref": "#/components/schemas/ExampleCategory"}}, "title": {"type": "string"}}}, "IExamplePayloadCompareExamplePayload": {"required": ["criteria", "_t"], "properties": {"_t": {"enum": ["CompareExamplePayload"], "type": "string"}, "criteria": {"type": "string"}}}, "IExamplePayloadLineExamplePayload": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["LineExamplePayload"], "type": "string"}, "target": {"type": "string"}}}, "IExamplePayloadLocateExamplePayload": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["LocateExamplePayload"], "type": "string"}, "target": {"type": "string"}}}, "IExamplePayloadScrubExamplePayload": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["ScrubExamplePayload"], "type": "string"}, "target": {"type": "string"}}}, "IExamplePayloadTranscriptionExamplePayload": {"required": ["title", "transcription", "_t"], "properties": {"_t": {"enum": ["TranscriptionExamplePayload"], "type": "string"}, "title": {"type": "string"}, "transcription": {"type": "array", "items": {"$ref": "#/components/schemas/ExampleTranscriptionWord"}}}}, "IExampleTruth": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IExampleTruthClassifyExampleTruth"}, {"$ref": "#/components/schemas/IExampleTruthCompareExampleTruth"}, {"$ref": "#/components/schemas/IExampleTruthLineExampleTruth"}, {"$ref": "#/components/schemas/IExampleTruthLocateExampleTruth"}, {"$ref": "#/components/schemas/IExampleTruthScrubExampleTruth"}, {"$ref": "#/components/schemas/IExampleTruthTranscriptionExampleTruth"}], "discriminator": {"propertyName": "_t", "mapping": {"ClassifyExampleTruth": "#/components/schemas/IExampleTruthClassifyExampleTruth", "CompareExampleTruth": "#/components/schemas/IExampleTruthCompareExampleTruth", "LineExampleTruth": "#/components/schemas/IExampleTruthLineExampleTruth", "LocateExampleTruth": "#/components/schemas/IExampleTruthLocateExampleTruth", "ScrubExampleTruth": "#/components/schemas/IExampleTruthScrubExampleTruth", "TranscriptionExampleTruth": "#/components/schemas/IExampleTruthTranscriptionExampleTruth"}}}, "IExampleTruthClassifyExampleTruth": {"required": ["correctCategories", "_t"], "properties": {"_t": {"enum": ["ClassifyExampleTruth"], "type": "string"}, "correctCategories": {"type": "array", "items": {"type": "string"}}}}, "IExampleTruthCompareExampleTruth": {"required": ["winnerId", "_t"], "properties": {"_t": {"enum": ["CompareExampleTruth"], "type": "string"}, "winnerId": {"type": "string"}}}, "IExampleTruthLineExampleTruth": {"required": ["_t"], "properties": {"_t": {"enum": ["LineExampleTruth"], "type": "string"}, "boundingBoxes": {"type": "array", "items": {"$ref": "#/components/schemas/ExampleBoxShape"}, "nullable": true}, "requiredPrecision": {"type": "number", "format": "double", "nullable": true}, "requiredCompleteness": {"type": "number", "format": "double", "nullable": true}}}, "IExampleTruthLocateExampleTruth": {"required": ["boundingBoxes", "_t"], "properties": {"_t": {"enum": ["LocateExampleTruth"], "type": "string"}, "boundingBoxes": {"type": "array", "items": {"$ref": "#/components/schemas/ExampleBoxShape"}}, "requiredPrecision": {"type": "number", "format": "double", "nullable": true}, "requiredCompleteness": {"type": "number", "format": "double", "nullable": true}}}, "IExampleTruthScrubExampleTruth": {"required": ["validRanges", "_t"], "properties": {"_t": {"enum": ["ScrubExampleTruth"], "type": "string"}, "validRanges": {"type": "array", "items": {"$ref": "#/components/schemas/ExampleScrubRange"}}}}, "IExampleTruthTranscriptionExampleTruth": {"required": ["correctWords", "_t"], "properties": {"_t": {"enum": ["TranscriptionExampleTruth"], "type": "string"}, "correctWords": {"type": "array", "items": {"$ref": "#/components/schemas/ExampleTranscriptionWord"}}, "strictGrading": {"type": "boolean", "nullable": true}, "requiredPrecision": {"type": "number", "format": "double", "nullable": true}, "requiredCompleteness": {"type": "number", "format": "double", "nullable": true}}}, "IMetadataInput": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IMetadataInputTextMetadataInput"}], "discriminator": {"propertyName": "_t", "mapping": {"TextMetadataInput": "#/components/schemas/IMetadataInputTextMetadataInput"}}}, "IMetadataInputTextMetadataInput": {"required": ["text", "visibilities", "_t"], "properties": {"_t": {"enum": ["TextMetadataInput"], "type": "string"}, "text": {"type": "string", "nullable": true}, "visibilities": {"$ref": "#/components/schemas/MetadataVisibilities"}}}, "IMetadataModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IMetadataModelClassificationMetadataModel"}, {"$ref": "#/components/schemas/IMetadataModelCountMetadataModel"}, {"$ref": "#/components/schemas/IMetadataModelFileTypeMetadataModel"}, {"$ref": "#/components/schemas/IMetadataModelImageDimensionMetadataModel"}, {"$ref": "#/components/schemas/IMetadataModelLocationMetadataModel"}, {"$ref": "#/components/schemas/IMetadataModelOriginalFilenameMetadataModel"}, {"$ref": "#/components/schemas/IMetadataModelSourceUrlMetadataModel"}, {"$ref": "#/components/schemas/IMetadataModelStreamsMetadataModel"}, {"$ref": "#/components/schemas/IMetadataModelTextMetadataModel"}, {"$ref": "#/components/schemas/IMetadataModelVideoDurationMetadataModel"}], "discriminator": {"propertyName": "_t", "mapping": {"ClassificationMetadata": "#/components/schemas/IMetadataModelClassificationMetadataModel", "CountMetadata": "#/components/schemas/IMetadataModelCountMetadataModel", "FileTypeMetadata": "#/components/schemas/IMetadataModelFileTypeMetadataModel", "ImageDimensionMetadata": "#/components/schemas/IMetadataModelImageDimensionMetadataModel", "LocationMetadata": "#/components/schemas/IMetadataModelLocationMetadataModel", "OriginalFilenameMetadata": "#/components/schemas/IMetadataModelOriginalFilenameMetadataModel", "SourceUrlMetadataModel": "#/components/schemas/IMetadataModelSourceUrlMetadataModel", "StreamsMetadata": "#/components/schemas/IMetadataModelStreamsMetadataModel", "TextMetadata": "#/components/schemas/IMetadataModelTextMetadataModel", "VideoDurationMetadata": "#/components/schemas/IMetadataModelVideoDurationMetadataModel"}}}, "IMetadataModelClassificationMetadataModel": {"required": ["classification", "_t"], "properties": {"_t": {"enum": ["ClassificationMetadata"], "type": "string"}, "classification": {"type": "string"}}}, "IMetadataModelCountMetadataModel": {"required": ["count", "_t"], "properties": {"_t": {"enum": ["CountMetadata"], "type": "string"}, "count": {"type": "integer", "format": "int32"}}}, "IMetadataModelFileTypeMetadataModel": {"required": ["fileType", "_t"], "properties": {"_t": {"enum": ["FileTypeMetadata"], "type": "string"}, "fileType": {"$ref": "#/components/schemas/FileType"}}}, "IMetadataModelImageDimensionMetadataModel": {"required": ["_t"], "properties": {"_t": {"enum": ["ImageDimensionMetadata"], "type": "string"}, "height": {"type": "integer", "format": "int32"}, "width": {"type": "integer", "format": "int32"}}}, "IMetadataModelLocationMetadataModel": {"required": ["x", "y", "_t"], "properties": {"_t": {"enum": ["LocationMetadata"], "type": "string"}, "x": {"type": "number", "format": "float"}, "y": {"type": "number", "format": "float"}}}, "IMetadataModelOriginalFilenameMetadataModel": {"required": ["originalFilename", "_t"], "properties": {"_t": {"enum": ["OriginalFilenameMetadata"], "type": "string"}, "originalFilename": {"type": "string"}}}, "IMetadataModelSourceUrlMetadataModel": {"required": ["url", "_t"], "properties": {"_t": {"enum": ["SourceUrlMetadataModel"], "type": "string"}, "url": {"type": "string"}}}, "IMetadataModelStreamsMetadataModel": {"required": ["hasVideo", "hasAudio", "hasSubtitles", "_t"], "properties": {"_t": {"enum": ["StreamsMetadata"], "type": "string"}, "hasVideo": {"type": "boolean"}, "hasAudio": {"type": "boolean"}, "hasSubtitles": {"type": "boolean"}}}, "IMetadataModelTextMetadataModel": {"required": ["text", "_t"], "properties": {"_t": {"enum": ["TextMetadata"], "type": "string"}, "text": {"type": "string", "nullable": true}}}, "IMetadataModelVideoDurationMetadataModel": {"required": ["duration", "_t"], "properties": {"_t": {"enum": ["VideoDurationMetadata"], "type": "string"}, "duration": {"type": "string", "format": "date-time"}}}, "MetadataInputCollection": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/IMetadataInput"}}, "MetadataModelCollection": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/IMetadataModel"}}, "MetadataVisibilities": {"type": "array", "items": {"enum": ["None", "Users", "Customers", "Admins", "Dashboard", "All"], "type": "string"}}, "QueryAudienceJobsEndpoint_Output": {"required": ["jobId", "name", "definitionId", "audienceId", "revisionNumber", "pipelineId", "state", "createdAt"], "type": "object", "properties": {"jobId": {"type": "string", "description": "The unique identifier of the job."}, "name": {"type": "string", "description": "The name of the job."}, "definitionId": {"type": "string", "description": "The identifier of the job definition."}, "audienceId": {"type": "string", "description": "The identifier of the audience the job belongs to."}, "revisionNumber": {"type": "integer", "description": "The revision number of the job definition.", "format": "int32"}, "pipelineId": {"type": "string", "description": "The identifier of the pipeline executing the job."}, "state": {"allOf": [{"$ref": "#/components/schemas/AudienceJobState"}], "description": "The current status of the job."}, "createdAt": {"type": "string", "description": "The timestamp when the job was created.", "format": "date-time"}}}, "QueryAudienceJobsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryAudienceJobsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryAudiencesEndpoint_Output": {"required": ["id", "name", "status", "qualifiedUserCount", "filters", "createdAt", "ownerMail", "isPublic", "isDistilling"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the audience."}, "name": {"type": "string", "description": "The name of the audience."}, "description": {"type": "string", "description": "The markdown-supported description of the audience.", "nullable": true}, "status": {"allOf": [{"$ref": "#/components/schemas/AudienceStatus"}], "description": "The current status of the audience."}, "qualifiedUserCount": {"type": "integer", "description": "The number of users that have qualified for this audience.", "format": "int64"}, "filters": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/IAudienceFilter"}}], "description": "The filters applied to this audience."}, "logo": {"type": "string", "description": "The URL of the audience logo, if any.", "nullable": true}, "createdAt": {"type": "string", "description": "The timestamp when the audience was created.", "format": "date-time"}, "ownerMail": {"type": "string", "description": "The email of the audience owner."}, "isPublic": {"type": "boolean", "description": "Whether the audience is publicly visible."}, "isDistilling": {"type": "boolean", "description": "Whether the audience is currently distilling users."}, "randomAdmissionProbability": {"type": "number", "description": "The probability of admitting a random user to the audience.", "format": "double", "nullable": true}, "health": {"type": "number", "description": "The health score of the audience.", "format": "double", "nullable": true}, "graduated": {"type": "integer", "description": "The number of graduated users.", "format": "int64"}, "dropped": {"type": "integer", "description": "The number of dropped users.", "format": "int64"}}}, "QueryAudiencesEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryAudiencesEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryExamplesForAudienceEndpoint_Output": {"required": ["id", "asset", "payload", "correctCount", "incorrectCount"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the example."}, "rapidId": {"type": "string", "description": "The ID of the rapid associated with this example.", "nullable": true}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The asset associated with this example."}, "payload": {"allOf": [{"$ref": "#/components/schemas/IExamplePayload"}], "description": "The payload of the example."}, "correctCount": {"type": "integer", "description": "The number of correct responses.", "format": "int32"}, "incorrectCount": {"type": "integer", "description": "The number of incorrect responses.", "format": "int32"}, "truth": {"allOf": [{"$ref": "#/components/schemas/IExampleTruth"}], "description": "The truth value of the example."}, "context": {"type": "string", "description": "The context text for the example.", "nullable": true}, "contextAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The context asset for the example."}, "explanation": {"type": "string", "description": "The explanation for the example.", "nullable": true}, "randomCorrectProbability": {"type": "number", "description": "The probability of a random correct answer.", "format": "double"}, "isCommonSense": {"type": "boolean", "description": "Whether this example is common sense.", "nullable": true}, "sortIndex": {"type": "integer", "description": "The sort index that controls serving order.", "format": "int32"}, "visibility": {"allOf": [{"$ref": "#/components/schemas/ExampleVisibility"}], "description": "The visibility of this example. Public examples are visible to all customers."}}}, "QueryExamplesForAudienceEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryExamplesForAudienceEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "RecreateExternalAudiencesEndpoint_Input": {"required": ["recreateAll"], "type": "object", "properties": {"recreateAll": {"type": "boolean", "description": "Whether to recreate all 3 external audiences or only the missing ones."}}}, "RetrievalMode": {"enum": ["Random", "Shuffled", "Sequential"]}, "StartAudienceInactivitySyncEndpoint_Output": {"required": ["syncId"], "type": "object", "properties": {"syncId": {"type": "string", "description": "The id of the inactivity sync that was started or reused."}}}, "StartAudienceStateRecalculationEndpoint_Output": {"required": ["recalculationId"], "type": "object", "properties": {"recalculationId": {"type": "string", "description": "The id of the recalculation that was started or reused."}}}, "UpdateAudienceEndpoint_Input": {"type": "object", "properties": {"name": {"type": "string", "description": "The new name to give to this audience."}, "description": {"type": "string", "description": "The new description for the audience. Supports markdown. Set to null to remove.", "nullable": true}, "filters": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/IAudienceFilter"}}], "description": "The new filters to apply to any orders created for this audience.\n A filter can be used to restrict the audience to a specific subset of users."}, "logo": {"oneOf": [{"$ref": "#/components/schemas/ExistingAssetInput"}, {"nullable": true}], "description": "The new logo image for the audience. Must be an existing image asset.\n Set to null to remove the logo."}, "minGraduatedForDistillingBoost": {"type": "integer", "description": "Minimum graduated users before disabling distilling boost.\n When graduated count is below this, external distilling audience ID is added to campaign boosting.", "format": "int32", "nullable": true}, "minDistillingForGlobalBoost": {"type": "integer", "description": "Minimum distilling users before disabling global boost.\n When distilling count is below this, GlobalBoostLevel is set above zero.", "format": "int32", "nullable": true}, "graduationScore": {"type": "number", "description": "The score used to determine whether a user graduates from the distilling campaign.", "format": "double"}, "demotionScore": {"type": "number", "description": "Score below which a graduated user is demoted back to distilling.\n Must be less than or equal to GraduationScore. Set to null to use GraduationScore.", "format": "double", "nullable": true}, "maxDistillingResponses": {"type": "integer", "description": "Maximum responses before user exits the distilling campaign.\n Set to null to disable this exit condition.", "format": "uint32", "nullable": true}, "minResponsesToGraduate": {"type": "integer", "description": "Minimum responses required before a user can graduate into the audience.\n Even if the user's score is at or above the graduation threshold, they will\n remain in distilling until they have answered at least this many responses.\n Must be strictly less than MaxDistillingResponses when both are set.\n Set to null to allow graduation as soon as the score is reached.", "format": "uint32", "nullable": true}, "dropMinResponses": {"type": "integer", "description": "Minimum responses before the drop score check applies.\n Users need at least this many responses before they can be kicked out for low score.\n Set to null to apply drop score check from the first response.", "format": "uint32", "nullable": true}, "dropScore": {"type": "number", "description": "Score floor - users below this score exit the distilling campaign\n (only after completing DropMinResponses).\n Set to null to disable this exit condition.", "format": "double", "nullable": true}, "maxDistillingSessions": {"type": "integer", "description": "Maximum sessions (rapid retrievals) before user exits the distilling campaign.\n Set to a value to enable session-based exit condition.", "format": "uint32", "nullable": true}, "inactivityDropDays": {"type": "integer", "description": "Number of days of inactivity before a distilling user is dropped.\n Set to null to disable this exit condition.", "format": "uint32", "nullable": true}, "minSubmissionRate": {"type": "number", "description": "Minimum submission rate (responses / sessions) before a user is dropped.\n Set to null to disable this exit condition.", "format": "double", "nullable": true}, "minSessionsForSubmissionRate": {"type": "integer", "description": "Minimum number of sessions before the submission rate check applies.\n Set to null to apply from the first session.", "format": "uint32", "nullable": true}, "minSubmissionRateGraduated": {"type": "number", "description": "Minimum submission rate for graduated users. If null, MinSubmissionRate applies to graduated users.\n Set a lower value to be more lenient with graduated users.", "format": "double", "nullable": true}, "distillingRetrievalMode": {"allOf": [{"$ref": "#/components/schemas/RetrievalMode"}], "description": "The retrieval mode used by the distilling campaign to select rapids for users."}}}, "UpdateAudienceEndpoint_Output": {"type": "object", "properties": {"recalculationId": {"type": "string", "description": "The id of the audience state recalculation that was dispatched as a result of this update.\n Only populated when state-affecting parameters (e.g. graduation score, drop score) changed;\n null when the update only touched descriptive fields or boost configuration.", "nullable": true}, "inactivitySyncId": {"type": "string", "description": "The id of the audience inactivity sync that was dispatched as a result of this update.\n Only populated when InactivityDropDays was changed to a non-null value; null otherwise.", "nullable": true}}}, "UpdateAudienceExampleEndpoint_Input": {"type": "object", "properties": {"truth": {"oneOf": [{"$ref": "#/components/schemas/IExampleTruth"}, {"nullable": true}], "description": "The truth for the example."}, "explanation": {"type": "string", "description": "The optional explanation that will be shown to the user when answering wrong.", "nullable": true}, "context": {"type": "string", "description": "An optional text context that will be shown to the user.", "nullable": true}, "contextAsset": {"oneOf": [{"$ref": "#/components/schemas/IAssetInput"}, {"nullable": true}], "description": "An optional asset that will be used as context to show to the user."}, "randomCorrectProbability": {"type": "number", "description": "The probability that if the user answers at random that they'll be correct.", "format": "double", "nullable": true}, "isCommonSense": {"type": "boolean", "description": "Whether this example should be treated as commonsense validation.", "nullable": true}, "sortIndex": {"type": "integer", "description": "The sort index that controls the serving order of this example.", "format": "int32"}, "visibility": {"allOf": [{"$ref": "#/components/schemas/ExampleVisibility"}], "description": "Controls who can see this example. Public examples are visible to all customers.\n Private examples are only visible to the customer who created them and admins."}}, "description": "Input model for updating an audience example."}, "UpdateBoostConfigEndpoint_Input": {"type": "object", "properties": {"minDistillingForGlobalBoost": {"type": "integer", "description": "Minimum number of distilling users required to activate global boost.", "format": "int32", "nullable": true}, "minGraduatedForDistillingBoost": {"type": "integer", "description": "Minimum number of graduated users required to activate distilling boost.", "format": "int32", "nullable": true}}}, "UpdateBoostConfigEndpoint_Output": {"type": "object", "properties": {"recalculationId": {"type": "string", "description": "The id of the audience state recalculation dispatched by this update.\n Boost-only updates do not trigger a recalculation, so this is typically null.", "nullable": true}}}, "AudienceBoostModel": {"required": ["externalAudienceId", "level"], "type": "object", "properties": {"externalAudienceId": {"type": "integer", "format": "int32"}, "level": {"type": "integer", "format": "int32"}}}, "BoostingControlMode": {"enum": ["Manual", "Automatic"]}, "BoostingProfileModel": {"required": ["globalBoostLevel", "prospectBlacklist", "distillingBoosts", "labelingBoosts"], "type": "object", "properties": {"globalBoostLevel": {"type": "integer", "format": "int32"}, "minAutoAdjustLevel": {"type": "integer", "format": "int32", "nullable": true}, "maxAutoAdjustLevel": {"type": "integer", "format": "int32", "nullable": true}, "prospectBlacklist": {"type": "array", "items": {"type": "integer", "format": "int32"}}, "distillingBoosts": {"type": "array", "items": {"$ref": "#/components/schemas/AudienceBoostModel"}}, "labelingBoosts": {"type": "array", "items": {"$ref": "#/components/schemas/AudienceBoostModel"}}}}, "BoostMode": {"enum": ["Automatic", "Manual"]}, "BoostStatusModel": {"enum": ["Active", "Inactive", "Partial", "Unknown"]}, "CampaignStatusModel": {"enum": ["Created", "Preview", "Active", "Analysis", "Paused", "Completed", "SpendLimited"]}, "ChangeBoostEndpoint_Input": {"required": ["isManual"], "type": "object", "properties": {"isManual": {"type": "boolean", "description": "Whether the manual overwrite should be applied."}, "level": {"type": "integer", "description": "The boost level. Takes precedence over IsActive when set.", "format": "int32", "nullable": true}}}, "ComparisonOperator": {"enum": ["Equal", "NotEqual", "LessThan", "LessThanOrEqual", "GreaterThan", "GreaterThanOrEqual"]}, "DeviceType": {"enum": ["Unknown", "Phone", "Tablet"]}, "GetBoostInsightsEndpoint_AudienceOutput": {"required": ["externalAudienceId", "contributors"], "type": "object", "properties": {"externalAudienceId": {"type": "integer", "format": "int32"}, "contributors": {"type": "array", "items": {"$ref": "#/components/schemas/GetBoostInsightsEndpoint_ContributorOutput"}}}}, "GetBoostInsightsEndpoint_ContributorOutput": {"required": ["campaignId", "campaignName"], "type": "object", "properties": {"campaignId": {"type": "string"}, "campaignName": {"type": "string"}}}, "GetBoostInsightsEndpoint_GlobalBoostOutput": {"required": ["effectiveLevel", "contributors"], "type": "object", "properties": {"effectiveLevel": {"type": "integer", "format": "int32"}, "contributors": {"type": "array", "items": {"$ref": "#/components/schemas/GetBoostInsightsEndpoint_LevelContributorOutput"}}}}, "GetBoostInsightsEndpoint_LanguageBoostOutput": {"required": ["language", "contributors"], "type": "object", "properties": {"language": {"type": "string"}, "contributors": {"type": "array", "items": {"$ref": "#/components/schemas/GetBoostInsightsEndpoint_ContributorOutput"}}}}, "GetBoostInsightsEndpoint_LevelContributorOutput": {"required": ["campaignId", "campaignName", "level"], "type": "object", "properties": {"campaignId": {"type": "string"}, "campaignName": {"type": "string"}, "level": {"type": "integer", "format": "int32"}}}, "GetBoostInsightsEndpoint_LeveledAudienceOutput": {"required": ["externalAudienceId", "effectiveLevel", "contributors"], "type": "object", "properties": {"externalAudienceId": {"type": "integer", "format": "int32"}, "effectiveLevel": {"type": "integer", "format": "int32"}, "contributors": {"type": "array", "items": {"$ref": "#/components/schemas/GetBoostInsightsEndpoint_LevelContributorOutput"}}}}, "GetBoostInsightsEndpoint_Output": {"required": ["mode", "manualOverrideLevel", "globalBoost", "prospectBlacklist", "distillingBoosts", "labelingBoosts"], "type": "object", "properties": {"mode": {"allOf": [{"$ref": "#/components/schemas/BoostMode"}], "description": "The current boost mode."}, "manualOverrideLevel": {"type": "integer", "description": "The manual override level, if manual mode is active.", "format": "int32", "nullable": true}, "globalBoost": {"allOf": [{"$ref": "#/components/schemas/GetBoostInsightsEndpoint_GlobalBoostOutput"}], "description": "Global boost insight with contributing campaigns."}, "prospectBlacklist": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetBoostInsightsEndpoint_AudienceOutput"}}], "description": "Prospect blacklist insights."}, "distillingBoosts": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetBoostInsightsEndpoint_LeveledAudienceOutput"}}], "description": "Distilling boost insights."}, "labelingBoosts": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetBoostInsightsEndpoint_LeveledAudienceOutput"}}], "description": "Labeling boost insights."}}}, "GetBoostStatusEndpoint_Output": {"required": ["status", "mode", "activeCampaigns", "inactiveCampaigns", "unknownCampaigns"], "type": "object", "properties": {"status": {"allOf": [{"$ref": "#/components/schemas/BoostStatusModel"}], "description": "The current boost status."}, "mode": {"allOf": [{"$ref": "#/components/schemas/BoostMode"}], "description": "The current boost mode."}, "activeCampaigns": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The list of active campaign identifiers."}, "inactiveCampaigns": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The list of inactive campaign identifiers."}, "unknownCampaigns": {"allOf": [{"type": "array", "items": {"type": "integer", "format": "int32"}}], "description": "The list of unknown campaign identifiers."}}}, "GetCampaignByIdEndpoint_Output": {"required": ["id", "name", "status", "priority", "boostingProfile", "boostingControlMode", "hasBooster", "boostLevel", "stickyConfig", "filters", "selections", "featureFlags", "ownerMail", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the campaign."}, "name": {"type": "string", "description": "The name of the campaign."}, "status": {"allOf": [{"$ref": "#/components/schemas/CampaignStatusModel"}], "description": "The current status of the campaign."}, "priority": {"type": "integer", "description": "The priority level of the campaign.", "format": "int32"}, "boostingProfile": {"allOf": [{"$ref": "#/components/schemas/BoostingProfileModel"}], "description": "The boosting profile configuration."}, "boostingControlMode": {"allOf": [{"$ref": "#/components/schemas/BoostingControlMode"}], "description": "The boosting control mode."}, "hasBooster": {"type": "boolean", "description": "Whether the campaign has a booster."}, "boostLevel": {"type": "integer", "description": "The campaign's effective boost level (0-10). 0 when no boost is active.\n Lets clients render and edit the level without unpacking the boosting profile.", "format": "int32"}, "stickyConfig": {"allOf": [{"$ref": "#/components/schemas/StickyConfigModel"}], "description": "The sticky behavior configuration."}, "filters": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/ICampaignFilterModel"}}], "description": "The targeting filters for this campaign."}, "selections": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/ICampaignSelectionModel"}}], "description": "The rapid selections for this campaign."}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "The feature flags configured for this campaign."}, "ownerMail": {"type": "string", "description": "The email of the campaign owner."}, "createdAt": {"type": "string", "description": "The timestamp when the campaign was created.", "format": "date-time"}}}, "GetCampaignCacheEndpoint_CampaignEntry": {"required": ["id", "name", "status", "priority", "filterCount", "selectionCount", "userScoreDimensionCount", "featureFlagCount", "rateLimitCount", "isPreviewEnabled", "boostingControlMode"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "status": {"$ref": "#/components/schemas/CampaignStatusModel"}, "priority": {"type": "integer", "format": "int32"}, "filterCount": {"type": "integer", "format": "int32"}, "selectionCount": {"type": "integer", "format": "int32"}, "userScoreDimensionCount": {"type": "integer", "format": "int32"}, "featureFlagCount": {"type": "integer", "format": "int32"}, "rateLimitCount": {"type": "integer", "format": "int32"}, "isPreviewEnabled": {"type": "boolean"}, "boostingControlMode": {"$ref": "#/components/schemas/BoostingControlMode"}}}, "GetCampaignCacheEndpoint_Output": {"required": ["count", "campaigns"], "type": "object", "properties": {"count": {"type": "integer", "description": "The total number of cached campaigns.", "format": "int32"}, "campaigns": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetCampaignCacheEndpoint_CampaignEntry"}}], "description": "The list of cached campaign summaries."}}}, "GetFastBidMultiplierEndpoint_Output": {"required": ["externalCampaignId", "bidMultiplierValue"], "type": "object", "properties": {"externalCampaignId": {"type": "integer", "description": "The external campaign id reported by the downstream system.", "format": "int32"}, "bidMultiplierValue": {"type": "number", "description": "The current bid multiplier reported for the campaign.", "format": "double"}}}, "GetUserScoreCacheEndpoint_Output": {"required": ["count", "scores"], "type": "object", "properties": {"count": {"type": "integer", "description": "The total number of cached user scores.", "format": "int32"}, "scores": {"allOf": [{"type": "object", "additionalProperties": {"type": "number", "format": "double"}}], "description": "The cached dimension-to-score mappings."}}}, "ICampaignFilterModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/ICampaignFilterModelAndFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelAudienceStateFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelCampaignCooldownFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelCampaignIdFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelCampaignSessionCountFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelCountryFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelDemographicFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelDeviceFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelLanguageFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelNewUserFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelNotFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelOrFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelResponseCountFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelUserActionRestrictionFilterModel"}, {"$ref": "#/components/schemas/ICampaignFilterModelUserScoreFilterModel"}], "discriminator": {"propertyName": "_t", "mapping": {"AndFilter": "#/components/schemas/ICampaignFilterModelAndFilterModel", "AudienceStateFilter": "#/components/schemas/ICampaignFilterModelAudienceStateFilterModel", "CampaignCooldownFilter": "#/components/schemas/ICampaignFilterModelCampaignCooldownFilterModel", "CampaignIdFilter": "#/components/schemas/ICampaignFilterModelCampaignIdFilterModel", "CampaignSessionCountFilter": "#/components/schemas/ICampaignFilterModelCampaignSessionCountFilterModel", "CountryFilter": "#/components/schemas/ICampaignFilterModelCountryFilterModel", "DemographicFilter": "#/components/schemas/ICampaignFilterModelDemographicFilterModel", "DeviceFilter": "#/components/schemas/ICampaignFilterModelDeviceFilterModel", "LanguageFilter": "#/components/schemas/ICampaignFilterModelLanguageFilterModel", "NewUserFilter": "#/components/schemas/ICampaignFilterModelNewUserFilterModel", "NotFilter": "#/components/schemas/ICampaignFilterModelNotFilterModel", "OrFilter": "#/components/schemas/ICampaignFilterModelOrFilterModel", "ResponseCountFilter": "#/components/schemas/ICampaignFilterModelResponseCountFilterModel", "UserActionRestrictionFilter": "#/components/schemas/ICampaignFilterModelUserActionRestrictionFilterModel", "UserScoreFilter": "#/components/schemas/ICampaignFilterModelUserScoreFilterModel"}}}, "ICampaignFilterModelAndFilterModel": {"required": ["filters", "_t"], "properties": {"_t": {"enum": ["AndFilter"], "type": "string"}, "filters": {"type": "array", "items": {"$ref": "#/components/schemas/ICampaignFilterModel"}}}}, "ICampaignFilterModelAudienceStateFilterModel": {"required": ["audienceId", "allowedStates", "includeUnknownState", "_t"], "properties": {"_t": {"enum": ["AudienceStateFilter"], "type": "string"}, "audienceId": {"type": "string"}, "allowedStates": {"type": "array", "items": {"$ref": "#/components/schemas/SimplifiedAudienceUserState"}}, "includeUnknownState": {"type": "boolean"}}}, "ICampaignFilterModelCampaignCooldownFilterModel": {"required": ["cooldown", "_t"], "properties": {"_t": {"enum": ["CampaignCooldownFilter"], "type": "string"}, "cooldown": {"$ref": "#/components/schemas/ICooldownDurationModel"}}}, "ICampaignFilterModelCampaignIdFilterModel": {"required": ["campaignIds", "_t"], "properties": {"_t": {"enum": ["CampaignIdFilter"], "type": "string"}, "campaignIds": {"type": "array", "items": {"type": "string"}}}}, "ICampaignFilterModelCampaignSessionCountFilterModel": {"required": ["sessionCount", "operator", "_t"], "properties": {"_t": {"enum": ["CampaignSessionCountFilter"], "type": "string"}, "sessionCount": {"type": "integer", "format": "uint32"}, "operator": {"$ref": "#/components/schemas/ComparisonOperator"}}}, "ICampaignFilterModelCountryFilterModel": {"required": ["countries", "_t"], "properties": {"_t": {"enum": ["CountryFilter"], "type": "string"}, "countries": {"type": "array", "items": {"type": "string"}}}}, "ICampaignFilterModelDemographicFilterModel": {"required": ["identifier", "values", "_t"], "properties": {"_t": {"enum": ["DemographicFilter"], "type": "string"}, "identifier": {"type": "string"}, "values": {"type": "array", "items": {"type": "string"}}}}, "ICampaignFilterModelDeviceFilterModel": {"required": ["deviceTypes", "_t"], "properties": {"_t": {"enum": ["DeviceFilter"], "type": "string"}, "deviceTypes": {"type": "array", "items": {"$ref": "#/components/schemas/DeviceType"}}}}, "ICampaignFilterModelLanguageFilterModel": {"required": ["languages", "_t"], "properties": {"_t": {"enum": ["LanguageFilter"], "type": "string"}, "languages": {"type": "array", "items": {"type": "string"}}}}, "ICampaignFilterModelNewUserFilterModel": {"required": ["_t"], "properties": {"_t": {"enum": ["NewUserFilter"], "type": "string"}}}, "ICampaignFilterModelNotFilterModel": {"required": ["filter", "_t"], "properties": {"_t": {"enum": ["NotFilter"], "type": "string"}, "filter": {"$ref": "#/components/schemas/ICampaignFilterModel"}}}, "ICampaignFilterModelOrFilterModel": {"required": ["filters", "_t"], "properties": {"_t": {"enum": ["OrFilter"], "type": "string"}, "filters": {}}}, "ICampaignFilterModelResponseCountFilterModel": {"required": ["dimension", "responseCount", "operator", "_t"], "properties": {"_t": {"enum": ["ResponseCountFilter"], "type": "string"}, "dimension": {"type": "string"}, "responseCount": {"type": "integer", "format": "uint32"}, "operator": {"$ref": "#/components/schemas/ComparisonOperator"}}}, "ICampaignFilterModelUserActionRestrictionFilterModel": {"required": ["requiredActions", "_t"], "properties": {"_t": {"enum": ["UserActionRestrictionFilter"], "type": "string"}, "requiredActions": {}}}, "ICampaignFilterModelUserScoreFilterModel": {"required": ["dimension", "lowerbound", "upperbound", "_t"], "properties": {"_t": {"enum": ["UserScoreFilter"], "type": "string"}, "dimension": {"type": "string"}, "lowerbound": {"type": "number", "format": "double"}, "upperbound": {"type": "number", "format": "double"}}}, "ICampaignSelectionModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/ICampaignSelectionModelAbTestSelectionModel"}, {"$ref": "#/components/schemas/ICampaignSelectionModelAudienceSelectionModel"}, {"$ref": "#/components/schemas/ICampaignSelectionModelCappedSelectionModel"}, {"$ref": "#/components/schemas/ICampaignSelectionModelConditionalValidationSelectionModel"}, {"$ref": "#/components/schemas/ICampaignSelectionModelDemographicSelectionModel"}, {"$ref": "#/components/schemas/ICampaignSelectionModelEnforcingSelectionModel"}, {"$ref": "#/components/schemas/ICampaignSelectionModelLabelingSelectionModel"}, {"$ref": "#/components/schemas/ICampaignSelectionModelShufflingSelectionModel"}, {"$ref": "#/components/schemas/ICampaignSelectionModelStaticSelectionModel"}, {"$ref": "#/components/schemas/ICampaignSelectionModelValidationSelectionModel"}], "discriminator": {"propertyName": "_t", "mapping": {"AbTestSelection": "#/components/schemas/ICampaignSelectionModelAbTestSelectionModel", "AudienceSelection": "#/components/schemas/ICampaignSelectionModelAudienceSelectionModel", "CappedSelection": "#/components/schemas/ICampaignSelectionModelCappedSelectionModel", "ConditionalValidationSelection": "#/components/schemas/ICampaignSelectionModelConditionalValidationSelectionModel", "DemographicSelection": "#/components/schemas/ICampaignSelectionModelDemographicSelectionModel", "EnforcingSelection": "#/components/schemas/ICampaignSelectionModelEnforcingSelectionModel", "LabelingSelection": "#/components/schemas/ICampaignSelectionModelLabelingSelectionModel", "ShufflingSelection": "#/components/schemas/ICampaignSelectionModelShufflingSelectionModel", "StaticSelection": "#/components/schemas/ICampaignSelectionModelStaticSelectionModel", "ValidationSelection": "#/components/schemas/ICampaignSelectionModelValidationSelectionModel"}}}, "ICampaignSelectionModelAbTestSelectionModel": {"required": ["a", "b", "_t"], "properties": {"_t": {"enum": ["AbTestSelection"], "type": "string"}, "a": {"type": "array", "items": {"$ref": "#/components/schemas/ICampaignSelectionModel"}}, "b": {"type": "array", "items": {"$ref": "#/components/schemas/ICampaignSelectionModel"}}}}, "ICampaignSelectionModelAudienceSelectionModel": {"required": ["audienceId", "effort", "retrievalMode", "_t"], "properties": {"_t": {"enum": ["AudienceSelection"], "type": "string"}, "audienceId": {"type": "string"}, "effort": {"type": "integer", "format": "int32"}, "retrievalMode": {"$ref": "#/components/schemas/RetrievalMode"}, "maxIterations": {"type": "integer", "format": "int32", "nullable": true}}}, "ICampaignSelectionModelCappedSelectionModel": {"required": ["selections", "maxRapids", "_t"], "properties": {"_t": {"enum": ["CappedSelection"], "type": "string"}, "selections": {"type": "array", "items": {"$ref": "#/components/schemas/ICampaignSelectionModel"}}, "maxRapids": {"type": "integer", "format": "int32"}}}, "ICampaignSelectionModelConditionalValidationSelectionModel": {"required": ["validationChances", "dimensions", "_t"], "properties": {"_t": {"enum": ["ConditionalValidationSelection"], "type": "string"}, "validationChances": {"type": "array", "items": {"$ref": "#/components/schemas/ValidationChanceModel"}}, "dimensions": {"type": "array", "items": {"type": "string"}}}}, "ICampaignSelectionModelDemographicSelectionModel": {"required": ["keys", "maxRapids", "_t"], "properties": {"_t": {"enum": ["DemographicSelection"], "type": "string"}, "keys": {"type": "array", "items": {"type": "string"}}, "probability": {"type": "number", "format": "double", "nullable": true}, "maxRapids": {"type": "integer", "format": "int32"}}}, "ICampaignSelectionModelEnforcingSelectionModel": {"required": ["selections", "minSelections", "minRapids", "_t"], "properties": {"_t": {"enum": ["EnforcingSelection"], "type": "string"}, "selections": {"type": "array", "items": {"$ref": "#/components/schemas/ICampaignSelectionModel"}}, "minSelections": {"type": "integer", "format": "int32"}, "minRapids": {"type": "integer", "format": "int32"}}}, "ICampaignSelectionModelLabelingSelectionModel": {"required": ["effortBudget", "retrievalMode", "_t"], "properties": {"_t": {"enum": ["LabelingSelection"], "type": "string"}, "amount": {"type": "integer", "format": "int32", "nullable": true}, "effortBudget": {"type": "integer", "format": "int32"}, "retrievalMode": {"$ref": "#/components/schemas/RetrievalMode"}, "maxIterations": {"type": "integer", "format": "int32", "nullable": true}}}, "ICampaignSelectionModelShufflingSelectionModel": {"required": ["selections", "_t"], "properties": {"_t": {"enum": ["ShufflingSelection"], "type": "string"}, "selections": {"type": "array", "items": {"$ref": "#/components/schemas/ICampaignSelectionModel"}}}}, "ICampaignSelectionModelStaticSelectionModel": {"required": ["rapidIds", "_t"], "properties": {"_t": {"enum": ["StaticSelection"], "type": "string"}, "rapidIds": {"type": "array", "items": {"type": "string"}}}}, "ICampaignSelectionModelValidationSelectionModel": {"required": ["validationSetId", "_t"], "properties": {"_t": {"enum": ["ValidationSelection"], "type": "string"}, "validationSetId": {"type": "string"}, "amount": {"type": "integer", "format": "int32", "nullable": true}, "effortBudget": {"type": "integer", "format": "int32", "nullable": true}}}, "ICooldownDurationModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/ICooldownDurationModelFixedCooldownDurationModel"}, {"$ref": "#/components/schemas/ICooldownDurationModelRandomCooldownDurationModel"}], "discriminator": {"propertyName": "_t", "mapping": {"FixedCooldownDuration": "#/components/schemas/ICooldownDurationModelFixedCooldownDurationModel", "RandomCooldownDuration": "#/components/schemas/ICooldownDurationModelRandomCooldownDurationModel"}}}, "ICooldownDurationModelFixedCooldownDurationModel": {"required": ["duration", "_t"], "properties": {"_t": {"enum": ["FixedCooldownDuration"], "type": "string"}, "duration": {"type": "string", "format": "date-time"}}}, "ICooldownDurationModelRandomCooldownDurationModel": {"required": ["minDuration", "maxDuration", "seedByUserId", "_t"], "properties": {"_t": {"enum": ["RandomCooldownDuration"], "type": "string"}, "minDuration": {"type": "string", "format": "date-time"}, "maxDuration": {"type": "string", "format": "date-time"}, "seedByUserId": {"type": "boolean"}}}, "QueryCampaignsEndpoint_Output": {"required": ["id", "name", "status", "priority", "hasBooster", "boostLevel", "boostingControlMode", "ownerMail", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the campaign."}, "name": {"type": "string", "description": "The name of the campaign."}, "status": {"allOf": [{"$ref": "#/components/schemas/CampaignStatusModel"}], "description": "The current status of the campaign."}, "priority": {"type": "integer", "description": "The priority level of the campaign.", "format": "int32"}, "hasBooster": {"type": "boolean", "description": "Whether the campaign has a booster."}, "boostLevel": {"type": "integer", "description": "The campaign's effective boost level (0-10). 0 when no boost is active.\n Lets clients render and edit the level without unpacking the boosting profile.", "format": "int32"}, "boostingControlMode": {"allOf": [{"$ref": "#/components/schemas/BoostingControlMode"}], "description": "How the campaign's boost is controlled \u2014 Manual (user-editable) or Automatic\n (managed by an owning service; boost edits are rejected by the API)."}, "ownerMail": {"type": "string", "description": "The email of the campaign owner."}, "createdAt": {"type": "string", "description": "The timestamp when the campaign was created.", "format": "date-time"}}}, "QueryCampaignsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryCampaignsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryExternalAudiencesEndpoint_Output": {"required": ["id", "name"], "type": "object", "properties": {"id": {"type": "integer", "description": "The external audience identifier.", "format": "int32"}, "name": {"type": "string", "description": "The name of the external audience."}, "count": {"type": "integer", "description": "The number of users in the audience.", "format": "int64", "nullable": true}}}, "QueryExternalAudiencesEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryExternalAudiencesEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "SetFastBidMultiplierEndpoint_Input": {"required": ["multiplier"], "type": "object", "properties": {"multiplier": {"type": "number", "description": "The bid multiplier to apply. Must be in [0, 50].", "format": "double"}}}, "SetFastBidMultiplierEndpoint_Output": {"required": ["externalCampaignId", "appliedMultiplier"], "type": "object", "properties": {"externalCampaignId": {"type": "integer", "description": "The external campaign id reported by the downstream system.", "format": "int32"}, "appliedMultiplier": {"type": "number", "description": "The bid multiplier the downstream system reports as currently applied.", "format": "double"}}}, "SetManualGlobalBoostLevelEndpoint_Input": {"type": "object", "properties": {"level": {"type": "integer", "description": "The global boost level. Null disables manual mode and returns to automatic.", "format": "int32", "nullable": true}}}, "SimplifiedAudienceUserState": {"enum": ["Distilling", "Graduated", "Dropped"]}, "StickyConfigModel": {"required": ["isEnabled", "bypassFilters", "bypassPrioritySelection", "blockOtherStickyCampaigns", "clearOnPause"], "type": "object", "properties": {"isEnabled": {"type": "boolean"}, "dimension": {"type": "string"}, "bypassFilters": {"type": "boolean"}, "bypassPrioritySelection": {"type": "boolean"}, "blockOtherStickyCampaigns": {"type": "boolean"}, "clearOnPause": {"type": "boolean"}}}, "UpdateCampaignEndpoint_Input": {"type": "object", "properties": {"name": {"type": "string", "description": "The new name for the campaign."}, "priority": {"type": "integer", "description": "The new priority value for the campaign.", "format": "int32"}, "boostLevel": {"type": "integer", "description": "The campaign's boost level. Set 1-10 to boost (the audience service decides whether\n the boost manifests as global, distilling, or labeling based on the campaign's\n filters). Set 0 to clear any existing boost. Ignored when BoostingProfile is\n also set (explicit profile wins).", "format": "int32"}, "boostingProfile": {"allOf": [{"$ref": "#/components/schemas/BoostingProfileModel"}], "description": "The boosting profile configuration. Takes precedence over BoostLevel and\n RequiresBooster when set. Prefer BoostLevel \u2014 it lets the server derive\n the right profile (including filtered-audience creation) from the campaign's filters."}, "stickyConfig": {"allOf": [{"$ref": "#/components/schemas/StickyConfigModel"}], "description": "The sticky behavior configuration."}, "filters": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/ICampaignFilterModel"}}], "description": "The targeting filters for the campaign."}, "selections": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/ICampaignSelectionModel"}}], "description": "The rapid selections for the campaign."}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "The feature flags for the campaign."}}}, "ValidationChanceModel": {"required": ["userScoreThreshold", "chance", "rapidCount"], "type": "object", "properties": {"userScoreThreshold": {"type": "number", "format": "double"}, "chance": {"type": "number", "format": "double"}, "rapidCount": {"type": "integer", "format": "int32"}, "selections": {"type": "array", "items": {"$ref": "#/components/schemas/ICampaignSelectionModel"}, "nullable": true}}}, "CreateDatapointEndpoint_Input": {"required": ["asset"], "type": "object", "properties": {"asset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "The asset within the datapoint."}, "context": {"type": "string", "description": "An additional context to show the users when solving the rapid.", "nullable": true}, "contextAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "An optional asset context for the datapoint."}, "sortIndex": {"type": "integer", "description": "The sort index represents the order of the datapoint in the dataset.", "format": "int64", "nullable": true}, "group": {"type": "string", "description": "The group a datapoint belongs to.", "nullable": true}, "transcription": {"type": "string", "description": "For audio or video assets, an optional transcription of the content.", "nullable": true}, "privateMetadata": {"allOf": [{"type": "object", "additionalProperties": {"type": "string"}, "nullable": true}], "description": "Private metadata for internal tracking. Not displayed to users."}}, "description": "The body request for creating a new datapoint."}, "CreateDatapointEndpoint_Output": {"required": ["datapointId"], "type": "object", "properties": {"datapointId": {"type": "string", "description": "The id of the created datapoint."}}}, "CreateDatasetEndpoint_Input": {"required": ["name"], "type": "object", "properties": {"name": {"type": "string", "description": "The name to give to the new dataset."}}, "description": "The input for the create dataset endpoint."}, "CreateDatasetEndpoint_Output": {"required": ["datasetId"], "type": "object", "properties": {"datasetId": {"type": "string", "description": "The id of the created dataset."}}, "description": "The result when a dataset has been created."}, "CreateDatasetGroupEndpoint_Input": {"required": ["group"], "type": "object", "properties": {"group": {"type": "string", "description": "The name of the group."}, "context": {"type": "string", "description": "The optional text context for the group.", "nullable": true}, "contextAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "The optional asset context for the group."}}}, "DatapointState": {"enum": ["Ready", "Pending", "Failed"]}, "GetDatapointEndpoint_Output": {"required": ["id", "datasetId", "state", "asset", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the datapoint."}, "datasetId": {"type": "string", "description": "The id of the dataset this datapoint belongs to."}, "state": {"allOf": [{"$ref": "#/components/schemas/DatapointState"}], "description": "The current state of the datapoint."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The asset that will be displayed to the users."}, "sortIndex": {"type": "integer", "description": "An optional upload index used to force a certain order.", "format": "int64", "nullable": true}, "createdAt": {"type": "string", "description": "The timestamp when the datapoint was created.", "format": "date-time"}}}, "GetDatasetByIdEndpoint_Output": {"required": ["name"], "type": "object", "properties": {"name": {"type": "string", "description": "The name of the dataset."}}}, "GetDatasetProgressEndpoint_Output": {"required": ["total", "ready", "pending", "failed"], "type": "object", "properties": {"total": {"type": "integer", "description": "The total number of datapoints in the dataset.", "format": "int32"}, "ready": {"type": "integer", "description": "The number of datapoints that have been uploaded successfully.", "format": "int32"}, "pending": {"type": "integer", "description": "The number of datapoints that are still being processed.", "format": "int32"}, "failed": {"type": "integer", "description": "The number of datapoints that failed to upload.", "format": "int32"}}}, "GetFailedDatapointsEndpoint_Datapoint": {"required": ["id", "datasetId", "sortIndex", "asset", "createdAt"], "type": "object", "properties": {"id": {"type": "string"}, "datasetId": {"type": "string"}, "sortIndex": {"type": "integer", "format": "int64", "nullable": true}, "asset": {"$ref": "#/components/schemas/IAssetModel"}, "createdAt": {"type": "string", "format": "date-time"}}}, "GetFailedDatapointsEndpoint_Output": {"required": ["datapoints"], "type": "object", "properties": {"datapoints": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetFailedDatapointsEndpoint_Datapoint"}}], "description": "The list of failed datapoints."}}}, "QueryDatapointsByDatasetIdEndpoint_Output": {"required": ["id", "datasetId", "asset"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the datapoint."}, "datasetId": {"type": "string", "description": "The id of the dataset this datapoint belongs to."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The asset that will be displayed to the users."}}}, "QueryDatapointsByDatasetIdEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryDatapointsByDatasetIdEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "ShortenContextEndpoint_Input": {"required": ["items"], "type": "object", "properties": {"items": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/ShortenContextEndpoint_InputItem"}}], "description": "The context/question pairs to shorten."}}, "description": "The input for the shorten-context endpoint."}, "ShortenContextEndpoint_InputItem": {"required": ["context", "question"], "type": "object", "properties": {"context": {"type": "string"}, "question": {"type": "string"}}}, "ShortenContextEndpoint_Output": {"required": ["items"], "type": "object", "properties": {"items": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/ShortenContextEndpoint_OutputItem"}}], "description": "The shortened contexts."}}, "description": "The shortened contexts, in the same order as the input items."}, "ShortenContextEndpoint_OutputItem": {"required": ["shortenedContext"], "type": "object", "properties": {"shortenedContext": {"type": "string"}}}, "UpdateDatasetNameEndpoint_Input": {"required": ["name"], "type": "object", "properties": {"name": {"type": "string", "description": "The new name of the dataset."}}}, "AudienceBoostModel2": {"required": ["audienceId", "level"], "type": "object", "properties": {"audienceId": {"type": "string"}, "level": {"type": "integer", "format": "int32"}}}, "CreateFlowEndpoint_Input": {"required": ["name", "criteria"], "type": "object", "properties": {"name": {"type": "string", "description": "The name of the ranking flow."}, "criteria": {"type": "string", "description": "The ranking criteria used to compare items."}, "audienceId": {"type": "string", "description": "Optional audience ID. When provided, the flow will only be served to users in this audience.", "nullable": true}, "validationSetId": {"type": "string", "description": "Optional ID of the validation set to use.", "nullable": true}, "startingElo": {"type": "integer", "description": "Initial Elo rating for new items. Defaults to 1200.", "format": "int32", "nullable": true}, "maxResponses": {"type": "integer", "description": "Maximum number of responses per comparison.", "format": "int32", "nullable": true}, "serveResponses": {"type": "integer", "description": "Number of accepted responses per rapid at which to stop serving. When set, must be less than or equal to MaxResponses. Null defaults to MaxResponses.", "format": "int32", "nullable": true}, "serveToResponseRatio": {"type": "number", "description": "Ratio of concurrent serves to max responses. When set, limits serving to avoid over-collection.", "format": "double", "nullable": true}, "serveTimeoutSeconds": {"type": "integer", "description": "Time in seconds a user has to submit an answer after loading the task. When set, overrides the global default.", "format": "int32", "nullable": true}, "minResponses": {"type": "integer", "description": "Minimum number of responses per comparison. Defaults to 20.", "format": "int32", "nullable": true}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}, "nullable": true}], "description": "Optional feature flags to enable for this flow."}, "targetResponseCount": {"type": "integer", "description": "Target average response count per completed item. Enables PID control when set.", "format": "int32", "nullable": true}, "pidProportionalGain": {"type": "number", "description": "PID proportional gain. Defaults to 0.", "format": "double", "nullable": true}, "pidIntegralGain": {"type": "number", "description": "PID integral gain. Defaults to 0.003.", "format": "double", "nullable": true}, "pidDerivativeGain": {"type": "number", "description": "PID derivative gain. Defaults to 0.", "format": "double", "nullable": true}, "pidOutputOffset": {"type": "number", "description": "Constant offset added to the PID output before clamping, shifting the controller's operating point. Defaults to 25.", "format": "double", "nullable": true}, "pidMinSessionsPerMinute": {"type": "integer", "description": "Minimum sessions per minute the PID can set. Defaults to 20.", "format": "int32", "nullable": true}, "pidMaxSessionsPerMinute": {"type": "integer", "description": "Maximum sessions per minute the PID can set. Defaults to 50.", "format": "int32", "nullable": true}, "pidBatchMode": {"allOf": [{"$ref": "#/components/schemas/PidBatchMode"}], "description": "How PID output maps to campaign rate. Total: direct rate. PerBatch: multiplied by active batch count. PerBatchTimeWeighted: multiplied by time-weighted batch count. Defaults to Total."}, "drainDurationSeconds": {"type": "integer", "description": "Duration in seconds for draining flow items. Defaults to 40.", "format": "int32", "nullable": true}}}, "CreateFlowEndpoint_Output": {"required": ["flowId"], "type": "object", "properties": {"flowId": {"type": "string", "description": "The ID of the created ranking flow."}}}, "CreateFlowItemEndpoint_Input": {"required": ["datasetId"], "type": "object", "properties": {"datasetId": {"type": "string", "description": "The ID of the dataset to use for this flow item."}, "context": {"type": "string", "description": "Optional context to provide additional ranking guidance.", "nullable": true}, "contextAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "Optional asset context to provide additional ranking guidance."}, "timeToLiveInSeconds": {"type": "integer", "description": "Optional time-to-live in seconds before the flow item expires. Must be between 60 seconds and 1 hour; defaults to 1 hour when omitted.", "format": "int32", "nullable": true}, "drainDurationInSeconds": {"type": "integer", "description": "Optional drain duration in seconds. When set, rapids are paused this many seconds before TTL expiry to allow in-flight responses to complete.", "format": "int32", "nullable": true}}}, "CreateFlowItemEndpoint_Output": {"required": ["flowItemId"], "type": "object", "properties": {"flowItemId": {"type": "string", "description": "The ID of the created flow item."}}}, "FlowItemState": {"enum": ["Pending", "Running", "Completed", "Failed", "Stopping", "Stopped", "Incomplete"]}, "FlowType": {"enum": ["Ranking"]}, "GetCompletionTimeHistogramEndpoint_Output": {"required": ["buckets"], "type": "object", "properties": {"buckets": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetCompletionTimeHistogramEndpoint_Output_Bucket"}}], "description": "The histogram buckets."}}}, "GetCompletionTimeHistogramEndpoint_Output_Bucket": {"required": ["lowerBound", "upperBound", "count"], "type": "object", "properties": {"lowerBound": {"type": "number", "format": "double"}, "upperBound": {"type": "number", "format": "double"}, "count": {"type": "integer", "format": "int32"}}}, "GetFlowItemByIdEndpoint_Output": {"required": ["id", "flowId", "datasetId", "state", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the flow item."}, "flowId": {"type": "string", "description": "The ID of the flow this item belongs to."}, "datasetId": {"type": "string", "description": "The ID of the dataset used by this flow item."}, "workflowId": {"type": "string", "description": "The ID of the workflow created for this flow item.", "nullable": true}, "state": {"allOf": [{"$ref": "#/components/schemas/FlowItemState"}], "description": "The current state of the flow item."}, "context": {"type": "string", "description": "Optional context associated with this flow item.", "nullable": true}, "contextAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "Optional asset context associated with this flow item."}, "failureMessage": {"type": "string", "description": "The failure message if the flow item failed.", "nullable": true}, "expiresAt": {"type": "string", "description": "The expiration timestamp of the flow item.", "format": "date-time", "nullable": true}, "createdAt": {"type": "string", "description": "The timestamp when the flow item was created.", "format": "date-time"}, "startedAt": {"type": "string", "description": "The timestamp when the flow item started processing.", "format": "date-time", "nullable": true}, "completedAt": {"type": "string", "description": "The timestamp when the flow item completed.", "format": "date-time", "nullable": true}, "failedAt": {"type": "string", "description": "The timestamp when the flow item failed.", "format": "date-time", "nullable": true}}}, "GetFlowItemCreationTimeseriesEndpoint_Output": {"required": ["datapoints"], "type": "object", "properties": {"datapoints": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetFlowItemCreationTimeseriesEndpoint_Output_DataPoint"}}], "description": "The timeseries data points."}}}, "GetFlowItemCreationTimeseriesEndpoint_Output_DataPoint": {"required": ["timestamp", "count"], "type": "object", "properties": {"timestamp": {"type": "string", "format": "date-time"}, "count": {"type": "integer", "format": "int64"}}}, "GetRankingFlowItemResultsEndpoint_Output": {"required": ["datapoints", "totalVotes"], "type": "object", "properties": {"datapoints": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetRankingFlowItemResultsEndpoint_Output_Datapoint"}}], "description": "The ranked datapoints with their Elo scores."}, "totalVotes": {"type": "integer", "description": "The total number of votes across all datapoints.", "format": "int64"}}}, "GetRankingFlowItemResultsEndpoint_Output_Datapoint": {"required": ["id", "asset", "elo"], "type": "object", "properties": {"id": {"type": "string"}, "asset": {"$ref": "#/components/schemas/IAssetModel"}, "elo": {"type": "integer", "format": "int32"}}}, "GetRankingFlowItemVoteMatrixEndpoint_Output": {"required": ["index", "columns", "data"], "type": "object", "properties": {"index": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "Row labels of the vote matrix."}, "columns": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "Column labels of the vote matrix."}, "data": {"allOf": [{"type": "array", "items": {"type": "array", "items": {"type": "number", "format": "double"}}}], "description": "The vote counts as a two-dimensional matrix where Data[i][j] is the number of times row i was preferred over column j."}}}, "GetResponseCountHistogramEndpoint_Output": {"required": ["buckets"], "type": "object", "properties": {"buckets": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetResponseCountHistogramEndpoint_Output_Bucket"}}], "description": "The histogram buckets."}}}, "GetResponseCountHistogramEndpoint_Output_Bucket": {"required": ["lowerBound", "upperBound", "count"], "type": "object", "properties": {"lowerBound": {"type": "number", "format": "double"}, "upperBound": {"type": "number", "format": "double"}, "count": {"type": "integer", "format": "int32"}}}, "GetResponseCountTimeseriesEndpoint_Output": {"required": ["datapoints"], "type": "object", "properties": {"datapoints": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetResponseCountTimeseriesEndpoint_Output_DataPoint"}}], "description": "The timeseries data points."}}}, "GetResponseCountTimeseriesEndpoint_Output_DataPoint": {"required": ["timestamp", "averageResponseCount"], "type": "object", "properties": {"timestamp": {"type": "string", "format": "date-time"}, "averageResponseCount": {"type": "number", "format": "double"}}}, "IFlowModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IFlowModelRankingFlowModel"}], "description": "A flow definition exposed over the API, identified by a discriminator.\n Implementations describe the flow's type-specific configuration.", "discriminator": {"propertyName": "_t", "mapping": {"RankingFlow": "#/components/schemas/IFlowModelRankingFlowModel"}}}, "IFlowModelRankingFlowModel": {"required": ["id", "name", "campaignId", "flowItemCount", "targetResponseCount", "pidProportionalGain", "pidIntegralGain", "pidDerivativeGain", "pidOutputOffset", "pidMinSessionsPerMinute", "pidMaxSessionsPerMinute", "pidBatchMode", "serveTimeoutSeconds", "drainDurationSeconds", "serveToResponseRatio", "criteria", "startingElo", "minResponses", "maxResponses", "serveResponses", "featureFlags", "ownerId", "ownerMail", "createdAt", "_t"], "properties": {"_t": {"enum": ["RankingFlow"], "type": "string"}, "id": {"type": "string", "description": "The unique identifier of the flow."}, "name": {"type": "string", "description": "The name of the flow."}, "campaignId": {"type": "string", "description": "The ID of the campaign associated with this flow."}, "flowItemCount": {"type": "integer", "description": "The total number of items that have been added to this flow. Incremented atomically on each item creation.", "format": "int64"}, "targetResponseCount": {"type": "integer", "description": "Target average response count per completed item. Enables PID-based automatic rate control when set. Null disables PID.", "format": "int32", "nullable": true}, "pidProportionalGain": {"type": "number", "description": "PID proportional gain. Controls how strongly the rate reacts to the current error between target and actual response counts.", "format": "double"}, "pidIntegralGain": {"type": "number", "description": "PID integral gain. Eliminates steady-state error by accumulating error over time. Includes anti-windup clamping.", "format": "double"}, "pidDerivativeGain": {"type": "number", "description": "PID derivative gain. Provides damping by reacting to the rate of change of the error, helping prevent overshoot.", "format": "double"}, "pidOutputOffset": {"type": "number", "description": "Constant offset added to the PID output before clamping, shifting the controller's operating point so the P/I/D terms trim around a non-zero baseline.", "format": "double"}, "pidMinSessionsPerMinute": {"type": "integer", "description": "Minimum sessions per minute the PID controller can set. Prevents the rate from dropping to zero.", "format": "int32"}, "pidMaxSessionsPerMinute": {"type": "integer", "description": "Maximum sessions per minute the PID controller can set. Prevents the rate from exceeding infrastructure capacity.", "format": "int32"}, "pidBatchMode": {"allOf": [{"$ref": "#/components/schemas/PidBatchMode"}], "description": "How the PID output maps to the campaign rate. Total: used directly. PerBatch: multiplied by active item count. PerBatchTimeWeighted: multiplied by time-weighted active item count based on remaining TTL."}, "serveTimeoutSeconds": {"type": "integer", "description": "Maximum time in seconds a user has to submit an answer after loading the task. Null uses the system-wide default.", "format": "int32", "nullable": true}, "drainDurationSeconds": {"type": "integer", "description": "Grace period in seconds after an item stops receiving new serves, allowing in-flight responses to complete.", "format": "int32"}, "serveToResponseRatio": {"type": "number", "description": "Ratio of serves to responses used to calculate how many tasks to serve per expected response.", "format": "double", "nullable": true}, "criteria": {"type": "string", "description": "The comparison instruction shown to annotators during ranking tasks (e.g. \"Which image is sharper?\").", "nullable": true}, "startingElo": {"type": "integer", "description": "The initial Elo rating assigned to new items entering the ranking. Standard default is 1200.", "format": "int32"}, "minResponses": {"type": "integer", "description": "Minimum number of responses a ranking item must receive before it is considered sufficiently evaluated.", "format": "int32"}, "maxResponses": {"type": "integer", "description": "Maximum number of responses a ranking item can receive before being removed from active ranking. Null allows unlimited responses.", "format": "int32", "nullable": true}, "serveResponses": {"type": "integer", "description": "Number of accepted responses per rapid at which to stop serving. Null defaults to MaxResponses.", "format": "int32", "nullable": true}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "Key-value feature flags that enable specific behaviors for this flow (e.g. rapid_hints)."}, "ownerId": {"type": "string", "description": "The ID of the customer who owns the flow.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The email of the customer who owns the flow."}, "createdAt": {"type": "string", "description": "The timestamp when the flow was created.", "format": "date-time"}}}, "PidBatchMode": {"enum": ["Total", "PerBatch", "PerBatchTimeWeighted"]}, "ProblemDetails": {"type": "object", "properties": {"type": {"type": "string", "nullable": true}, "title": {"type": "string", "nullable": true}, "status": {"type": "integer", "format": "int32", "nullable": true}, "detail": {"type": "string", "nullable": true}, "instance": {"type": "string", "nullable": true}}}, "QueryFlowItemsEndpoint_Output": {"required": ["id", "datasetId", "state", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the flow item."}, "datasetId": {"type": "string", "description": "The ID of the dataset used by this flow item."}, "workflowId": {"type": "string", "description": "The ID of the workflow created for this flow item.", "nullable": true}, "state": {"allOf": [{"$ref": "#/components/schemas/FlowItemState"}], "description": "The current state of the flow item."}, "context": {"type": "string", "description": "Optional context associated with this flow item.", "nullable": true}, "contextAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "Optional asset context associated with this flow item."}, "failureMessage": {"type": "string", "description": "The failure message if the flow item failed.", "nullable": true}, "createdAt": {"type": "string", "description": "The timestamp when the flow item was created.", "format": "date-time"}, "startedAt": {"type": "string", "description": "The timestamp when the flow item started processing.", "format": "date-time", "nullable": true}, "completedAt": {"type": "string", "description": "The timestamp when the flow item completed.", "format": "date-time", "nullable": true}, "failedAt": {"type": "string", "description": "The timestamp when the flow item failed.", "format": "date-time", "nullable": true}}}, "QueryFlowItemsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryFlowItemsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryFlowsEndpoint_Output": {"required": ["id", "name", "type", "ownerId", "ownerMail", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the flow."}, "name": {"type": "string", "description": "The name of the flow."}, "type": {"allOf": [{"$ref": "#/components/schemas/FlowType"}], "description": "The type of the flow."}, "ownerId": {"type": "string", "description": "The ID of the customer who owns the flow.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The email of the customer who owns the flow."}, "createdAt": {"type": "string", "description": "The timestamp when the flow was created.", "format": "date-time"}}}, "QueryFlowsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryFlowsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "UpdateConfigEndpoint_Input": {"type": "object", "properties": {"audienceId": {"type": "string", "description": "Optional audience ID. When provided, the flow will only serve items to users in this audience. Set to null to remove the audience restriction.", "nullable": true}, "criteria": {"type": "string", "description": "The ranking criteria used to compare items."}, "startingElo": {"type": "integer", "description": "Initial Elo rating for new items.", "format": "int32"}, "minResponses": {"type": "integer", "description": "Minimum number of responses per comparison.", "format": "int32"}, "maxResponses": {"type": "integer", "description": "Maximum number of responses per comparison.", "format": "int32"}, "serveResponses": {"type": "integer", "description": "Number of accepted responses per rapid at which to stop serving. Set to null to remove. Must be less than or equal to MaxResponses when both are set.", "format": "int32", "nullable": true}, "serveToResponseRatio": {"type": "number", "description": "Ratio of concurrent serves to max responses. Set to null to remove the limit.", "format": "double", "nullable": true}, "serveTimeoutSeconds": {"type": "integer", "description": "Time in seconds a user has to submit an answer after loading the task. Set to null to use the global default.", "format": "int32", "nullable": true}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "Feature flags to enable for this flow."}, "targetResponseCount": {"type": "integer", "description": "Target average response count per completed item. Set to null to disable PID control.", "format": "int32", "nullable": true}, "pidProportionalGain": {"type": "number", "description": "PID proportional gain.", "format": "double"}, "pidIntegralGain": {"type": "number", "description": "PID integral gain.", "format": "double"}, "pidDerivativeGain": {"type": "number", "description": "PID derivative gain.", "format": "double"}, "pidOutputOffset": {"type": "number", "description": "Constant offset added to the PID output before clamping, shifting the controller's operating point.", "format": "double"}, "pidMinSessionsPerMinute": {"type": "integer", "description": "Minimum sessions per minute the PID can set.", "format": "int32"}, "pidMaxSessionsPerMinute": {"type": "integer", "description": "Maximum sessions per minute the PID can set.", "format": "int32"}, "pidBatchMode": {"allOf": [{"$ref": "#/components/schemas/PidBatchMode"}], "description": "How PID output maps to campaign rate. Total: direct rate. PerBatch: multiplied by active batch count. PerBatchTimeWeighted: multiplied by time-weighted batch count."}}}, "ClientModel": {"required": ["client_id", "client_secret", "client_id_issued_at", "client_secret_expires_at", "redirect_uris", "grant_types", "response_types", "client_name", "client_uri", "logo_uri", "scope", "contacts", "tos_uri", "policy_uri", "jwks_uri", "jwks"], "type": "object", "properties": {"client_id": {"type": "string"}, "client_secret": {"type": "string", "nullable": true}, "client_id_issued_at": {"type": "integer", "format": "int64", "nullable": true}, "client_secret_expires_at": {"type": "integer", "format": "int64", "nullable": true}, "redirect_uris": {"type": "array", "items": {"type": "array", "items": {"type": "string"}}, "nullable": true}, "grant_types": {"type": "array", "items": {"type": "array", "items": {"type": "string"}}, "nullable": true}, "response_types": {"type": "array", "items": {"type": "array", "items": {"type": "string"}}, "nullable": true}, "client_name": {"type": "string", "nullable": true}, "client_uri": {"type": "string", "nullable": true}, "logo_uri": {"type": "string", "nullable": true}, "scope": {"type": "string", "description": "String containing a space-separated list of scope values\n that the client can use when requesting access tokens.", "nullable": true}, "contacts": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "Array of strings representing ways to contact people responsible for this client,\n typically email addresses."}, "tos_uri": {"type": "string", "nullable": true}, "policy_uri": {"type": "string", "nullable": true}, "jwks_uri": {"type": "string", "nullable": true}, "jwks": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/JsonWebKeySet"}]}}, "description": "The response containing the id and secret of a dynamically registered client.\n Additionally, it contains all registered metadata for the client."}, "CreateBridgeTokenEndpoint_Output": {"required": ["readKey", "writeKey"], "type": "object", "properties": {"readKey": {"type": "string", "description": "The read key used to retrieve the authentication result."}, "writeKey": {"type": "string", "description": "The write key used to store the authentication result."}}}, "CreateClientEndpoint_Input": {"type": "object", "properties": {"displayName": {"type": "string", "description": "An optional display name for the client.", "nullable": true}}}, "CreateClientEndpoint_Output": {"required": ["clientId", "clientSecret"], "type": "object", "properties": {"clientId": {"type": "string", "description": "The id of the created client."}, "clientSecret": {"type": "string", "description": "The secret of the created client."}}}, "DynamicClientRegistrationRequest": {"type": "object", "properties": {"redirect_uris": {"type": "array", "items": {"type": "string"}, "nullable": true}, "grant_types": {"type": "array", "items": {"type": "string"}, "nullable": true}, "response_types": {"type": "array", "items": {"type": "string"}, "nullable": true}, "client_id": {"type": "string", "nullable": true}, "client_name": {"type": "string", "nullable": true}, "client_uri": {"type": "string", "nullable": true}, "logo_uri": {"type": "string", "nullable": true}, "scope": {"type": "string", "description": "String containing a space-separated list of scope values\n that the client can use when requesting access tokens.", "nullable": true}, "contacts": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "Array of strings representing ways to contact people responsible for this client,\n typically email addresses."}, "tos_uri": {"type": "string", "nullable": true}, "policy_uri": {"type": "string", "nullable": true}, "jwks_uri": {"type": "string", "nullable": true}, "jwks": {"allOf": [{"$ref": "#/components/schemas/JsonWebKeySet"}], "description": "Client's JSON Web Key Set [RFC7517] document value, which contains the client's public keys."}}, "description": "The request body for dynamic client registration."}, "GetMyOrganizationEndpoint_Output": {"required": ["name", "supportSlackChannelUrl"], "type": "object", "properties": {"name": {"type": "string", "description": "The name of the organization."}, "supportSlackChannelUrl": {"type": "string", "description": "The support Slack channel URL of the organization, if one has been configured.", "nullable": true}}}, "GoogleOneTapLoginEndpoint_Input": {"required": ["idToken"], "type": "object", "properties": {"idToken": {"type": "string", "description": "The id token received from the Google One Tap login."}}}, "GoogleOneTapLoginEndpoint_Output": {"required": ["requiresEmailConfirmation"], "type": "object", "properties": {"requiresEmailConfirmation": {"type": "boolean", "description": "Whether the account still requires email confirmation."}, "email": {"type": "string", "description": "The email of the signed-in user, if available.", "nullable": true}}}, "JsonWebKey": {"type": "object", "properties": {"alg": {"type": "string", "nullable": true}, "crv": {"type": "string", "nullable": true}, "d": {"type": "string", "nullable": true}, "dp": {"type": "string", "nullable": true}, "dq": {"type": "string", "nullable": true}, "e": {"type": "string", "nullable": true}, "k": {"type": "string", "nullable": true}, "key_ops": {"type": "array", "items": {"type": "string"}, "nullable": true}, "kid": {"type": "string", "nullable": true}, "kty": {"type": "string", "nullable": true}, "n": {"type": "string", "nullable": true}, "oth": {"type": "array", "items": {"type": "string"}, "nullable": true}, "p": {"type": "string", "nullable": true}, "q": {"type": "string", "nullable": true}, "qi": {"type": "string", "nullable": true}, "use": {"type": "string", "nullable": true}, "x": {"type": "string", "nullable": true}, "x5c": {"type": "array", "items": {"type": "string"}, "nullable": true}, "x5t": {"type": "string", "nullable": true}, "x5t#S256": {"type": "string", "nullable": true}, "x5u": {"type": "string", "nullable": true}, "y": {"type": "string", "nullable": true}, "pub": {"type": "string", "nullable": true}, "priv": {"type": "string", "nullable": true}}}, "JsonWebKeySet": {"type": "object", "properties": {"keys": {"type": "array", "items": {"$ref": "#/components/schemas/JsonWebKey"}, "nullable": true}}}, "QueryClientsEndpoint_Output": {"required": ["clientId", "displayName", "createdAt"], "type": "object", "properties": {"clientId": {"type": "string", "description": "The id of the client.", "nullable": true}, "displayName": {"type": "string", "description": "The optional display name of the client.", "nullable": true}, "createdAt": {"type": "string", "description": "The time at which the client was created.", "format": "date-time", "nullable": true}}}, "QueryClientsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryClientsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryCustomersEndpoint_Output": {"required": ["id", "email", "organizationName", "organizationId"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the customer.", "format": "uuid"}, "email": {"type": "string", "description": "The email address of the customer.", "nullable": true}, "organizationName": {"type": "string", "description": "The name of the organization this customer belongs to, if any.", "nullable": true}, "organizationId": {"type": "string", "description": "The identifier of the organization this customer belongs to, if any.", "format": "uuid", "nullable": true}}}, "QueryCustomersEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryCustomersEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryOrganizationsEndpoint_Output": {"required": ["owner", "name", "domain"], "type": "object", "properties": {"owner": {"type": "string", "description": "The customer ID of the organization owner.", "format": "uuid"}, "name": {"type": "string", "description": "The name of the organization."}, "domain": {"type": "string", "description": "The domain associated with this organization."}}}, "QueryOrganizationsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryOrganizationsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "ReadBridgeTokenEndpoint_KeysOutput": {"required": ["accessToken", "expiresIn", "refreshToken", "idToken", "tokenType", "scope"], "type": "object", "properties": {"accessToken": {"type": "string", "description": "The issued access token.", "nullable": true}, "expiresIn": {"type": "integer", "description": "The lifetime of the access token, in seconds.", "format": "int32", "nullable": true}, "refreshToken": {"type": "string", "description": "The refresh token used to obtain new access tokens.", "nullable": true}, "idToken": {"type": "string", "description": "The OpenID Connect ID token.", "nullable": true}, "tokenType": {"type": "string", "description": "The type of the issued token.", "nullable": true}, "scope": {"type": "string", "description": "The scopes granted to the issued token.", "nullable": true}}}, "ReadBridgeTokenEndpoint_NotAvailableOutput": {"required": ["message"], "type": "object", "properties": {"message": {"type": "string", "description": "A message indicating that the keys are not yet available."}}}, "SendSurveyEndpoint_Input": {"required": ["fields"], "type": "object", "properties": {"fields": {"allOf": [{"type": "object", "additionalProperties": {"type": "string"}}], "description": "The fields of the survey."}}}, "SetOrganizationSupportSlackChannelEndpoint_Input": {"type": "object", "properties": {"url": {"type": "string", "description": "The support Slack channel URL to set, or null/empty to clear it.", "nullable": true}}}, "SubscribeToNewsletterEndpoint_Input": {"required": ["email", "token"], "type": "object", "properties": {"email": {"type": "string", "description": "The email of the user to subscribe."}, "token": {"type": "string", "description": "The recaptcha token used to verify the caller is not a bot."}}}, "UnsubscribeFromNewsletterEndpoint_Input": {"required": ["email", "token"], "type": "object", "properties": {"email": {"type": "string", "description": "The email of the user to unsubscribe."}, "token": {"type": "string", "description": "The recaptcha token used to verify the caller is not a bot."}}}, "BoostLeaderboardEndpoint_Input": {"required": ["participants", "totalResponses"], "type": "object", "properties": {"participants": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The participants of the given leaderboard that should be boosted."}, "totalResponses": {"type": "integer", "description": "The total responses to add, shared across all participants.", "format": "int32"}}}, "ConfidenceInterval": {"required": ["lowerOffset", "upperOffset"], "type": "object", "properties": {"lowerOffset": {"type": "number", "format": "double"}, "upperOffset": {"type": "number", "format": "double"}}}, "CreateBenchmarkEndpoint_Input": {"required": ["name"], "type": "object", "properties": {"name": {"type": "string", "description": "The name of the benchmark."}, "description": {"type": "string", "description": "Optional plain-text credit for the people or sources behind the benchmark. Limited to\n 2000 characters. Leave unset for no description.", "nullable": true}, "initialBoostLevel": {"type": "integer", "description": "Initial boost level applied to the campaign of every run created from this benchmark.\n Leave unset to fall back to . Admins\n may set any value the validator allows (0-10); non-admins are restricted to\n 0..BenchmarkEntity.DefaultInitialBoostLevel \u2014 anything outside that range returns\n 403 Forbidden via .", "format": "int32", "nullable": true}, "scoreShift": {"type": "number", "description": "Additive offset applied to displayed scores on the overall scoreboard of this\n benchmark. Defaults to 0 when unset.", "format": "double", "nullable": true}, "scoreScale": {"type": "number", "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on the overall scoreboard of this benchmark. Defaults to 1.0 when\n unset; must be strictly positive.", "format": "double", "nullable": true}}}, "CreateBenchmarkEndpoint_Output": {"required": ["id"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the created benchmark."}}}, "CreateBenchmarkParticipantEndpoint_Input": {"required": ["name"], "type": "object", "properties": {"name": {"type": "string", "description": "The name of the participant."}, "family": {"type": "string", "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"), if any.", "nullable": true}, "proprietaryName": {"type": "string", "description": "The vendor-facing display name of the model, if any.", "nullable": true}, "logo": {"allOf": [{"$ref": "#/components/schemas/ExistingAssetInput"}], "description": "An optional logo image for the model. Must be an existing image asset."}}}, "CreateBenchmarkParticipantEndpoint_Output": {"required": ["participantId", "datasetId"], "type": "object", "properties": {"participantId": {"type": "string", "description": "The id of the created participant."}, "datasetId": {"type": "string", "description": "The id of the participant's dataset."}}}, "CreateLeaderboardEndpoint_Input": {"required": ["name", "instruction", "showPrompt"], "type": "object", "properties": {"benchmarkId": {"type": "string", "description": "If the leaderboard should be added to a preexisting benchmark, the benchmark id.", "nullable": true}, "benchmarkName": {"type": "string", "description": "When no BenchmarkId is provided, the name of the new benchmark to create.", "nullable": true}, "benchmarkDescription": {"type": "string", "description": "Optional plain-text credit for the people or sources behind the benchmark, applied to\n the new benchmark created via . Limited to 2000 characters.\n Ignored when an existing is provided. Leave unset for no\n description.", "nullable": true}, "name": {"type": "string", "description": "The name of the leaderboard."}, "instruction": {"type": "string", "description": "The instruction datapoints will be matched up against."}, "showPrompt": {"type": "boolean", "description": "Indicates if the prompt is shown on the rapids."}, "showPromptAsset": {"type": "boolean", "description": "Whether the prompt asset should be shown on the rapids."}, "responseBudget": {"type": "integer", "description": "Total amount of responses that get collected per run.", "format": "int32", "nullable": true}, "minResponses": {"type": "integer", "description": "The minimum amount of responses that need to be collected per comparison.", "format": "int32", "nullable": true}, "isInversed": {"type": "boolean", "description": "Whether the results should be inversed, selecting the worse model."}, "audienceId": {"type": "string", "description": "Optional audience id; defaults to the global audience when unset.", "nullable": true}, "priority": {"type": "integer", "description": "Optional priority override applied to every run's job. Admin-only.\n When unset, runs use the default leaderboard priority.", "format": "int32"}, "weight": {"type": "number", "description": "Multiplier applied to every match result of this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards. Defaults to 1.0 when\n unset; unbounded (negative and zero values are accepted).", "format": "double"}, "scoreShift": {"type": "number", "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard. Defaults to 0 when unset.", "format": "double"}, "scoreScale": {"type": "number", "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard. Defaults to 1.0 when\n unset; must be strictly positive.", "format": "double"}, "isHidden": {"type": "boolean", "description": "Whether the leaderboard should be created hidden. Admin-only."}, "isExcludedFromOverall": {"type": "boolean", "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard.\n When set, the leaderboard becomes an owner-only private experiment: its results do not\n contribute to the overall and it is visible only to its owner and admins. Defaults to\n false when unset."}, "voteAggregation": {"allOf": [{"$ref": "#/components/schemas/VoteAggregation"}], "description": "How individual votes on a matchup are aggregated into the stored result. AllVotes\n counts every vote as a matchup; MajorityVote collapses each matchup to a single\n win for the majority side (ties split 0.5/0.5). Defaults to AllVotes when unset."}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}, "nullable": true}], "description": "Feature flags applied to every order created by this leaderboard."}}}, "CreateLeaderboardEndpoint_Output": {"required": ["id", "benchmarkId", "showPrompt", "showPromptAsset", "responseBudget", "minResponses", "isInversed", "voteAggregation"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the created leaderboard."}, "benchmarkId": {"type": "string", "description": "The id of the benchmark the leaderboard belongs to."}, "showPrompt": {"type": "boolean", "description": "Whether the prompt is shown on the rapids."}, "showPromptAsset": {"type": "boolean", "description": "Whether the prompt asset is shown on the rapids."}, "responseBudget": {"type": "integer", "description": "The response budget per run.", "format": "int32"}, "minResponses": {"type": "integer", "description": "The minimum responses per comparison.", "format": "int32"}, "isInversed": {"type": "boolean", "description": "Whether the leaderboard results are inversed."}, "voteAggregation": {"allOf": [{"$ref": "#/components/schemas/VoteAggregation"}], "description": "How individual votes on a matchup are aggregated into the stored result."}}}, "CreateLeaderboardParticipantEndpoint_Input": {"required": ["name"], "type": "object", "properties": {"name": {"type": "string", "description": "The name of the participant."}}}, "CreateLeaderboardParticipantEndpoint_Output": {"required": ["participantId", "datasetId"], "type": "object", "properties": {"participantId": {"type": "string", "description": "The id of the created participant."}, "datasetId": {"type": "string", "description": "The id of the participant's dataset."}}}, "CreatePromptForBenchmarkEndpoint_Input": {"required": ["identifier"], "type": "object", "properties": {"identifier": {"type": "string", "description": "An identifier associated with the prompt."}, "prompt": {"type": "string", "description": "The prompt text.", "nullable": true}, "promptAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "The asset associated with the prompt."}, "tags": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "The tags associated with the prompt."}}}, "CreatePromptForBenchmarkEndpoint_Output": {"required": ["id"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the created prompt."}}}, "CreatePromptForLeaderboardEndpoint_Output": {"required": ["id"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the created prompt."}}}, "CreateSampleEndpoint_Input": {"required": ["identifier", "asset"], "type": "object", "properties": {"identifier": {"type": "string", "description": "The identifier used to correlate samples of different participants."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "The asset input for the sample."}}}, "CreateSampleEndpoint_Output": {"required": ["id"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the created sample."}}}, "CreateSampleGenerationEndpoint_Input": {"required": ["samplesPerPrompt"], "type": "object", "properties": {"samplesPerPrompt": {"type": "integer", "description": "How many samples to request per matching prompt (1 to 16).", "format": "int32"}, "participantIds": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "Restrict generation to specific participants. Defaults to all participants\n in the benchmark that have a configured faucet."}, "promptIdentifiers": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "Restrict generation to specific prompt identifiers.\n Defaults to every prompt in the benchmark."}, "tags": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "Restrict generation to prompts having at least one of these tags."}}}, "CreateSampleGenerationEndpoint_Output": {"required": ["id", "totalCount", "skippedParticipantIds"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the created sample generation request."}, "totalCount": {"type": "integer", "description": "The total number of generation items that were queued.", "format": "int32"}, "skippedParticipantIds": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "Participants that matched the selection but were skipped because they have no faucet\n configured. Empty when explicit participant ids were supplied."}}}, "CreateSampleNewEndpoint_Input": {"required": ["identifier", "asset"], "type": "object", "properties": {"identifier": {"type": "string", "description": "The identifier used to correlate samples of different participants."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "The asset input for the sample."}}}, "CreateSampleNewEndpoint_Output": {"required": ["id"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the created sample."}}}, "ForkBenchmarkEndpoint_Output": {"required": ["id"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the new benchmark created."}}}, "GetBenchmarkByIdEndpoint_Output": {"required": ["id", "name", "description", "isPublic", "isPublished", "createdAt", "ownerId", "ownerMail", "initialBoostLevel", "scoreShift", "scoreScale"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the benchmark."}, "name": {"type": "string", "description": "The name of the benchmark."}, "description": {"type": "string", "description": "Optional plain-text credit for the people or sources behind the benchmark. Null when no\n description was supplied.", "nullable": true}, "isPublic": {"type": "boolean", "description": "Whether the benchmark is public."}, "isPublished": {"type": "boolean", "description": "Whether the benchmark is published to the public benchmark repository."}, "createdAt": {"type": "string", "description": "The timestamp when the benchmark was created.", "format": "date-time"}, "ownerId": {"type": "string", "description": "The id of the customer owning the benchmark.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The mail of the customer owning the benchmark."}, "initialBoostLevel": {"type": "integer", "description": "The initial boost level applied to the campaign of every run created from this\n benchmark. Null means the benchmark default is used.", "format": "int32", "nullable": true}, "scoreShift": {"type": "number", "description": "Additive offset applied to displayed scores on the overall scoreboard of this\n benchmark.", "format": "double"}, "scoreScale": {"type": "number", "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on the overall scoreboard of this benchmark.", "format": "double"}}}, "GetCombinedBenchmarkMatrixEndpoint_Output": {"required": ["index", "columns", "data"], "type": "object", "properties": {"index": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "Row participant names."}, "columns": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "Column participant names."}, "data": {"allOf": [{"type": "array", "items": {"type": "array", "items": {"type": "number", "format": "double"}}}], "description": "NxN matrix where Data[i][j] = wins of Index[i] over Columns[j]."}}, "description": "Combined benchmark matrix output in pandas split format."}, "GetCombinedBenchmarkStandingsEndpoint_Output": {"required": ["items"], "type": "object", "properties": {"items": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetCombinedBenchmarkStandingsEndpoint_OutputItem"}}], "description": "The standings items."}}, "description": "Combined benchmark standings output."}, "GetCombinedBenchmarkStandingsEndpoint_OutputItem": {"required": ["id", "name", "status", "score", "wins", "totalMatches", "isDisabled"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "status": {"$ref": "#/components/schemas/StandingStatus"}, "score": {"type": "number", "format": "double", "nullable": true}, "wins": {"type": "number", "format": "double"}, "totalMatches": {"type": "number", "format": "double"}, "isDisabled": {"type": "boolean"}, "confidenceInterval": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/ConfidenceInterval"}]}}}, "GetCombinedLeaderboardMatrixEndpoint_Output": {"required": ["index", "columns", "data"], "type": "object", "properties": {"index": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "Row participant names."}, "columns": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "Column participant names."}, "data": {"allOf": [{"type": "array", "items": {"type": "array", "items": {"type": "number", "format": "double"}}}], "description": "NxN matrix where Data[i][j] = wins of Index[i] over Columns[j]."}}, "description": "Combined leaderboard matrix output in pandas split format."}, "GetCombinedLeaderboardStandingsEndpoint_Output": {"required": ["items"], "type": "object", "properties": {"items": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetCombinedLeaderboardStandingsEndpoint_OutputItem"}}], "description": "The standings items."}}, "description": "Combined leaderboard standings output."}, "GetCombinedLeaderboardStandingsEndpoint_OutputItem": {"required": ["id", "name", "status", "score", "wins", "totalMatches", "isDisabled"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "status": {"$ref": "#/components/schemas/StandingStatus"}, "score": {"type": "number", "format": "double", "nullable": true}, "wins": {"type": "number", "format": "double"}, "totalMatches": {"type": "number", "format": "double"}, "isDisabled": {"type": "boolean"}, "confidenceInterval": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/ConfidenceInterval"}]}}}, "GetLeaderboardByIdEndpoint_Output": {"required": ["id", "name", "instruction", "showPrompt", "showPromptAsset", "isInversed", "responseBudget", "minResponses", "audienceId", "featureFlags", "weight", "scoreShift", "scoreScale", "isHidden", "isExcludedFromOverall", "voteAggregation"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the leaderboard."}, "name": {"type": "string", "description": "The name of the leaderboard."}, "instruction": {"type": "string", "description": "The instruction used when collecting responses."}, "showPrompt": {"type": "boolean", "description": "Whether the prompt is shown on the rapids."}, "showPromptAsset": {"type": "boolean", "description": "Whether the prompt asset is shown on the rapids."}, "isInversed": {"type": "boolean", "description": "Whether the leaderboard results are inversed."}, "responseBudget": {"type": "integer", "description": "The response budget per run.", "format": "int32"}, "minResponses": {"type": "integer", "description": "The minimum responses collected per comparison.", "format": "int32"}, "audienceId": {"type": "string", "description": "The id of the audience that evaluates the leaderboard."}, "jobDefinitionId": {"type": "string", "description": "The id of the associated job definition, if any.", "nullable": true}, "priority": {"type": "integer", "description": "Priority override applied to every run's job. Null when no override is set; runs then\n fall back to the default leaderboard priority.", "format": "int32", "nullable": true}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "Feature flags applied to orders created from this leaderboard."}, "weight": {"type": "number", "description": "Multiplier applied to every match result from this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards.", "format": "double"}, "scoreShift": {"type": "number", "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard.", "format": "double"}, "scoreScale": {"type": "number", "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard.", "format": "double"}, "isHidden": {"type": "boolean", "description": "Whether the leaderboard is hidden in listings and reads for non-admins."}, "isExcludedFromOverall": {"type": "boolean", "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard,\n making it an owner-only private experiment."}, "voteAggregation": {"allOf": [{"$ref": "#/components/schemas/VoteAggregation"}], "description": "How individual votes on a matchup are aggregated into the stored result."}}}, "GetParticipantByIdEndpoint_Output": {"required": ["id", "name", "benchmarkId"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the participant."}, "name": {"type": "string", "description": "The name of the participant."}, "benchmarkId": {"type": "string", "description": "The id of the benchmark the participant belongs to."}, "family": {"type": "string", "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"), or null if unset.", "nullable": true}, "proprietaryName": {"type": "string", "description": "The vendor-facing display name of the model, or null if unset.", "nullable": true}, "logo": {"type": "string", "description": "The logo of the model, or null if unset.", "nullable": true}, "faucet": {"allOf": [{"$ref": "#/components/schemas/IFaucetOutput"}], "description": "The faucet configured to auto-generate samples, or null if none is set."}}}, "GetParticipantByIdObsoleteEndpoint_Output": {"required": ["id", "name", "benchmarkId", "status", "isDisabled"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the standing."}, "name": {"type": "string", "description": "The name of the participant."}, "benchmarkId": {"type": "string", "description": "The id of the benchmark this standing belongs to."}, "status": {"allOf": [{"$ref": "#/components/schemas/StandingStatus"}], "description": "The status of the standing."}, "isDisabled": {"type": "boolean", "description": "Whether the participant is disabled."}}}, "GetPromptsByBenchmarkEndpoint_Output": {"required": ["id", "identifier", "createdAt", "tags"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the prompt."}, "englishPrompt": {"type": "string", "description": "The prompt text translated to English.", "nullable": true}, "originalPrompt": {"type": "string", "description": "The prompt text as originally provided.", "nullable": true}, "promptAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The optional asset associated with the prompt."}, "identifier": {"type": "string", "description": "The identifier associated with the prompt."}, "createdAt": {"type": "string", "description": "The timestamp when the prompt was created.", "format": "date-time"}, "tags": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The tags associated with the prompt."}}}, "GetPromptsByBenchmarkEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/GetPromptsByBenchmarkEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "GetReplicateModelEndpoint_Output": {"required": ["modelOwner", "modelName", "supportsImageReference", "parameters"], "type": "object", "properties": {"modelOwner": {"type": "string", "description": "The owner of the hosted model."}, "modelName": {"type": "string", "description": "The model name."}, "description": {"type": "string", "description": "A short description of the model.", "nullable": true}, "coverImageUrl": {"type": "string", "description": "URL of a representative cover image, if available.", "nullable": true}, "runCount": {"type": "integer", "description": "Total number of times the model has been run on Replicate, if known.", "format": "int64", "nullable": true}, "latestVersion": {"type": "string", "description": "The model's latest version id, if reported by Replicate.", "nullable": true}, "supportsImageReference": {"type": "boolean", "description": "Whether the model accepts a reference image that the platform auto-fills with a prompt's\n attached media. When true that input is excluded from ."}, "parameters": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetReplicateModelEndpoint_Parameter"}}], "description": "The model's configurable input parameters, ordered for rendering."}}}, "GetReplicateModelEndpoint_Parameter": {"required": ["key", "type", "required", "enumValues"], "type": "object", "properties": {"key": {"type": "string"}, "title": {"type": "string", "nullable": true}, "description": {"type": "string", "nullable": true}, "type": {"$ref": "#/components/schemas/ReplicateModelParameterType"}, "required": {"type": "boolean"}, "default": {}, "enumValues": {"type": "array", "items": {"type": "string"}}, "minimum": {"type": "number", "format": "double", "nullable": true}, "maximum": {"type": "number", "format": "double", "nullable": true}, "order": {"type": "integer", "format": "int32", "nullable": true}}}, "GetSampleByIdEndpoint_Output": {"required": ["id", "identifier", "participantId", "participantName", "asset", "tags", "ownerMail"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the sample."}, "identifier": {"type": "string", "description": "The identifier used to correlate samples of different participants."}, "participantId": {"type": "string", "description": "The id of the participant that owns the sample."}, "participantName": {"type": "string", "description": "The name of the participant that owns the sample."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The asset associated with the sample."}, "englishPrompt": {"type": "string", "description": "An optional prompt text translated to English.", "nullable": true}, "originalPrompt": {"type": "string", "description": "An optional prompt text as originally provided.", "nullable": true}, "promptAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "An optional prompt asset associated with the sample."}, "tags": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The tags associated with the sample."}, "createdAt": {"type": "string", "description": "The timestamp when the sample was created.", "format": "date-time"}, "ownerId": {"type": "string", "description": "The id of the customer that owns the sample.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The mail of the customer that owns the sample."}}}, "GetSampleGenerationEndpoint_Output": {"required": ["id", "benchmarkId", "status", "samplesPerPrompt", "totalCount", "completedCount", "failedCount", "ownerId", "ownerMail", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the sample generation request."}, "benchmarkId": {"type": "string", "description": "The benchmark this generation belongs to."}, "status": {"allOf": [{"$ref": "#/components/schemas/SampleGenerationStatus"}], "description": "The current status of the generation."}, "samplesPerPrompt": {"type": "integer", "description": "How many samples are being generated per prompt.", "format": "int32"}, "totalCount": {"type": "integer", "description": "The total number of items queued.", "format": "int32"}, "completedCount": {"type": "integer", "description": "The number of items that have succeeded so far.", "format": "int32"}, "failedCount": {"type": "integer", "description": "The number of items that have failed.", "format": "int32"}, "participantIdFilter": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "Optional participant id filter that was applied when this generation was created."}, "promptIdentifierFilter": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "Optional prompt identifier filter that was applied."}, "tagsFilter": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "Optional tag filter that was applied."}, "ownerId": {"type": "string", "description": "The id of the customer that started this generation.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The mail of the customer that started this generation."}, "createdAt": {"type": "string", "description": "When the generation was created.", "format": "date-time"}}}, "GetSampleGenerationItemsEndpoint_Output": {"required": ["id", "sampleGenerationId", "participantId", "benchmarkPromptId", "promptIdentifier", "sampleCount", "status", "attemptCount", "sampleIds", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the generation item."}, "sampleGenerationId": {"type": "string", "description": "The id of the parent sample generation."}, "participantId": {"type": "string", "description": "The participant whose faucet is producing this sample."}, "benchmarkPromptId": {"type": "string", "description": "The benchmark prompt this item targets."}, "promptIdentifier": {"type": "string", "description": "The identifier of the prompt being generated."}, "sampleCount": {"type": "integer", "description": "How many samples this item produces for its (participant, prompt) pair.", "format": "int32"}, "status": {"allOf": [{"$ref": "#/components/schemas/SampleGenerationItemStatus"}], "description": "The current status of this item."}, "attemptCount": {"type": "integer", "description": "Number of delivery attempts that have been made on this item.", "format": "int32"}, "providerRequestId": {"type": "string", "description": "Provider-side request id used to correlate with the provider's logs.", "nullable": true}, "failureReason": {"type": "string", "description": "Failure reason if the item is in a failed state.", "nullable": true}, "sampleIds": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The ids of the samples created from this item once it succeeds."}, "createdAt": {"type": "string", "description": "When the item was created.", "format": "date-time"}}}, "GetSampleGenerationItemsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/GetSampleGenerationItemsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "GetSampleNavigationEndpoint_Output": {"required": ["current", "previous", "next", "related"], "type": "object", "properties": {"current": {"allOf": [{"$ref": "#/components/schemas/GetSampleNavigationEndpoint_SampleModel"}], "description": "The current sample that navigation is anchored on."}, "previous": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetSampleNavigationEndpoint_SampleModel"}}], "description": "Up to three samples of the same participant preceding the current sample,\n ordered ascending by identifier. Empty when the current sample is the first\n of its participant."}, "next": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetSampleNavigationEndpoint_SampleModel"}}], "description": "Up to three samples of the same participant following the current sample,\n ordered ascending by identifier. Empty when the current sample is the last\n of its participant."}, "related": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetSampleNavigationEndpoint_SampleModel"}}], "description": "Samples of other participants in the same benchmark that share the current\n sample's identifier."}}}, "GetSampleNavigationEndpoint_SampleModel": {"required": ["id", "identifier", "participantId", "participantName", "asset", "tags", "ownerMail"], "type": "object", "properties": {"id": {"type": "string"}, "identifier": {"type": "string"}, "participantId": {"type": "string"}, "participantName": {"type": "string"}, "asset": {"$ref": "#/components/schemas/IAssetModel"}, "englishPrompt": {"type": "string", "nullable": true}, "originalPrompt": {"type": "string", "nullable": true}, "promptAsset": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/IAssetModel"}]}, "tags": {"type": "array", "items": {"type": "string"}}, "createdAt": {"type": "string", "format": "date-time"}, "ownerId": {"type": "string", "format": "uuid"}, "ownerMail": {"type": "string"}}}, "GetSamplesByIdentifierEndpoint_Output": {"required": ["id", "identifier", "participantId", "participantName", "asset", "tags", "ownerMail"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the sample."}, "identifier": {"type": "string", "description": "The identifier used to correlate samples of different participants."}, "participantId": {"type": "string", "description": "The id of the participant that owns the sample."}, "participantName": {"type": "string", "description": "The name of the participant that owns the sample."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The asset associated with the sample."}, "englishPrompt": {"type": "string", "description": "An optional prompt text translated to English.", "nullable": true}, "originalPrompt": {"type": "string", "description": "An optional prompt text as originally provided.", "nullable": true}, "promptAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "An optional prompt asset associated with the sample."}, "tags": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The tags associated with the sample."}, "createdAt": {"type": "string", "description": "The timestamp when the sample was created.", "format": "date-time"}, "ownerId": {"type": "string", "description": "The id of the customer that owns the sample.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The mail of the customer that owns the sample."}}}, "GetSamplesByIdentifierEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/GetSamplesByIdentifierEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "GetSamplesByParticipantEndpoint_ISampleOutput": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput"}, {"$ref": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_PlaceholderSampleOutput"}], "description": "Represents a sample returned for a participant.", "discriminator": {"propertyName": "_t", "mapping": {"SampleOutput": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput", "PlaceholderSampleOutput": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_PlaceholderSampleOutput"}}}, "GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_PlaceholderSampleOutput": {"required": ["identifier", "tags", "_t"], "properties": {"_t": {"enum": ["PlaceholderSampleOutput"], "type": "string"}, "identifier": {"type": "string", "description": "The identifier used to correlate samples of different participants."}, "englishPrompt": {"type": "string", "description": "An optional prompt text translated to English.", "nullable": true}, "originalPrompt": {"type": "string", "description": "An optional prompt text as originally provided.", "nullable": true}, "promptAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "An optional prompt asset associated with the sample."}, "tags": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The tags associated with the sample."}}}, "GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput": {"required": ["id", "identifier", "asset", "tags", "ownerMail", "_t"], "properties": {"_t": {"enum": ["SampleOutput"], "type": "string"}, "id": {"type": "string", "description": "The unique identifier of the sample."}, "identifier": {"type": "string", "description": "The identifier used to correlate samples of different participants."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The asset associated with the sample."}, "englishPrompt": {"type": "string", "description": "An optional prompt text translated to English.", "nullable": true}, "originalPrompt": {"type": "string", "description": "An optional prompt text as originally provided.", "nullable": true}, "promptAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "An optional prompt asset associated with the sample."}, "tags": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The tags associated with the sample."}, "createdAt": {"type": "string", "description": "The timestamp when the sample was created.", "format": "date-time"}, "ownerId": {"type": "string", "description": "The id of the customer that owns the sample.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The mail of the customer that owns the sample."}}}, "GetSamplesByParticipantEndpoint_PagedResultOfISampleOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutput"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "GetStandingByIdEndpoint_Output": {"required": ["id", "name", "benchmarkId", "status", "isDisabled"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the standing."}, "name": {"type": "string", "description": "The name of the participant."}, "benchmarkId": {"type": "string", "description": "The id of the benchmark this standing belongs to."}, "status": {"allOf": [{"$ref": "#/components/schemas/StandingStatus"}], "description": "The status of the standing."}, "isDisabled": {"type": "boolean", "description": "Whether the participant is disabled."}}}, "IFaucetInput": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IFaucetInputReplicateFaucetInput"}], "description": "Polymorphic request body describing a faucet to configure on a participant. The concrete\n type is selected by the _t discriminator (e.g. \"Replicate\").", "discriminator": {"propertyName": "_t", "mapping": {"Replicate": "#/components/schemas/IFaucetInputReplicateFaucetInput"}}}, "IFaucetInputReplicateFaucetInput": {"required": ["modelOwner", "modelName", "_t"], "properties": {"_t": {"enum": ["Replicate"], "type": "string"}, "modelOwner": {"type": "string", "description": "The owner of the hosted model (e.g. \"stability-ai\")."}, "modelName": {"type": "string", "description": "The model name (e.g. \"sdxl\")."}, "modelVersion": {"type": "string", "description": "Optional pinned model version hash.", "nullable": true}, "additionalInputs": {"type": "object", "description": "Extra model inputs keyed by parameter name (e.g. \"aspect_ratio\"). The system-managed keys\n (prompt, num_outputs) must not appear here \u2014 they are supplied automatically. Values are\n validated against the model's live input schema when the faucet is set."}}, "description": "Configures a faucet that generates samples via the Replicate API."}, "IFaucetOutput": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IFaucetOutputManagedFaucetOutput"}, {"$ref": "#/components/schemas/IFaucetOutputReplicateFaucetOutput"}], "discriminator": {"propertyName": "_t", "mapping": {"Managed": "#/components/schemas/IFaucetOutputManagedFaucetOutput", "Replicate": "#/components/schemas/IFaucetOutputReplicateFaucetOutput"}}}, "IFaucetOutputManagedFaucetOutput": {"required": ["_t"], "properties": {"_t": {"enum": ["Managed"], "type": "string"}, "testTimeScaling": {"type": "integer", "format": "int32", "nullable": true}}}, "IFaucetOutputReplicateFaucetOutput": {"required": ["modelOwner", "modelName", "additionalInputs", "_t"], "properties": {"_t": {"enum": ["Replicate"], "type": "string"}, "modelOwner": {"type": "string"}, "modelName": {"type": "string"}, "modelVersion": {"type": "string", "nullable": true}, "additionalInputs": {"type": "object"}}}, "ParticipantStatus": {"enum": ["Created", "Submitted", "Disabled"]}, "QueryBenchmarksEndpoint_Output": {"required": ["id", "name", "isManaged", "isPublic", "isPublished", "createdAt", "ownerMail"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the benchmark."}, "name": {"type": "string", "description": "The name of the benchmark."}, "isManaged": {"type": "boolean", "description": "Whether the benchmark is managed."}, "isPublic": {"type": "boolean", "description": "Whether the benchmark is public."}, "isPublished": {"type": "boolean", "description": "Whether the benchmark is published to the public benchmark repository."}, "createdAt": {"type": "string", "description": "The timestamp when the benchmark was created.", "format": "date-time"}, "ownerMail": {"type": "string", "description": "The mail of the customer owning the benchmark."}}}, "QueryBenchmarksEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryBenchmarksEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryBenchmarkStandingsEndpoint_Output": {"required": ["id", "name", "benchmarkId", "status", "score", "wins", "totalMatches", "isDisabled"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the participant."}, "name": {"type": "string", "description": "The name of the participant."}, "benchmarkId": {"type": "string", "description": "The id of the benchmark this standing belongs to."}, "status": {"allOf": [{"$ref": "#/components/schemas/StandingStatus"}], "description": "The status of the standing."}, "score": {"type": "number", "description": "The calculated score, or null if not yet computed.", "format": "double", "nullable": true}, "wins": {"type": "number", "description": "The number of wins.", "format": "double"}, "totalMatches": {"type": "number", "description": "The total number of matches.", "format": "double"}, "isDisabled": {"type": "boolean", "description": "Whether the participant is disabled."}, "confidenceInterval": {"allOf": [{"$ref": "#/components/schemas/ConfidenceInterval"}], "description": "The confidence interval bounds, if requested."}}}, "QueryBenchmarkStandingsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryBenchmarkStandingsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryLeaderboardRunsEndpoint_Output": {"required": ["id", "name", "status", "createdAt", "ownerMail", "orderId", "jobId", "audienceId"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the run."}, "name": {"type": "string", "description": "The name of the run."}, "status": {"allOf": [{"$ref": "#/components/schemas/RunStatus"}], "description": "The status of the run."}, "createdAt": {"type": "string", "description": "The timestamp when the run was created.", "format": "date-time"}, "ownerMail": {"type": "string", "description": "The mail of the owner of the run."}, "orderId": {"type": "string", "description": "The id of the associated order, if any.", "nullable": true}, "jobId": {"type": "string", "description": "The id of the associated job, if any.", "nullable": true}, "audienceId": {"type": "string", "description": "The id of the audience associated with the run."}}}, "QueryLeaderboardRunsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryLeaderboardRunsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryLeaderboardsByBenchmarkEndpoint_Output": {"required": ["id", "name", "instruction", "showPrompt", "showPromptAsset", "isInversed", "responseBudget", "minResponses", "audienceId", "featureFlags", "weight", "scoreShift", "scoreScale", "isHidden", "isExcludedFromOverall"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the leaderboard."}, "name": {"type": "string", "description": "The name of the leaderboard."}, "instruction": {"type": "string", "description": "The instruction shown on the leaderboard."}, "showPrompt": {"type": "boolean", "description": "Whether the prompt text is shown."}, "showPromptAsset": {"type": "boolean", "description": "Whether the prompt asset is shown."}, "isInversed": {"type": "boolean", "description": "Whether the leaderboard's scoring is inversed."}, "responseBudget": {"type": "integer", "description": "The response budget for the leaderboard.", "format": "int32"}, "minResponses": {"type": "integer", "description": "The minimum number of responses for the leaderboard.", "format": "int32"}, "audienceId": {"type": "string", "description": "The id of the audience assigned to the leaderboard."}, "jobDefinitionId": {"type": "string", "description": "The id of the job definition assigned to the leaderboard, if any.", "nullable": true}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "The feature flags enabled for the leaderboard."}, "weight": {"type": "number", "description": "Multiplier applied to every match result from this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards.", "format": "double"}, "scoreShift": {"type": "number", "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard.", "format": "double"}, "scoreScale": {"type": "number", "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard.", "format": "double"}, "isHidden": {"type": "boolean", "description": "Whether the leaderboard is hidden in listings and reads for non-admins."}, "isExcludedFromOverall": {"type": "boolean", "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard,\n making it an owner-only private experiment."}}}, "QueryLeaderboardsByBenchmarkEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryLeaderboardsByBenchmarkEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryLeaderboardsEndpoint_Output": {"required": ["id", "name", "instruction", "showPrompt", "showPromptAsset", "isInversed", "responseBudget", "minResponses", "audienceId", "featureFlags", "weight", "scoreShift", "scoreScale", "isHidden", "isExcludedFromOverall", "voteAggregation"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the leaderboard."}, "name": {"type": "string", "description": "The name of the leaderboard."}, "instruction": {"type": "string", "description": "The instruction used when collecting responses."}, "showPrompt": {"type": "boolean", "description": "Whether the prompt is shown on the rapids."}, "showPromptAsset": {"type": "boolean", "description": "Whether the prompt asset is shown on the rapids."}, "isInversed": {"type": "boolean", "description": "Whether the leaderboard results are inversed."}, "responseBudget": {"type": "integer", "description": "The response budget per run.", "format": "int32"}, "minResponses": {"type": "integer", "description": "The minimum responses collected per comparison.", "format": "int32"}, "audienceId": {"type": "string", "description": "The id of the audience that evaluates the leaderboard."}, "jobDefinitionId": {"type": "string", "description": "The id of the associated job definition, if any.", "nullable": true}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "Feature flags applied to orders created from this leaderboard."}, "weight": {"type": "number", "description": "Multiplier applied to every match result from this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards.", "format": "double"}, "scoreShift": {"type": "number", "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard.", "format": "double"}, "scoreScale": {"type": "number", "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard.", "format": "double"}, "isHidden": {"type": "boolean", "description": "Whether the leaderboard is hidden in listings and reads for non-admins."}, "isExcludedFromOverall": {"type": "boolean", "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard,\n making it an owner-only private experiment."}, "voteAggregation": {"allOf": [{"$ref": "#/components/schemas/VoteAggregation"}], "description": "How individual votes on a matchup are aggregated into the stored result."}}}, "QueryLeaderboardsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryLeaderboardsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryManagedBenchmarksEndpoint_Output": {"required": ["id", "name", "isManaged", "isPublic", "isPublished", "createdAt", "ownerMail"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the benchmark."}, "name": {"type": "string", "description": "The name of the benchmark."}, "isManaged": {"type": "boolean", "description": "Whether the benchmark is managed."}, "isPublic": {"type": "boolean", "description": "Whether the benchmark is public."}, "isPublished": {"type": "boolean", "description": "Whether the benchmark is published to the public benchmark repository."}, "createdAt": {"type": "string", "description": "The timestamp when the benchmark was created.", "format": "date-time"}, "ownerMail": {"type": "string", "description": "The mail of the customer owning the benchmark."}}}, "QueryManagedBenchmarksEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryManagedBenchmarksEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryParticipantsByBenchmarkEndpoint_Output": {"required": ["id", "name", "benchmarkId", "status"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the participant."}, "name": {"type": "string", "description": "The name of the participant."}, "benchmarkId": {"type": "string", "description": "The id of the benchmark the participant belongs to."}, "family": {"type": "string", "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"), or null if unset.", "nullable": true}, "proprietaryName": {"type": "string", "description": "The vendor-facing display name of the model, or null if unset.", "nullable": true}, "logo": {"type": "string", "description": "The logo of the model, or null if unset.", "nullable": true}, "status": {"allOf": [{"$ref": "#/components/schemas/ParticipantStatus"}], "description": "The status of the participant."}}}, "QueryParticipantsByBenchmarkEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryParticipantsByBenchmarkEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryParticipantsObsoleteEndpoint_Output": {"required": ["items"], "type": "object", "properties": {"items": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/QueryParticipantsObsoleteEndpoint_OutputItem"}}], "description": "The standings items for the leaderboard."}}}, "QueryParticipantsObsoleteEndpoint_OutputItem": {"required": ["id", "name", "leaderboardId", "status", "score", "wins", "totalMatches", "isDisabled"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "leaderboardId": {"type": "string"}, "status": {"$ref": "#/components/schemas/StandingStatus"}, "score": {"type": "number", "format": "double", "nullable": true}, "wins": {"type": "number", "format": "double"}, "totalMatches": {"type": "number", "format": "double"}, "isDisabled": {"type": "boolean"}, "confidenceInterval": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/ConfidenceInterval"}]}}}, "QueryPublishedBenchmarksEndpoint_Output": {"required": ["id", "name", "isManaged", "isPublic", "isPublished", "createdAt", "ownerMail"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the benchmark."}, "name": {"type": "string", "description": "The name of the benchmark."}, "isManaged": {"type": "boolean", "description": "Whether the benchmark is managed."}, "isPublic": {"type": "boolean", "description": "Whether the benchmark is public."}, "isPublished": {"type": "boolean", "description": "Whether the benchmark is published to the public benchmark repository."}, "createdAt": {"type": "string", "description": "The timestamp when the benchmark was created.", "format": "date-time"}, "ownerMail": {"type": "string", "description": "The mail of the customer owning the benchmark."}}}, "QueryPublishedBenchmarksEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryPublishedBenchmarksEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QuerySampleGenerationsByBenchmarkEndpoint_Output": {"required": ["id", "benchmarkId", "status", "samplesPerPrompt", "totalCount", "completedCount", "failedCount", "ownerId", "ownerMail", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the sample generation request."}, "benchmarkId": {"type": "string", "description": "The benchmark this generation belongs to."}, "status": {"allOf": [{"$ref": "#/components/schemas/SampleGenerationStatus"}], "description": "The current status of the generation."}, "samplesPerPrompt": {"type": "integer", "description": "How many samples are being generated per prompt.", "format": "int32"}, "totalCount": {"type": "integer", "description": "The total number of items queued.", "format": "int32"}, "completedCount": {"type": "integer", "description": "The number of items that have succeeded so far.", "format": "int32"}, "failedCount": {"type": "integer", "description": "The number of items that have failed.", "format": "int32"}, "participantIdFilter": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "Optional participant id filter that was applied when this generation was created."}, "promptIdentifierFilter": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "Optional prompt identifier filter that was applied."}, "tagsFilter": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "Optional tag filter that was applied."}, "ownerId": {"type": "string", "description": "The id of the customer that started this generation.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The mail of the customer that started this generation."}, "createdAt": {"type": "string", "description": "When the generation was created.", "format": "date-time"}}}, "QuerySampleGenerationsByBenchmarkEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QuerySampleGenerationsByBenchmarkEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryStandingsEndpoint_Output": {"required": ["id", "name", "leaderboardId", "status", "score", "wins", "totalMatches", "isDisabled"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the participant."}, "name": {"type": "string", "description": "The name of the participant."}, "leaderboardId": {"type": "string", "description": "The id of the leaderboard this standing belongs to."}, "status": {"allOf": [{"$ref": "#/components/schemas/StandingStatus"}], "description": "The status of the standing."}, "score": {"type": "number", "description": "The calculated score, or null if not yet computed.", "format": "double", "nullable": true}, "wins": {"type": "number", "description": "The number of wins.", "format": "double"}, "totalMatches": {"type": "number", "description": "The total number of matches.", "format": "double"}, "isDisabled": {"type": "boolean", "description": "Whether the participant is disabled."}, "confidenceInterval": {"allOf": [{"$ref": "#/components/schemas/ConfidenceInterval"}], "description": "The confidence interval bounds, if requested."}}}, "QueryStandingsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryStandingsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryTagsByBenchmarkEndpoint_Output": {"required": ["tags"], "type": "object", "properties": {"tags": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The tags associated with the benchmark."}}}, "ReplicateModelParameterType": {"enum": ["String", "Integer", "Number", "Boolean", "Uri"]}, "RetrySampleGenerationEndpoint_Input": {"type": "object", "properties": {"itemIds": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "The specific item ids to retry. When omitted or empty, every failed item of the\n generation is retried."}}}, "RetrySampleGenerationEndpoint_Output": {"required": ["retriedCount", "retriedItemIds"], "type": "object", "properties": {"retriedCount": {"type": "integer", "description": "How many failed items were re-queued.", "format": "int32"}, "retriedItemIds": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The ids of the items that were re-queued."}}}, "RunStatus": {"enum": ["Queued", "Running", "Completed", "Failed"]}, "SampleGenerationItemStatus": {"enum": ["Pending", "Running", "Succeeded", "Failed"]}, "SampleGenerationStatus": {"enum": ["Pending", "Processing", "Completed", "CompletedWithFailures", "Failed", "Cancelled"]}, "SearchReplicateModelsEndpoint_Model": {"required": ["modelOwner", "modelName"], "type": "object", "properties": {"modelOwner": {"type": "string"}, "modelName": {"type": "string"}, "description": {"type": "string", "nullable": true}, "coverImageUrl": {"type": "string", "nullable": true}, "runCount": {"type": "integer", "format": "int64", "nullable": true}}}, "SearchReplicateModelsEndpoint_Output": {"required": ["models"], "type": "object", "properties": {"models": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/SearchReplicateModelsEndpoint_Model"}}], "description": "The matching models for this page."}, "nextCursor": {"type": "string", "description": "Cursor to fetch the next page, or null when there are no more results.", "nullable": true}}}, "StandingStatus": {"enum": ["Created", "Active", "Idle"]}, "SubmitParticipantByBenchmarkEndpoint_Output": {"required": ["validDatapoints", "invalidDatapoints"], "type": "object", "properties": {"validDatapoints": {"type": "integer", "description": "The number of valid datapoints collected by the participant.", "format": "int32"}, "invalidDatapoints": {"type": "integer", "description": "The number of invalid datapoints collected by the participant.", "format": "int32"}}}, "SubmitParticipantEndpoint_Output": {"required": ["validDatapoints", "invalidDatapoints"], "type": "object", "properties": {"validDatapoints": {"type": "integer", "description": "The number of valid datapoints collected by the participant.", "format": "int32"}, "invalidDatapoints": {"type": "integer", "description": "The number of invalid datapoints collected by the participant.", "format": "int32"}}}, "UpdateBenchmarkEndpoint_Input": {"type": "object", "properties": {"name": {"type": "string", "description": "The new name of the benchmark."}, "description": {"type": "string", "description": "Optional plain-text credit for the people or sources behind the benchmark. Limited to\n 2000 characters. Send null to clear it; omit to leave it unchanged."}, "isPublic": {"type": "boolean", "description": "Whether the benchmark should be public (only admins can change this)."}, "isPublished": {"type": "boolean", "description": "Whether the benchmark should be surfaced in the public benchmark repository (only\n admins can change this)."}, "initialBoostLevel": {"type": "integer", "description": "Initial boost level applied to the campaign of every run created from this benchmark.\n Admins may set any value the validator allows (0-10) or null to clear the\n override; non-admins are restricted to\n 0.. and may not clear\n it. Both restrictions are enforced by\n with a 403 on\n violation.", "format": "int32", "nullable": true}, "scoreShift": {"type": "number", "description": "Additive offset applied to displayed scores on the overall scoreboard of this\n benchmark.", "format": "double"}, "scoreScale": {"type": "number", "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on the overall scoreboard of this benchmark. Must be strictly positive.", "format": "double"}}}, "UpdateBenchmarkNameEndpoint_Input": {"required": ["name"], "type": "object", "properties": {"name": {"type": "string", "description": "The new name of the benchmark."}}}, "UpdateLeaderboardEndpoint_Input": {"type": "object", "properties": {"name": {"type": "string", "description": "The new name of the leaderboard."}, "responseBudget": {"type": "integer", "description": "The response budget collected when onboarding a new participant.", "format": "int32"}, "minResponses": {"type": "integer", "description": "The minimum responses collected per matchup.", "format": "int32"}, "priority": {"type": "integer", "description": "Priority override applied to every run's job. Admin-only. Pass null to clear\n the override and fall back to the default leaderboard priority.", "format": "int32", "nullable": true}, "weight": {"type": "number", "description": "Multiplier applied to every match result of this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards. Unbounded; negative and zero\n values are accepted.", "format": "double"}, "scoreShift": {"type": "number", "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard.", "format": "double"}, "scoreScale": {"type": "number", "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard. Must be strictly positive.", "format": "double"}, "isHidden": {"type": "boolean", "description": "Whether the leaderboard is hidden from non-admins in listings and reads. Admin-only."}, "isExcludedFromOverall": {"type": "boolean", "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard.\n When set, the leaderboard becomes an owner-only private experiment: its results do not\n contribute to the overall and it is visible only to its owner and admins."}, "voteAggregation": {"allOf": [{"$ref": "#/components/schemas/VoteAggregation"}], "description": "How individual votes on a matchup are aggregated into the stored result. AllVotes\n counts every vote as a matchup; MajorityVote collapses each matchup to a single\n win for the majority side (ties split 0.5/0.5). Only affects future runs."}}}, "UpdateLeaderboardNameEndpoint_Input": {"required": ["name"], "type": "object", "properties": {"name": {"type": "string", "description": "The new name of the leaderboard."}}}, "UpdateLeaderboardResponseConfigEndpoint_Input": {"required": ["responseBudget", "minResponses"], "type": "object", "properties": {"responseBudget": {"type": "integer", "description": "The response budget collected when onboarding a new participant.", "format": "int32"}, "minResponses": {"type": "integer", "description": "The minimum responses collected per matchup.", "format": "int32"}}}, "UpdateParticipantEndpoint_Input": {"type": "object", "properties": {"name": {"type": "string", "description": "The new name of the participant."}, "family": {"type": "string", "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"). Pass null to clear.", "nullable": true}, "proprietaryName": {"type": "string", "description": "The vendor-facing display name of the model. Pass null to clear.", "nullable": true}, "logo": {"oneOf": [{"$ref": "#/components/schemas/ExistingAssetInput"}, {"nullable": true}], "description": "An image asset for the model's logo. Pass null to clear."}, "faucet": {"allOf": [{"$ref": "#/components/schemas/IFaucetInput"}], "description": "The faucet to set or replace on the participant."}}}, "UpdateParticipantNameEndpoint_Input": {"required": ["name"], "type": "object", "properties": {"name": {"type": "string", "description": "The new name of the participant."}}}, "UpdatePromptTagsEndpoint_Input": {"required": ["tags"], "type": "object", "properties": {"tags": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The list of tags to be associated with the prompt."}}}, "VoteAggregation": {"enum": ["AllVotes", "MajorityVote"]}, "VoteMatrixResult": {"required": ["index", "columns", "data"], "type": "object", "properties": {"index": {"type": "array", "items": {"type": "string"}}, "columns": {"type": "array", "items": {"type": "string"}}, "data": {"type": "array", "items": {"type": "array", "items": {"type": "number", "format": "double"}}}}}, "AgeUserFilterModel_AgeGroup": {"enum": ["0-17", "18-29", "30-39", "40-49", "50-64", "65+"]}, "AggregatorType": {"enum": ["NonCommittal", "MajorityVote", "SimpleMatchup", "LocateCluster", "Classification", "Locate", "BoundingBox", "Line", "Transcription", "SinglePointLocate", "FreeText", "Scrub", "Ranking", "MultiRanking", null]}, "AttachCategoryRapidBlueprint_Category": {"required": ["label", "value"], "type": "object", "properties": {"label": {"type": "string"}, "value": {"type": "string"}}}, "CloneOrderEndpoint_Input": {"required": ["orderName"], "type": "object", "properties": {"orderName": {"type": "string", "description": "The name of the new cloned order."}}}, "CloneOrderEndpoint_Output": {"required": ["orderId"], "type": "object", "properties": {"datasetId": {"type": "string", "description": "The dataset ID of the cloned order.", "nullable": true}, "orderId": {"type": "string", "description": "The ID of the newly cloned order."}}}, "ConditionalValidationSelection_ValidationChance": {"required": ["userScoreThreshold", "chance", "rapidCount"], "type": "object", "properties": {"userScoreThreshold": {"type": "number", "format": "double"}, "chance": {"type": "number", "format": "double"}, "rapidCount": {"type": "integer", "format": "int32"}, "selections": {"type": "array", "items": {"$ref": "#/components/schemas/ISelection"}, "nullable": true}}}, "CreateComplexOrderEndpoint_Input": {"required": ["orderName", "pipeline"], "type": "object", "properties": {"orderName": {"type": "string", "description": "The name of the order."}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/IPipelineModel"}], "description": "The pipeline configuration to use."}, "isDemo": {"type": "boolean", "description": "Whether the order is a demo."}, "precedingOrderId": {"type": "string", "description": "Optional ID of the order that must complete before this order starts processing.", "nullable": true}}}, "CreateComplexOrderEndpoint_Output": {"required": ["orderId", "pipelineId"], "type": "object", "properties": {"datasetId": {"type": "string", "description": "The dataset ID of the created order.", "nullable": true}, "orderId": {"type": "string", "description": "The ID of the created order."}, "campaignId": {"type": "string", "description": "The campaign ID of the created order.", "nullable": true}, "pipelineId": {"type": "string", "description": "The pipeline ID of the created order."}}}, "CreateJobDefinitionEndpoint_Input": {"required": ["definitionName", "workflow", "referee", "datasetId"], "type": "object", "properties": {"definitionName": {"type": "string", "description": "The name of the definition."}, "workflow": {"allOf": [{"$ref": "#/components/schemas/IOrderWorkflowInputModel"}], "description": "The workflow configuration."}, "referee": {"allOf": [{"$ref": "#/components/schemas/IRefereeModel"}], "description": "The referee configuration."}, "datasetId": {"type": "string", "description": "The dataset id."}, "rapidFeatureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "The feature flags that apply to each rapid created by this definition."}, "campaignFeatureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "The feature flags that apply to the campaign (session-wide) for this definition."}, "aggregatorType": {"allOf": [{"$ref": "#/components/schemas/AggregatorType"}], "description": "The aggregator type."}}, "description": "The input for the create job definition endpoint."}, "CreateJobDefinitionEndpoint_Output": {"required": ["definitionId", "pipelineId"], "type": "object", "properties": {"definitionId": {"type": "string", "description": "The id of the created job definition."}, "pipelineId": {"type": "string", "description": "The id of the created preview pipeline."}}, "description": "The result when a job definition has been created."}, "CreateJobEndpoint_Input": {"required": ["jobDefinitionId", "audienceId"], "type": "object", "properties": {"jobDefinitionId": {"type": "string", "description": "The id of the job definition to use."}, "audienceId": {"type": "string", "description": "The id of the audience to target."}, "revisionNumber": {"type": "integer", "description": "The revision number to use. If not specified, the latest revision will be used.", "format": "int32", "nullable": true}, "name": {"type": "string", "description": "The name of the job. If not specified, defaults to \"{definition name}:{revision number}\".", "nullable": true}, "priority": {"type": "integer", "description": "The priority of the job. Higher values mean higher priority. Default is 50.", "format": "int32"}, "precedingJobId": {"type": "string", "description": "Optional id of a job that must finish before this job starts. When set, this job is\n queued until the preceding job completes or fails.", "nullable": true}, "notifyOwnerOnCompletion": {"type": "boolean", "description": "Whether the job's owner should be emailed when the job completes. Defaults to false."}}, "description": "The input for the create job endpoint."}, "CreateJobEndpoint_Output": {"required": ["jobId", "recruitingStarted"], "type": "object", "properties": {"jobId": {"type": "string", "description": "The id of the created job."}, "recruitingStarted": {"type": "boolean", "description": "Whether recruiting was automatically started for the audience."}}, "description": "The result when a job has been created."}, "CreateJobRevisionEndpoint_Input": {"type": "object", "properties": {"workflow": {"allOf": [{"$ref": "#/components/schemas/IOrderWorkflowInputModel"}], "description": "The workflow configuration. If not provided, inherits from the previous revision.\n Must be provided together with Referee if either is specified."}, "referee": {"allOf": [{"$ref": "#/components/schemas/IRefereeModel"}], "description": "The referee configuration. If not provided, inherits from the previous revision.\n Must be provided together with Workflow if either is specified."}, "datasetId": {"type": "string", "description": "The dataset id. If not provided, inherits from the previous revision."}, "rapidFeatureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "The rapid-level feature flags applied to each rapid created by this revision.\n If not provided, inherits from the previous revision."}, "campaignFeatureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "The campaign-level (session-wide) feature flags for this revision.\n If not provided, inherits from the previous revision."}, "aggregatorType": {"oneOf": [{"$ref": "#/components/schemas/AggregatorType"}, {"nullable": true}], "description": "The aggregator type. If not provided, inherits from the previous revision."}, "validationSetId": {"type": "string", "description": "A validation set id to pin on this revision. When set, every job run from this\n revision uses the specified validation set as the source of validation rapids\n instead of audience-derived examples. If not provided, inherits from the previous\n revision. Provide a wrapped null value to clear a previously pinned set.", "nullable": true}}, "description": "The input for the create job revision endpoint."}, "CreateJobRevisionEndpoint_Output": {"required": ["revisionNumber", "pipelineId"], "type": "object", "properties": {"revisionNumber": {"type": "integer", "description": "The revision number of the created job revision.", "format": "int32"}, "pipelineId": {"type": "string", "description": "The id of the created preview pipeline."}}, "description": "The result when a job revision has been created."}, "CreateOrderEndpoint_Output": {"required": ["orderId", "pipelineId"], "type": "object", "properties": {"datasetId": {"type": "string", "description": "The dataset ID of the created order.", "nullable": true}, "orderId": {"type": "string", "description": "The ID of the created order."}, "campaignId": {"type": "string", "description": "The campaign ID of the created order.", "nullable": true}, "pipelineId": {"type": "string", "description": "The pipeline ID of the created order."}}}, "CreateOrderModel": {"required": ["orderName", "workflow", "referee"], "type": "object", "properties": {"orderName": {"type": "string", "description": "The name is used as an identifier for an order and can be freely chosen."}, "workflow": {"allOf": [{"$ref": "#/components/schemas/IOrderWorkflowInputModel"}], "description": "The workflow helps to determine the tasks that need to be completed by the users."}, "referee": {"allOf": [{"$ref": "#/components/schemas/IRefereeModel"}], "description": "The referee is used to determine how many votes will be collected."}, "aggregator": {"allOf": [{"$ref": "#/components/schemas/AggregatorType"}], "description": "The aggregator is used to determine how the data will be aggregated. The default behavior is enough for most cases"}, "rapidFeatureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}, "nullable": true}], "description": "The feature flags that apply to each rapid created by this order."}, "campaignFeatureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}, "nullable": true}], "description": "The feature flags that apply to the campaign (session-wide) for this order."}, "priority": {"type": "integer", "description": "The priority is used to prioritize over other orders.", "format": "int32", "nullable": true}, "stickyConfig": {"allOf": [{"$ref": "#/components/schemas/StickyConfig"}], "description": "Configuration for sticky campaign behavior. Takes precedence over StickyState if both are provided."}, "userScoreDimensions": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "The user score dimensions are used to determine the score of the responses from the user."}, "demographicKeys": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "The demographic keys are used to determine which demographics to store on the responses from the user."}, "userFilters": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/IUserFilterModel"}, "nullable": true}], "description": "The user filters are used to restrict the order to only collect votes from a specific demographic."}, "validationSetId": {"type": "string", "description": "The validation set id can be changed to point to a specific validation set. if not provided a sane default will be\n used.", "nullable": true}, "selections": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/ISelection"}, "nullable": true}], "description": "The selections are used to determine which tasks are shown to a user."}, "retrievalMode": {"allOf": [{"$ref": "#/components/schemas/RetrievalMode"}], "description": "The retrieval mode defines how rapids are retrieved from the active labeling pool."}, "maxIterations": {"type": "integer", "description": "The maximum number of times a user is allowed to see the same rapid.", "format": "int32", "nullable": true}, "precedingOrderId": {"type": "string", "description": "Optional ID of the order that must complete before this order starts processing.", "nullable": true}}, "description": "This model is used to create a simple order"}, "CreateUnsupportedOrderEndpoint_Input": {"required": ["orderName", "dataType", "labelType"], "type": "object", "properties": {"orderName": {"type": "string", "description": "The name of the order."}, "dataType": {"type": "string", "description": "The type of data that was attempted to be ordered."}, "labelType": {"type": "string", "description": "The type of labels that were attempted to be ordered."}}}, "DefinitionType": {"enum": ["Unknown", "Classify", "Compare", "BoundingBox", "Line", "Polygon", "Locate", "Transcription", "NamedEntity", "FreeText", "Scrub", "Ranking", "GroupedRanking", "Evaluation"]}, "EloConfigModel": {"required": ["startingScore", "kFactor", "scalingFactor"], "type": "object", "properties": {"startingScore": {"type": "integer", "format": "int32"}, "kFactor": {"type": "integer", "format": "int32"}, "scalingFactor": {"type": "integer", "format": "int32"}}}, "GenderUserFilterModel_Gender": {"enum": ["Male", "Female", "Other"]}, "GetJobByIdEndpoint_Output": {"required": ["jobId", "name", "definitionId", "audienceId", "revisionNumber", "pipelineId", "state", "isPublic", "createdAt", "ownerId", "ownerMail"], "type": "object", "properties": {"jobId": {"type": "string", "description": "The job id."}, "name": {"type": "string", "description": "The job name."}, "definitionId": {"type": "string", "description": "The job definition id."}, "audienceId": {"type": "string", "description": "The audience id."}, "revisionNumber": {"type": "integer", "description": "The revision number.", "format": "int32"}, "pipelineId": {"type": "string", "description": "The pipeline id."}, "state": {"allOf": [{"$ref": "#/components/schemas/AudienceJobState"}], "description": "The job state."}, "isPublic": {"type": "boolean", "description": "Whether the job (and its results) is shared publicly."}, "completedAt": {"type": "string", "description": "The timestamp when the job was completed.", "format": "date-time", "nullable": true}, "resultFileName": {"type": "string", "description": "The file name of the result.", "nullable": true}, "failedAt": {"type": "string", "description": "The timestamp when the job failed.", "format": "date-time", "nullable": true}, "failureMessage": {"type": "string", "description": "The failure message.", "nullable": true}, "createdAt": {"type": "string", "description": "The creation timestamp.", "format": "date-time"}, "ownerId": {"type": "string", "description": "The owner id.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The owner email."}}, "description": "The result when a job has been retrieved."}, "GetJobDefinitionByIdEndpoint_Output": {"required": ["definitionId", "name", "definitionType", "isPublic", "createdAt", "ownerId", "ownerMail"], "type": "object", "properties": {"definitionId": {"type": "string", "description": "The job definition id."}, "name": {"type": "string", "description": "The name of the job definition."}, "definitionType": {"allOf": [{"$ref": "#/components/schemas/DefinitionType"}], "description": "The type of the job definition."}, "isPublic": {"type": "boolean", "description": "Whether the definition is shared publicly as a reusable template."}, "createdAt": {"type": "string", "description": "The creation timestamp.", "format": "date-time"}, "ownerId": {"type": "string", "description": "The id of the job definition's owner.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The email of the job definition's owner."}}, "description": "The result when a job definition has been retrieved."}, "GetJobRevisionEndpoint_Output": {"required": ["definitionId", "revisionNumber", "state", "pipelineId", "datasetId", "workflow", "referee", "featureFlags", "createdAt", "createdById", "createdByMail"], "type": "object", "properties": {"definitionId": {"type": "string", "description": "The job definition id."}, "revisionNumber": {"type": "integer", "description": "The revision number.", "format": "int32"}, "state": {"allOf": [{"$ref": "#/components/schemas/JobDefinitionRevisionState"}], "description": "The state of the revision."}, "pipelineId": {"type": "string", "description": "The pipeline id."}, "datasetId": {"type": "string", "description": "The dataset id."}, "aggregatorType": {"allOf": [{"$ref": "#/components/schemas/AggregatorType"}], "description": "The aggregator type."}, "workflow": {"allOf": [{"$ref": "#/components/schemas/IOrderWorkflowInputModel"}], "description": "The workflow configuration. Can be used directly to create a new revision."}, "referee": {"allOf": [{"$ref": "#/components/schemas/IRefereeModel"}], "description": "The referee configuration. Can be used directly to create a new revision."}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "The feature flags."}, "createdAt": {"type": "string", "description": "The creation timestamp.", "format": "date-time"}, "createdById": {"type": "string", "description": "The id of the user who created the revision.", "format": "uuid"}, "createdByMail": {"type": "string", "description": "The email of the user who created the revision."}, "isInstructionComplex": {"type": "boolean", "description": "Whether the instruction was flagged as too complex for the average annotator to\n understand. Null until the asynchronous complexity check has completed.", "nullable": true}, "instructionComplexityReason": {"type": "string", "description": "A short explanation of why the instruction was flagged, when applicable.", "nullable": true}}, "description": "The result when a job revision has been retrieved."}, "GetOrderByIdEndpoint_Output": {"required": ["orderName", "customerMail", "orderDate", "state", "pipelineId", "isLocked", "isPublic"], "type": "object", "properties": {"orderName": {"type": "string", "description": "The name of the order."}, "customerMail": {"type": "string", "description": "The email of the customer who placed the order."}, "orderDate": {"type": "string", "description": "The date the order was placed.", "format": "date-time"}, "state": {"type": "string", "description": "The current state of the order."}, "pipelineId": {"type": "string", "description": "The ID of the pipeline associated with the order."}, "isLocked": {"type": "boolean", "description": "Whether the order is locked."}, "isPublic": {"type": "boolean", "description": "Whether the order is publicly visible."}, "failureMessage": {"type": "string", "description": "The failure message if the order failed.", "nullable": true}}}, "GetPublicOrdersEndpoint_OrderOutput": {"required": ["id", "name", "isPublic"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "isPublic": {"type": "boolean"}}}, "GetPublicOrdersEndpoint_Output": {"required": ["orders"], "type": "object", "properties": {"orders": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetPublicOrdersEndpoint_OrderOutput"}}], "description": "The list of publicly available orders."}}}, "IDatasetModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IDatasetModelCloneDatasetModel"}], "discriminator": {"propertyName": "_t", "mapping": {"CloneDatasetModel": "#/components/schemas/IDatasetModelCloneDatasetModel"}}}, "IDatasetModelCloneDatasetModel": {"required": ["datasetToCloneId", "datasetName", "_t"], "properties": {"_t": {"enum": ["CloneDatasetModel"], "type": "string"}, "datasetToCloneId": {"type": "string"}, "datasetName": {"type": "string"}}}, "IOrderWorkflowInputModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IOrderWorkflowInputModelEvaluationWorkflowInputModel"}, {"$ref": "#/components/schemas/IOrderWorkflowInputModelGroupedRankingWorkflowInputModel"}, {"$ref": "#/components/schemas/IOrderWorkflowInputModelSimpleWorkflowInputModel"}], "discriminator": {"propertyName": "_t", "mapping": {"EvaluationWorkflow": "#/components/schemas/IOrderWorkflowInputModelEvaluationWorkflowInputModel", "GroupedRankingWorkflow": "#/components/schemas/IOrderWorkflowInputModelGroupedRankingWorkflowInputModel", "SimpleWorkflow": "#/components/schemas/IOrderWorkflowInputModelSimpleWorkflowInputModel"}}}, "IOrderWorkflowInputModelEvaluationWorkflowInputModel": {"required": ["validationSetId", "shouldAcceptIncorrect", "_t"], "properties": {"_t": {"enum": ["EvaluationWorkflow"], "type": "string"}, "validationSetId": {"type": "string"}, "shouldAcceptIncorrect": {"type": "boolean"}, "featureFlags": {"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}}}, "IOrderWorkflowInputModelGroupedRankingWorkflowInputModel": {"required": ["criteria", "_t"], "properties": {"_t": {"enum": ["GroupedRankingWorkflow"], "type": "string"}, "criteria": {"type": "string"}, "pairMakerConfig": {"$ref": "#/components/schemas/IPairMakerConfigModel"}, "rankingConfig": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/IRankingConfigModel"}]}, "contexts": {"type": "object", "additionalProperties": {"type": "string"}, "nullable": true}, "contextAssets": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/IAssetInput"}, "nullable": true}, "featureFlags": {"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}, "maxParallelism": {"type": "integer", "format": "int32"}}}, "IOrderWorkflowInputModelSimpleWorkflowInputModel": {"required": ["blueprint", "_t"], "properties": {"_t": {"enum": ["SimpleWorkflow"], "type": "string"}, "blueprint": {"$ref": "#/components/schemas/IRapidBlueprint"}, "batchSize": {"type": "integer", "format": "int32", "nullable": true}, "featureFlags": {"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}}}, "IPairMakerConfigModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IPairMakerConfigModelFullPermutationPairMakerConfigModel"}, {"$ref": "#/components/schemas/IPairMakerConfigModelOnlinePairMakerConfigModel"}], "discriminator": {"propertyName": "_t", "mapping": {"FullPermutationPairMaker": "#/components/schemas/IPairMakerConfigModelFullPermutationPairMakerConfigModel", "OnlinePairMaker": "#/components/schemas/IPairMakerConfigModelOnlinePairMakerConfigModel"}}}, "IPairMakerConfigModelFullPermutationPairMakerConfigModel": {"required": ["_t"], "properties": {"_t": {"enum": ["FullPermutationPairMaker"], "type": "string"}}}, "IPairMakerConfigModelOnlinePairMakerConfigModel": {"required": ["_t"], "properties": {"_t": {"enum": ["OnlinePairMaker"], "type": "string"}, "randomMatchesRatio": {"type": "number", "format": "float"}, "totalComparisonBudget": {"type": "integer", "format": "int32"}}}, "IPipelineArtifactModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IPipelineArtifactModelCreateDatasetArtifactModel"}], "discriminator": {"propertyName": "_t", "mapping": {"CreateDatasetArtifactModel": "#/components/schemas/IPipelineArtifactModelCreateDatasetArtifactModel"}}}, "IPipelineArtifactModelCreateDatasetArtifactModel": {"required": ["identifier", "dataset", "_t"], "properties": {"_t": {"enum": ["CreateDatasetArtifactModel"], "type": "string"}, "identifier": {"type": "string"}, "dataset": {"$ref": "#/components/schemas/IDatasetModel"}}}, "IPipelineModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IPipelineModelCreateSimplePipelineModel"}], "discriminator": {"propertyName": "_t", "mapping": {"CreateSimplePipelineModel": "#/components/schemas/IPipelineModelCreateSimplePipelineModel"}}}, "IPipelineModelCreateSimplePipelineModel": {"required": ["artifacts", "pipelineSteps", "namePrefix", "_t"], "properties": {"_t": {"enum": ["CreateSimplePipelineModel"], "type": "string"}, "artifacts": {"type": "array", "items": {"$ref": "#/components/schemas/IPipelineArtifactModel"}}, "pipelineSteps": {"type": "array", "items": {"$ref": "#/components/schemas/IPipelineStepModel"}}, "namePrefix": {"type": "string"}}}, "IPipelineStepModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IPipelineStepModelDatasetEvaluationStepModel"}, {"$ref": "#/components/schemas/IPipelineStepModelSendCompletionMailStepModel"}, {"$ref": "#/components/schemas/IPipelineStepModelWorkflowAggregationStepModel"}, {"$ref": "#/components/schemas/IPipelineStepModelWorkflowLabelingStepModel"}], "discriminator": {"propertyName": "_t", "mapping": {"DatasetEvaluationStepModel": "#/components/schemas/IPipelineStepModelDatasetEvaluationStepModel", "SendCompletionMailStepModel": "#/components/schemas/IPipelineStepModelSendCompletionMailStepModel", "WorkflowAggregationStepModel": "#/components/schemas/IPipelineStepModelWorkflowAggregationStepModel", "WorkflowLabelingStepModel": "#/components/schemas/IPipelineStepModelWorkflowLabelingStepModel"}}}, "IPipelineStepModelDatasetEvaluationStepModel": {"required": ["datasetArtifactId", "aggregationResultFileArtifactId", "evaluationResultFileArtifactId", "receiver", "_t"], "properties": {"_t": {"enum": ["DatasetEvaluationStepModel"], "type": "string"}, "datasetArtifactId": {"type": "string"}, "aggregationResultFileArtifactId": {"type": "string"}, "evaluationResultFileArtifactId": {"type": "string"}, "receiver": {"type": "string"}}}, "IPipelineStepModelSendCompletionMailStepModel": {"required": ["receiver", "resultsFileArtifactIdentifier", "_t"], "properties": {"_t": {"enum": ["SendCompletionMailStepModel"], "type": "string"}, "receiver": {"type": "string"}, "resultsFileArtifactIdentifier": {"type": "string"}}}, "IPipelineStepModelWorkflowAggregationStepModel": {"required": ["campaignArtifactId", "workflowArtifactId", "fileArtifactId", "_t"], "properties": {"_t": {"enum": ["WorkflowAggregationStepModel"], "type": "string"}, "campaignArtifactId": {"type": "string"}, "workflowArtifactId": {"type": "string"}, "fileArtifactId": {"type": "string"}, "aggregatorType": {"$ref": "#/components/schemas/AggregatorType"}, "demographicKeys": {"type": "array", "items": {"type": "string"}, "nullable": true}}}, "IPipelineStepModelWorkflowLabelingStepModel": {"required": ["workflowArtifactId", "_t"], "properties": {"_t": {"enum": ["WorkflowLabelingStepModel"], "type": "string"}, "workflowArtifactId": {"type": "string"}}}, "IRankingConfigModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IRankingConfigModelBradleyTerryRankingConfigModel"}, {"$ref": "#/components/schemas/IRankingConfigModelEloConfigModel"}], "discriminator": {"propertyName": "_t", "mapping": {"BradleyTerryRankingConfig": "#/components/schemas/IRankingConfigModelBradleyTerryRankingConfigModel", "EloConfig": "#/components/schemas/IRankingConfigModelEloConfigModel"}}}, "IRankingConfigModelBradleyTerryRankingConfigModel": {"required": ["startingScore", "_t"], "properties": {"_t": {"enum": ["BradleyTerryRankingConfig"], "type": "string"}, "startingScore": {"type": "integer", "format": "int32"}}}, "IRankingConfigModelEloConfigModel": {"required": ["startingScore", "kFactor", "scalingFactor", "_t"], "properties": {"_t": {"enum": ["EloConfig"], "type": "string"}, "startingScore": {"type": "integer", "format": "int32"}, "kFactor": {"type": "integer", "format": "int32"}, "scalingFactor": {"type": "integer", "format": "int32"}}}, "IRapidBlueprint": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IRapidBlueprintAttachCategoryRapidBlueprint"}, {"$ref": "#/components/schemas/IRapidBlueprintBoundingBoxRapidBlueprint"}, {"$ref": "#/components/schemas/IRapidBlueprintCompareRapidBlueprint"}, {"$ref": "#/components/schemas/IRapidBlueprintFreeTextRapidBlueprint"}, {"$ref": "#/components/schemas/IRapidBlueprintLineRapidBlueprint"}, {"$ref": "#/components/schemas/IRapidBlueprintLocateRapidBlueprint"}, {"$ref": "#/components/schemas/IRapidBlueprintNamedEntityRapidBlueprint"}, {"$ref": "#/components/schemas/IRapidBlueprintPolygonRapidBlueprint"}, {"$ref": "#/components/schemas/IRapidBlueprintScrubRapidBlueprint"}, {"$ref": "#/components/schemas/IRapidBlueprintTranscriptionRapidBlueprint"}], "discriminator": {"propertyName": "_t", "mapping": {"ClassifyBlueprint": "#/components/schemas/IRapidBlueprintAttachCategoryRapidBlueprint", "BoundingBoxBlueprint": "#/components/schemas/IRapidBlueprintBoundingBoxRapidBlueprint", "CompareBlueprint": "#/components/schemas/IRapidBlueprintCompareRapidBlueprint", "FreeTextBlueprint": "#/components/schemas/IRapidBlueprintFreeTextRapidBlueprint", "LineBlueprint": "#/components/schemas/IRapidBlueprintLineRapidBlueprint", "LocateBlueprint": "#/components/schemas/IRapidBlueprintLocateRapidBlueprint", "NamedEntityBlueprint": "#/components/schemas/IRapidBlueprintNamedEntityRapidBlueprint", "PolygonBlueprint": "#/components/schemas/IRapidBlueprintPolygonRapidBlueprint", "ScrubBlueprint": "#/components/schemas/IRapidBlueprintScrubRapidBlueprint", "TranscriptionBlueprint": "#/components/schemas/IRapidBlueprintTranscriptionRapidBlueprint"}}}, "IRapidBlueprintAttachCategoryRapidBlueprint": {"required": ["categories", "title", "_t"], "properties": {"_t": {"enum": ["ClassifyBlueprint"], "type": "string"}, "categories": {"type": "array", "items": {"$ref": "#/components/schemas/AttachCategoryRapidBlueprint_Category"}}, "possibleCategories": {"type": "array", "items": {"type": "string"}, "nullable": true}, "title": {"type": "string"}}}, "IRapidBlueprintBoundingBoxRapidBlueprint": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["BoundingBoxBlueprint"], "type": "string"}, "target": {"type": "string"}}}, "IRapidBlueprintCompareRapidBlueprint": {"required": ["criteria", "_t"], "properties": {"_t": {"enum": ["CompareBlueprint"], "type": "string"}, "criteria": {"type": "string"}, "indexIdentifiers": {"type": "array", "items": {"type": "string"}, "nullable": true}}}, "IRapidBlueprintFreeTextRapidBlueprint": {"required": ["question", "_t"], "properties": {"_t": {"enum": ["FreeTextBlueprint"], "type": "string"}, "question": {"type": "string"}, "shouldValidateResponse": {"type": "boolean", "nullable": true}, "validationSystemPrompt": {"type": "string", "nullable": true}}}, "IRapidBlueprintLineRapidBlueprint": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["LineBlueprint"], "type": "string"}, "target": {"type": "string"}}}, "IRapidBlueprintLocateRapidBlueprint": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["LocateBlueprint"], "type": "string"}, "target": {"type": "string"}}}, "IRapidBlueprintNamedEntityRapidBlueprint": {"required": ["target", "classes", "_t"], "properties": {"_t": {"enum": ["NamedEntityBlueprint"], "type": "string"}, "target": {"type": "string"}, "classes": {"type": "array", "items": {"type": "string"}}}}, "IRapidBlueprintPolygonRapidBlueprint": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["PolygonBlueprint"], "type": "string"}, "target": {"type": "string"}}}, "IRapidBlueprintScrubRapidBlueprint": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["ScrubBlueprint"], "type": "string"}, "target": {"type": "string"}}}, "IRapidBlueprintTranscriptionRapidBlueprint": {"required": ["title", "_t"], "properties": {"_t": {"enum": ["TranscriptionBlueprint"], "type": "string"}, "title": {"type": "string"}}}, "IRefereeModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IRefereeModelBudgetRefereeModel"}, {"$ref": "#/components/schemas/IRefereeModelEarlyStoppingRefereeModel"}, {"$ref": "#/components/schemas/IRefereeModelNaiveRefereeModel"}, {"$ref": "#/components/schemas/IRefereeModelQuorumRefereeModel"}], "discriminator": {"propertyName": "_t", "mapping": {"BudgetReferee": "#/components/schemas/IRefereeModelBudgetRefereeModel", "EarlyStoppingReferee": "#/components/schemas/IRefereeModelEarlyStoppingRefereeModel", "NaiveReferee": "#/components/schemas/IRefereeModelNaiveRefereeModel", "QuorumReferee": "#/components/schemas/IRefereeModelQuorumRefereeModel"}}}, "IRefereeModelBudgetRefereeModel": {"required": ["totalBudget", "_t"], "properties": {"_t": {"enum": ["BudgetReferee"], "type": "string"}, "totalBudget": {"type": "integer", "format": "int32"}}}, "IRefereeModelEarlyStoppingRefereeModel": {"required": ["maxVotes", "threshold", "_t"], "properties": {"_t": {"enum": ["EarlyStoppingReferee"], "type": "string"}, "maxVotes": {"type": "integer", "format": "int32"}, "threshold": {"type": "number", "format": "double"}}}, "IRefereeModelNaiveRefereeModel": {"required": ["totalVotes", "_t"], "properties": {"_t": {"enum": ["NaiveReferee"], "type": "string"}, "totalVotes": {"type": "integer", "format": "int32"}}}, "IRefereeModelQuorumRefereeModel": {"required": ["maxVotes", "threshold", "_t"], "properties": {"_t": {"enum": ["QuorumReferee"], "type": "string"}, "maxVotes": {"type": "integer", "format": "int32"}, "threshold": {"type": "integer", "format": "int32"}}}, "ISelection": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/ISelectionAbTestSelection"}, {"$ref": "#/components/schemas/ISelectionCappedSelection"}, {"$ref": "#/components/schemas/ISelectionConditionalValidationSelection"}, {"$ref": "#/components/schemas/ISelectionDemographicSelection"}, {"$ref": "#/components/schemas/ISelectionEffortCappedSelection"}, {"$ref": "#/components/schemas/ISelectionLabelingSelection"}, {"$ref": "#/components/schemas/ISelectionShufflingSelection"}, {"$ref": "#/components/schemas/ISelectionStaticSelection"}, {"$ref": "#/components/schemas/ISelectionValidationSelection"}], "discriminator": {"propertyName": "_t", "mapping": {"AbTestSelection": "#/components/schemas/ISelectionAbTestSelection", "CappedSelection": "#/components/schemas/ISelectionCappedSelection", "ConditionalValidationSelection": "#/components/schemas/ISelectionConditionalValidationSelection", "DemographicSelection": "#/components/schemas/ISelectionDemographicSelection", "EffortCappedSelection": "#/components/schemas/ISelectionEffortCappedSelection", "LabelingSelection": "#/components/schemas/ISelectionLabelingSelection", "ShufflingSelection": "#/components/schemas/ISelectionShufflingSelection", "StaticSelection": "#/components/schemas/ISelectionStaticSelection", "ValidationSelection": "#/components/schemas/ISelectionValidationSelection"}}}, "ISelectionAbTestSelection": {"required": ["a", "b", "_t"], "properties": {"_t": {"enum": ["AbTestSelection"], "type": "string"}, "a": {"type": "array", "items": {"$ref": "#/components/schemas/ISelection"}}, "b": {"type": "array", "items": {"$ref": "#/components/schemas/ISelection"}}}}, "ISelectionCappedSelection": {"required": ["selections", "maxRapids", "_t"], "properties": {"_t": {"enum": ["CappedSelection"], "type": "string"}, "selections": {"type": "array", "items": {"$ref": "#/components/schemas/ISelection"}}, "maxRapids": {"type": "integer", "format": "int32"}}}, "ISelectionConditionalValidationSelection": {"required": ["validationSetId", "validationChances", "_t"], "properties": {"_t": {"enum": ["ConditionalValidationSelection"], "type": "string"}, "validationSetId": {"type": "string"}, "validationChances": {"type": "array", "items": {"$ref": "#/components/schemas/ConditionalValidationSelection_ValidationChance"}}, "dimensions": {"type": "array", "items": {"type": "string"}}}}, "ISelectionDemographicSelection": {"required": ["keys", "_t"], "properties": {"_t": {"enum": ["DemographicSelection"], "type": "string"}, "keys": {"type": "array", "items": {"type": "string"}}, "maxRapids": {"type": "integer", "format": "int32"}}}, "ISelectionEffortCappedSelection": {"required": ["effortBudget", "_t"], "properties": {"_t": {"enum": ["EffortCappedSelection"], "type": "string"}, "effortBudget": {"type": "integer", "format": "int32"}, "retrievalMode": {"$ref": "#/components/schemas/RetrievalMode"}, "maxIterations": {"type": "integer", "format": "int32", "nullable": true}}}, "ISelectionLabelingSelection": {"required": ["_t"], "properties": {"_t": {"enum": ["LabelingSelection"], "type": "string"}, "amount": {"type": "integer", "format": "int32", "nullable": true}, "effortBudget": {"type": "integer", "format": "int32"}, "retrievalMode": {"$ref": "#/components/schemas/RetrievalMode"}, "maxIterations": {"type": "integer", "format": "int32", "nullable": true}}}, "ISelectionShufflingSelection": {"required": ["selections", "_t"], "properties": {"_t": {"enum": ["ShufflingSelection"], "type": "string"}, "selections": {"type": "array", "items": {"$ref": "#/components/schemas/ISelection"}}}}, "ISelectionStaticSelection": {"required": ["rapidIds", "_t"], "properties": {"_t": {"enum": ["StaticSelection"], "type": "string"}, "rapidIds": {"type": "array", "items": {"type": "string"}}}}, "ISelectionValidationSelection": {"required": ["amount", "validationSetId", "_t"], "properties": {"_t": {"enum": ["ValidationSelection"], "type": "string"}, "amount": {"type": "integer", "format": "int32"}, "validationSetId": {"type": "string"}}}, "IUserFilterModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IUserFilterModelAgeUserFilterModel"}, {"$ref": "#/components/schemas/IUserFilterModelAndUserFilterModel"}, {"$ref": "#/components/schemas/IUserFilterModelCampaignUserFilterModel"}, {"$ref": "#/components/schemas/IUserFilterModelCountryUserFilterModel"}, {"$ref": "#/components/schemas/IUserFilterModelCustomUserFilterModel"}, {"$ref": "#/components/schemas/IUserFilterModelDeviceUserFilterModel"}, {"$ref": "#/components/schemas/IUserFilterModelGenderUserFilterModel"}, {"$ref": "#/components/schemas/IUserFilterModelLanguageUserFilterModel"}, {"$ref": "#/components/schemas/IUserFilterModelNewUserFilterModel"}, {"$ref": "#/components/schemas/IUserFilterModelNotUserFilterModel"}, {"$ref": "#/components/schemas/IUserFilterModelOrUserFilterModel"}, {"$ref": "#/components/schemas/IUserFilterModelResponseCountUserFilterModel"}, {"$ref": "#/components/schemas/IUserFilterModelUserScoreUserFilterModel"}], "discriminator": {"propertyName": "_t", "mapping": {"AgeFilter": "#/components/schemas/IUserFilterModelAgeUserFilterModel", "AndFilter": "#/components/schemas/IUserFilterModelAndUserFilterModel", "CampaignFilter": "#/components/schemas/IUserFilterModelCampaignUserFilterModel", "CountryFilter": "#/components/schemas/IUserFilterModelCountryUserFilterModel", "CustomFilter": "#/components/schemas/IUserFilterModelCustomUserFilterModel", "DeviceFilter": "#/components/schemas/IUserFilterModelDeviceUserFilterModel", "GenderFilter": "#/components/schemas/IUserFilterModelGenderUserFilterModel", "LanguageFilter": "#/components/schemas/IUserFilterModelLanguageUserFilterModel", "NewUserFilter": "#/components/schemas/IUserFilterModelNewUserFilterModel", "NotFilter": "#/components/schemas/IUserFilterModelNotUserFilterModel", "OrFilter": "#/components/schemas/IUserFilterModelOrUserFilterModel", "ResponseCountFilter": "#/components/schemas/IUserFilterModelResponseCountUserFilterModel", "UserScoreFilter": "#/components/schemas/IUserFilterModelUserScoreUserFilterModel"}}}, "IUserFilterModelAgeUserFilterModel": {"required": ["ageGroups", "_t"], "properties": {"_t": {"enum": ["AgeFilter"], "type": "string"}, "ageGroups": {"type": "array", "items": {"$ref": "#/components/schemas/AgeUserFilterModel_AgeGroup"}}}}, "IUserFilterModelAndUserFilterModel": {"required": ["filters", "_t"], "properties": {"_t": {"enum": ["AndFilter"], "type": "string"}, "filters": {"type": "array", "items": {"$ref": "#/components/schemas/IUserFilterModel"}}}}, "IUserFilterModelCampaignUserFilterModel": {"required": ["campaignIds", "_t"], "properties": {"_t": {"enum": ["CampaignFilter"], "type": "string"}, "campaignIds": {"type": "array", "items": {"type": "string"}}}}, "IUserFilterModelCountryUserFilterModel": {"required": ["countries", "_t"], "properties": {"_t": {"enum": ["CountryFilter"], "type": "string"}, "countries": {"type": "array", "items": {"type": "string"}}}}, "IUserFilterModelCustomUserFilterModel": {"required": ["identifier", "values", "_t"], "properties": {"_t": {"enum": ["CustomFilter"], "type": "string"}, "identifier": {"type": "string"}, "values": {"type": "array", "items": {"type": "string"}}}}, "IUserFilterModelDeviceUserFilterModel": {"required": ["deviceTypes", "_t"], "properties": {"_t": {"enum": ["DeviceFilter"], "type": "string"}, "deviceTypes": {"type": "array", "items": {"$ref": "#/components/schemas/DeviceType"}}}}, "IUserFilterModelGenderUserFilterModel": {"required": ["genders", "_t"], "properties": {"_t": {"enum": ["GenderFilter"], "type": "string"}, "genders": {"type": "array", "items": {"$ref": "#/components/schemas/GenderUserFilterModel_Gender"}}}}, "IUserFilterModelLanguageUserFilterModel": {"required": ["languages", "_t"], "properties": {"_t": {"enum": ["LanguageFilter"], "type": "string"}, "languages": {"type": "array", "items": {"type": "string"}}}}, "IUserFilterModelNewUserFilterModel": {"required": ["_t"], "properties": {"_t": {"enum": ["NewUserFilter"], "type": "string"}}}, "IUserFilterModelNotUserFilterModel": {"required": ["filter", "_t"], "properties": {"_t": {"enum": ["NotFilter"], "type": "string"}, "filter": {"$ref": "#/components/schemas/IUserFilterModel"}}}, "IUserFilterModelOrUserFilterModel": {"required": ["filters", "_t"], "properties": {"_t": {"enum": ["OrFilter"], "type": "string"}, "filters": {"type": "array", "items": {"$ref": "#/components/schemas/IUserFilterModel"}}}}, "IUserFilterModelResponseCountUserFilterModel": {"required": ["responseCount", "dimension", "operator", "_t"], "properties": {"_t": {"enum": ["ResponseCountFilter"], "type": "string"}, "responseCount": {"type": "integer", "format": "uint32"}, "dimension": {"type": "string"}, "operator": {"$ref": "#/components/schemas/ComparisonOperator"}}}, "IUserFilterModelUserScoreUserFilterModel": {"required": ["_t"], "properties": {"_t": {"enum": ["UserScoreFilter"], "type": "string"}, "lowerbound": {"type": "number", "format": "double"}, "upperbound": {"type": "number", "format": "double"}, "dimension": {"type": "string", "nullable": true}}}, "JobDefinitionRevisionState": {"enum": ["Pending", "Completed", "Failed"]}, "OrderState": {"enum": ["Created", "Preview", "Submitted", "ManualReview", "Queued", "Processing", "Paused", "Completed", "Cancelled", "Failed", "StaleResults"]}, "PreviewOrderEndpoint_Input": {"type": "object", "properties": {"ignoreFailedDatapoints": {"type": "boolean", "description": "Whether the order should proceed even if certain datapoints failed.", "nullable": true}}}, "QueryAggregatedJobsEndpoint_Output": {"required": ["amount", "last7Days", "lastJobDate", "lastJobName", "lastJobId", "ownerMail"], "type": "object", "properties": {"amount": {"type": "integer", "description": "The total number of jobs for this customer.", "format": "int32"}, "last7Days": {"type": "integer", "description": "The number of jobs created in the last 7 days.", "format": "int32"}, "lastJobDate": {"type": "string", "description": "The date of the most recent job.", "format": "date-time"}, "lastJobName": {"type": "string", "description": "The name of the most recent job."}, "lastJobId": {"type": "string", "description": "The ID of the most recent job."}, "ownerMail": {"type": "string", "description": "The customer's email address."}}}, "QueryAggregatedJobsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryAggregatedJobsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryAggregatedOrdersEndpoint_Output": {"required": ["amount", "last7Days", "lastOrderDate", "lastOrderName", "lastOrderId", "customerMail"], "type": "object", "properties": {"amount": {"type": "integer", "description": "The total number of orders for this customer.", "format": "int32"}, "last7Days": {"type": "integer", "description": "The number of orders placed in the last 7 days.", "format": "int32"}, "lastOrderDate": {"type": "string", "description": "The date of the most recent order.", "format": "date-time"}, "lastOrderName": {"type": "string", "description": "The name of the most recent order."}, "lastOrderId": {"type": "string", "description": "The ID of the most recent order."}, "customerMail": {"type": "string", "description": "The customer's email address."}}}, "QueryAggregatedOrdersEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryAggregatedOrdersEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryJobDefinitionsEndpoint_Output": {"required": ["definitionId", "name", "definitionType", "createdAt", "revisionCount", "ownerId", "ownerMail"], "type": "object", "properties": {"definitionId": {"type": "string", "description": "The id of the job definition."}, "name": {"type": "string", "description": "The name of the job definition."}, "definitionType": {"allOf": [{"$ref": "#/components/schemas/DefinitionType"}], "description": "The type of the job definition."}, "createdAt": {"type": "string", "description": "The creation timestamp of the job definition.", "format": "date-time"}, "revisionCount": {"type": "integer", "description": "The number of revisions for this job definition.", "format": "int32"}, "ownerId": {"type": "string", "description": "The id of the owner of the job definition.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The email of the owner of the job definition."}}}, "QueryJobDefinitionsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryJobDefinitionsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryJobRevisionsEndpoint_Output": {"required": ["definitionId", "revisionNumber", "createdAt", "state"], "type": "object", "properties": {"definitionId": {"type": "string", "description": "The id of the job definition this revision belongs to."}, "revisionNumber": {"type": "integer", "description": "The revision number.", "format": "int32"}, "createdAt": {"type": "string", "description": "The timestamp when this revision was created.", "format": "date-time"}, "state": {"allOf": [{"$ref": "#/components/schemas/JobDefinitionRevisionState"}], "description": "The current state of the revision."}}}, "QueryJobRevisionsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryJobRevisionsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryJobsEndpoint_Output": {"required": ["jobId", "name", "jobDefinitionId", "audienceId", "revisionNumber", "pipelineId", "state", "ownerMail", "createdAt"], "type": "object", "properties": {"jobId": {"type": "string", "description": "The id of the job."}, "name": {"type": "string", "description": "The name of the job."}, "jobDefinitionId": {"type": "string", "description": "The id of the job definition."}, "audienceId": {"type": "string", "description": "The id of the audience associated with the job."}, "revisionNumber": {"type": "integer", "description": "The revision number of the job.", "format": "int32"}, "pipelineId": {"type": "string", "description": "The id of the pipeline executing the job."}, "state": {"allOf": [{"$ref": "#/components/schemas/AudienceJobState"}], "description": "The current state of the job."}, "ownerMail": {"type": "string", "description": "The email of the job's owner."}, "createdAt": {"type": "string", "description": "The timestamp when the job was created.", "format": "date-time"}}}, "QueryJobsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryJobsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryOrdersEndpoint_Output": {"required": ["id", "pipelineId", "orderDate", "customerMail", "state", "orderName", "isPublic"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the order."}, "pipelineId": {"type": "string", "description": "The ID of the pipeline associated with the order."}, "orderDate": {"type": "string", "description": "The date the order was placed.", "format": "date-time", "nullable": true}, "customerMail": {"type": "string", "description": "The email of the customer who placed the order."}, "state": {"allOf": [{"$ref": "#/components/schemas/OrderState"}], "description": "The current state of the order."}, "orderName": {"type": "string", "description": "The name of the order."}, "isPublic": {"type": "boolean", "description": "Whether the order is publicly visible."}, "failureMessage": {"type": "string", "description": "The failure message if the order failed.", "nullable": true}}}, "QueryOrdersEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryOrdersEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryPublicJobDefinitionsEndpoint_Output": {"required": ["definitionId", "name", "definitionType", "createdAt", "revisionCount", "ownerId", "ownerMail"], "type": "object", "properties": {"definitionId": {"type": "string", "description": "The id of the job definition."}, "name": {"type": "string", "description": "The name of the job definition."}, "definitionType": {"allOf": [{"$ref": "#/components/schemas/DefinitionType"}], "description": "The type of the job definition."}, "createdAt": {"type": "string", "description": "The creation timestamp of the job definition.", "format": "date-time"}, "revisionCount": {"type": "integer", "description": "The number of revisions for this job definition.", "format": "int32"}, "ownerId": {"type": "string", "description": "The id of the owner of the job definition.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The email of the owner of the job definition."}}}, "QueryPublicJobDefinitionsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryPublicJobDefinitionsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "StickyConfig": {"required": ["dimension"], "type": "object", "properties": {"isEnabled": {"type": "boolean"}, "dimension": {"type": "string"}, "bypassFilters": {"type": "boolean"}, "bypassPrioritySelection": {"type": "boolean"}, "blockOtherStickyCampaigns": {"type": "boolean"}, "clearOnPause": {"type": "boolean"}}}, "StickyState": {"enum": ["None", "Temporary", "Permanent", "Passive", null]}, "SubmitFeedbackEndpoint_Input": {"required": ["feedback"], "type": "object", "properties": {"feedback": {"type": "string", "description": "The feedback text."}, "email": {"type": "string", "description": "The email of the user submitting the feedback.", "nullable": true}, "token": {"type": "string", "description": "The recaptcha token, required when the caller is not authenticated.", "nullable": true}}}, "SubmitOrderEndpoint_Input": {"type": "object", "properties": {"ignoreFailedDatapoints": {"type": "boolean", "description": "Whether the order should proceed even if certain datapoints failed.", "nullable": true}}}, "UnlockOrderEndpoint_Output": {"required": ["datasetIds"], "type": "object", "properties": {"datasetIds": {"allOf": [{"type": "object", "additionalProperties": {"type": "string"}}], "description": "The dataset IDs created by unlocking the order."}}}, "UpdateJobDefinitionEndpoint_Input": {"type": "object", "properties": {"name": {"type": "string", "description": "The new name for the job definition."}}, "description": "The input for the update job definition endpoint."}, "UpdateJobEndpoint_Input": {"type": "object", "properties": {"name": {"type": "string", "description": "The new name for the job."}}, "description": "The input for the update job endpoint."}, "UpdateOrderEndpoint_Input": {"type": "object", "properties": {"name": {"type": "string", "description": "The new name of the order, if specified."}, "precedingOrderId": {"type": "string", "description": "The ID of the order that must complete before this order starts processing.\n Set to null to clear an existing preceding order.", "nullable": true}}}, "EloRankingConfig": {"required": ["startingElo", "kFactor", "scalingFactor"], "type": "object", "properties": {"startingElo": {"type": "integer", "format": "int32"}, "kFactor": {"type": "integer", "format": "int32"}, "scalingFactor": {"type": "integer", "format": "int32"}}}, "GetPipelineByIdEndpoint_Output": {"required": ["artifacts", "featureFlags"], "type": "object", "properties": {"artifacts": {"allOf": [{"type": "object", "additionalProperties": {"$ref": "#/components/schemas/IArtifactModel"}}], "description": "The artifacts attached to the pipeline, keyed by their role."}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "The feature flags enabled for the pipeline."}}}, "IArtifactModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IArtifactModelCampaignArtifactModel"}, {"$ref": "#/components/schemas/IArtifactModelDatasetArtifactModel"}, {"$ref": "#/components/schemas/IArtifactModelFileArtifactModel"}, {"$ref": "#/components/schemas/IArtifactModelWorkflowArtifactModel"}, {"$ref": "#/components/schemas/IArtifactModelWorkflowConfigArtifactModel"}], "discriminator": {"propertyName": "_t", "mapping": {"CampaignArtifactModel": "#/components/schemas/IArtifactModelCampaignArtifactModel", "DatasetArtifactModel": "#/components/schemas/IArtifactModelDatasetArtifactModel", "FileArtifactModel": "#/components/schemas/IArtifactModelFileArtifactModel", "WorkflowArtifactModel": "#/components/schemas/IArtifactModelWorkflowArtifactModel", "WorkflowConfigArtifactModel": "#/components/schemas/IArtifactModelWorkflowConfigArtifactModel"}}}, "IArtifactModelCampaignArtifactModel": {"required": ["campaignId", "identifier", "_t"], "properties": {"_t": {"enum": ["CampaignArtifactModel"], "type": "string"}, "campaignId": {"type": "string"}, "identifier": {"type": "string"}}}, "IArtifactModelDatasetArtifactModel": {"required": ["datasetId", "identifier", "_t"], "properties": {"_t": {"enum": ["DatasetArtifactModel"], "type": "string"}, "datasetId": {"type": "string"}, "identifier": {"type": "string"}}}, "IArtifactModelFileArtifactModel": {"required": ["fileName", "identifier", "_t"], "properties": {"_t": {"enum": ["FileArtifactModel"], "type": "string"}, "fileName": {"type": "string"}, "identifier": {"type": "string"}}}, "IArtifactModelWorkflowArtifactModel": {"required": ["workflowId", "identifier", "_t"], "properties": {"_t": {"enum": ["WorkflowArtifactModel"], "type": "string"}, "workflowId": {"type": "string"}, "identifier": {"type": "string"}}}, "IArtifactModelWorkflowConfigArtifactModel": {"required": ["workflowConfig", "identifier", "_t"], "properties": {"_t": {"enum": ["WorkflowConfigArtifactModel"], "type": "string"}, "workflowConfig": {"$ref": "#/components/schemas/IWorkflowConfig"}, "identifier": {"type": "string"}}}, "IAsset": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IAssetFileAsset"}, {"$ref": "#/components/schemas/IAssetMultiAsset"}, {"$ref": "#/components/schemas/IAssetNullAsset"}, {"$ref": "#/components/schemas/IAssetTextAsset"}], "discriminator": {"propertyName": "_t", "mapping": {"FileAsset": "#/components/schemas/IAssetFileAsset", "MultiAsset": "#/components/schemas/IAssetMultiAsset", "NullAsset": "#/components/schemas/IAssetNullAsset", "TextAsset": "#/components/schemas/IAssetTextAsset"}}}, "IAssetFileAsset": {"required": ["fileName", "metadata", "_t"], "properties": {"_t": {"enum": ["FileAsset"], "type": "string"}, "fileName": {"type": "string"}, "metadata": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/IMetadata"}}}}, "IAssetMultiAsset": {"required": ["assets", "metadata", "_t"], "properties": {"_t": {"enum": ["MultiAsset"], "type": "string"}, "assets": {"type": "array", "items": {"$ref": "#/components/schemas/IAsset"}}, "metadata": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/IMetadata"}}}}, "IAssetNullAsset": {"required": ["metadata", "_t"], "properties": {"_t": {"enum": ["NullAsset"], "type": "string"}, "metadata": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/IMetadata"}}}}, "IAssetTextAsset": {"required": ["text", "metadata", "_t"], "properties": {"_t": {"enum": ["TextAsset"], "type": "string"}, "text": {"type": "string"}, "metadata": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/IMetadata"}}}}, "IMetadata": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IMetadataClassificationMetadata"}, {"$ref": "#/components/schemas/IMetadataCountMetadata"}, {"$ref": "#/components/schemas/IMetadataDurationMetadata"}, {"$ref": "#/components/schemas/IMetadataFileTypeMetadata"}, {"$ref": "#/components/schemas/IMetadataImageDimensionMetadata"}, {"$ref": "#/components/schemas/IMetadataLocationMetadata"}, {"$ref": "#/components/schemas/IMetadataOriginalFilenameMetadata"}, {"$ref": "#/components/schemas/IMetadataSourceUrlMetadata"}, {"$ref": "#/components/schemas/IMetadataStreamsMetadata"}, {"$ref": "#/components/schemas/IMetadataTextMetadata"}], "discriminator": {"propertyName": "_t", "mapping": {"ClassificationMetadata": "#/components/schemas/IMetadataClassificationMetadata", "CountMetadata": "#/components/schemas/IMetadataCountMetadata", "DurationMetadata": "#/components/schemas/IMetadataDurationMetadata", "FileTypeMetadata": "#/components/schemas/IMetadataFileTypeMetadata", "ImageDimensionMetadata": "#/components/schemas/IMetadataImageDimensionMetadata", "LocationMetadata": "#/components/schemas/IMetadataLocationMetadata", "OriginalFilenameMetadata": "#/components/schemas/IMetadataOriginalFilenameMetadata", "SourceUrlMetadata": "#/components/schemas/IMetadataSourceUrlMetadata", "StreamsMetadata": "#/components/schemas/IMetadataStreamsMetadata", "TextMetadata": "#/components/schemas/IMetadataTextMetadata"}}}, "IMetadataClassificationMetadata": {"required": ["classification", "visibilities", "_t"], "properties": {"_t": {"enum": ["ClassificationMetadata"], "type": "string"}, "classification": {"type": "string"}, "visibilities": {"$ref": "#/components/schemas/MetadataVisibilities"}}}, "IMetadataCountMetadata": {"required": ["visibilities", "_t"], "properties": {"_t": {"enum": ["CountMetadata"], "type": "string"}, "count": {"type": "integer", "format": "int32"}, "visibilities": {"$ref": "#/components/schemas/MetadataVisibilities"}}}, "IMetadataDurationMetadata": {"required": ["duration", "visibilities", "_t"], "properties": {"_t": {"enum": ["DurationMetadata"], "type": "string"}, "duration": {"type": "string", "format": "date-time"}, "visibilities": {"$ref": "#/components/schemas/MetadataVisibilities"}}}, "IMetadataFileTypeMetadata": {"required": ["fileType", "visibilities", "_t"], "properties": {"_t": {"enum": ["FileTypeMetadata"], "type": "string"}, "fileType": {"$ref": "#/components/schemas/FileType"}, "visibilities": {"$ref": "#/components/schemas/MetadataVisibilities"}}}, "IMetadataImageDimensionMetadata": {"required": ["visibilities", "_t"], "properties": {"_t": {"enum": ["ImageDimensionMetadata"], "type": "string"}, "height": {"type": "integer", "format": "int32"}, "width": {"type": "integer", "format": "int32"}, "visibilities": {"$ref": "#/components/schemas/MetadataVisibilities"}}}, "IMetadataLocationMetadata": {"required": ["visibilities", "_t"], "properties": {"_t": {"enum": ["LocationMetadata"], "type": "string"}, "x": {"type": "number", "format": "float"}, "y": {"type": "number", "format": "float"}, "visibilities": {"$ref": "#/components/schemas/MetadataVisibilities"}}}, "IMetadataOriginalFilenameMetadata": {"required": ["originalFilename", "visibilities", "_t"], "properties": {"_t": {"enum": ["OriginalFilenameMetadata"], "type": "string"}, "originalFilename": {"type": "string"}, "visibilities": {"$ref": "#/components/schemas/MetadataVisibilities"}}}, "IMetadataSourceUrlMetadata": {"required": ["url", "visibilities", "_t"], "properties": {"_t": {"enum": ["SourceUrlMetadata"], "type": "string"}, "url": {"type": "string"}, "visibilities": {"$ref": "#/components/schemas/MetadataVisibilities"}}}, "IMetadataStreamsMetadata": {"required": ["visibilities", "_t"], "properties": {"_t": {"enum": ["StreamsMetadata"], "type": "string"}, "hasAudio": {"type": "boolean"}, "hasVideo": {"type": "boolean"}, "hasSubtitles": {"type": "boolean"}, "visibilities": {"$ref": "#/components/schemas/MetadataVisibilities"}}}, "IMetadataTextMetadata": {"required": ["visibilities", "_t"], "properties": {"_t": {"enum": ["TextMetadata"], "type": "string"}, "text": {"type": "string", "nullable": true}, "visibilities": {"$ref": "#/components/schemas/MetadataVisibilities"}}}, "IPairMakerConfig": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IPairMakerConfigFullPermutationPairMakerConfig"}, {"$ref": "#/components/schemas/IPairMakerConfigOnlinePairMakerConfig"}], "discriminator": {"propertyName": "_t", "mapping": {"FullPermutationPairMakerConfig": "#/components/schemas/IPairMakerConfigFullPermutationPairMakerConfig", "OnlinePairMakerConfig": "#/components/schemas/IPairMakerConfigOnlinePairMakerConfig"}}}, "IPairMakerConfigFullPermutationPairMakerConfig": {"required": ["_t"], "properties": {"_t": {"enum": ["FullPermutationPairMakerConfig"], "type": "string"}}}, "IPairMakerConfigOnlinePairMakerConfig": {"required": ["randomMatchesRatio", "totalComparisonBudget", "_t"], "properties": {"_t": {"enum": ["OnlinePairMakerConfig"], "type": "string"}, "randomMatchesRatio": {"type": "number", "format": "float"}, "totalComparisonBudget": {"type": "integer", "format": "int32"}}}, "IRankingConfig": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IRankingConfigBradleyTerryRankingConfig"}, {"$ref": "#/components/schemas/IRankingConfigEloRankingConfig"}], "discriminator": {"propertyName": "_t", "mapping": {"BradleyTerryRankingConfig": "#/components/schemas/IRankingConfigBradleyTerryRankingConfig", "EloRankingConfig": "#/components/schemas/IRankingConfigEloRankingConfig"}}}, "IRankingConfigBradleyTerryRankingConfig": {"required": ["startingScore", "_t"], "properties": {"_t": {"enum": ["BradleyTerryRankingConfig"], "type": "string"}, "startingScore": {"type": "integer", "format": "int32"}}}, "IRankingConfigEloRankingConfig": {"required": ["startingElo", "kFactor", "scalingFactor", "_t"], "properties": {"_t": {"enum": ["EloRankingConfig"], "type": "string"}, "startingElo": {"type": "integer", "format": "int32"}, "kFactor": {"type": "integer", "format": "int32"}, "scalingFactor": {"type": "integer", "format": "int32"}}}, "IRefereeConfig": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IRefereeConfigBudgetRefereeConfig"}, {"$ref": "#/components/schemas/IRefereeConfigNaiveRefereeConfig"}, {"$ref": "#/components/schemas/IRefereeConfigNeverEndingRefereeConfig"}, {"$ref": "#/components/schemas/IRefereeConfigProbabilisticAttachCategoryRefereeConfig"}, {"$ref": "#/components/schemas/IRefereeConfigQuorumRefereeConfig"}], "discriminator": {"propertyName": "_t", "mapping": {"BudgetRefereeConfig": "#/components/schemas/IRefereeConfigBudgetRefereeConfig", "NaiveRefereeConfig": "#/components/schemas/IRefereeConfigNaiveRefereeConfig", "NeverEndingRefereeConfig": "#/components/schemas/IRefereeConfigNeverEndingRefereeConfig", "ProbabilisticAttachCategoryRefereeConfig": "#/components/schemas/IRefereeConfigProbabilisticAttachCategoryRefereeConfig", "QuorumRefereeConfig": "#/components/schemas/IRefereeConfigQuorumRefereeConfig"}}}, "IRefereeConfigBudgetRefereeConfig": {"required": ["totalBudget", "_t"], "properties": {"_t": {"enum": ["BudgetRefereeConfig"], "type": "string"}, "totalBudget": {"type": "integer", "format": "int32"}, "totalServeBudget": {"type": "integer", "format": "int32", "nullable": true}}}, "IRefereeConfigNaiveRefereeConfig": {"required": ["guessesRequired", "_t"], "properties": {"_t": {"enum": ["NaiveRefereeConfig"], "type": "string"}, "guessesRequired": {"type": "integer", "format": "int32"}}}, "IRefereeConfigNeverEndingRefereeConfig": {"required": ["_t"], "properties": {"_t": {"enum": ["NeverEndingRefereeConfig"], "type": "string"}}}, "IRefereeConfigProbabilisticAttachCategoryRefereeConfig": {"required": ["threshold", "maxVotes", "_t"], "properties": {"_t": {"enum": ["ProbabilisticAttachCategoryRefereeConfig"], "type": "string"}, "threshold": {"type": "number", "format": "double"}, "maxVotes": {"type": "integer", "format": "int32"}}}, "IRefereeConfigQuorumRefereeConfig": {"required": ["maxVotes", "threshold", "_t"], "properties": {"_t": {"enum": ["QuorumRefereeConfig"], "type": "string"}, "maxVotes": {"type": "integer", "format": "int32"}, "threshold": {"type": "integer", "format": "int32"}}}, "IWorkflowConfig": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IWorkflowConfigEvaluationWorkflowConfig"}, {"$ref": "#/components/schemas/IWorkflowConfigGroupedRankingWorkflowConfig"}, {"$ref": "#/components/schemas/IWorkflowConfigRankingWorkflowConfig"}, {"$ref": "#/components/schemas/IWorkflowConfigSimpleWorkflowConfig"}], "discriminator": {"propertyName": "_t", "mapping": {"EvaluationWorkflowConfig": "#/components/schemas/IWorkflowConfigEvaluationWorkflowConfig", "GroupedRankingWorkflowConfig": "#/components/schemas/IWorkflowConfigGroupedRankingWorkflowConfig", "RankingWorkflowConfig": "#/components/schemas/IWorkflowConfigRankingWorkflowConfig", "SimpleWorkflowConfig": "#/components/schemas/IWorkflowConfigSimpleWorkflowConfig"}}}, "IWorkflowConfigEvaluationWorkflowConfig": {"required": ["validationSetId", "referee", "shouldAcceptIncorrect", "_t"], "properties": {"_t": {"enum": ["EvaluationWorkflowConfig"], "type": "string"}, "validationSetId": {"type": "string"}, "referee": {"$ref": "#/components/schemas/IRefereeConfig"}, "shouldAcceptIncorrect": {"type": "boolean"}, "featureFlags": {"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}, "nullable": true}}}, "IWorkflowConfigGroupedRankingWorkflowConfig": {"required": ["criteria", "referee", "targetCountryCodes", "maxParallelism", "pairMakerConfig", "_t"], "properties": {"_t": {"enum": ["GroupedRankingWorkflowConfig"], "type": "string"}, "criteria": {"type": "string"}, "referee": {"$ref": "#/components/schemas/IRefereeConfig"}, "targetCountryCodes": {"type": "array", "items": {"type": "string"}}, "maxParallelism": {"type": "integer", "format": "int32"}, "rankingConfig": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/IRankingConfig"}]}, "pairMakerConfig": {"$ref": "#/components/schemas/IPairMakerConfig"}, "featureFlags": {"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}, "nullable": true}}}, "IWorkflowConfigRankingWorkflowConfig": {"required": ["criteria", "referee", "pairMakerConfig", "_t"], "properties": {"_t": {"enum": ["RankingWorkflowConfig"], "type": "string"}, "criteria": {"type": "string"}, "referee": {"$ref": "#/components/schemas/IRefereeConfig"}, "context": {"type": "string", "nullable": true}, "contextAsset": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/IAsset"}]}, "rankingConfig": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/IRankingConfig"}]}, "pairMakerConfig": {"$ref": "#/components/schemas/IPairMakerConfig"}, "featureFlags": {"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}, "nullable": true}}}, "IWorkflowConfigSimpleWorkflowConfig": {"required": ["referee", "blueprint", "_t"], "properties": {"_t": {"enum": ["SimpleWorkflowConfig"], "type": "string"}, "referee": {"$ref": "#/components/schemas/IRefereeConfig"}, "blueprint": {"$ref": "#/components/schemas/IRapidBlueprint"}, "batchSize": {"type": "integer", "format": "int32", "nullable": true}, "featureFlags": {"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}, "nullable": true}}}, "StartPreliminaryDownloadEndpoint_Input": {"type": "object", "properties": {"sendEmail": {"type": "boolean", "description": "Whether to email the user when the download is ready."}}}, "StartPreliminaryDownloadEndpoint_Output": {"required": ["downloadId"], "type": "object", "properties": {"downloadId": {"type": "string", "description": "The id of the preliminary download that was initiated."}}}, "AddUserResponseEndpoint_Input": {"required": ["sessionIndex", "result"], "type": "object", "properties": {"sessionIndex": {"type": "integer", "description": "The index of the session when the result was submitted.", "format": "int32"}, "result": {"allOf": [{"$ref": "#/components/schemas/IRapidResultModel"}], "description": "The result submitted by the user."}}}, "AddUserResponseEndpoint_Output": {"required": ["isAccepted", "userScore"], "type": "object", "properties": {"isAccepted": {"type": "boolean", "description": "Whether the response was accepted."}, "validationTruth": {"allOf": [{"$ref": "#/components/schemas/IValidationTruthModel"}], "description": "The validation truth applied to the response, if any."}, "explanation": {"allOf": [{"$ref": "#/components/schemas/TranslatedString"}], "description": "An optional translated explanation for the user."}, "userScore": {"type": "number", "description": "The user's score after processing this response.", "format": "double"}}}, "BoundingBoxResultModel_Box": {"type": "object", "properties": {"xMin": {"type": "number", "format": "double", "nullable": true}, "yMin": {"type": "number", "format": "double", "nullable": true}, "xMax": {"type": "number", "format": "double", "nullable": true}, "yMax": {"type": "number", "format": "double", "nullable": true}}}, "ClassifyPayloadModel": {"required": ["categories", "title"], "type": "object", "properties": {"categories": {"type": "array", "items": {"$ref": "#/components/schemas/ClassifyPayloadModel_Category"}}, "title": {"type": "string"}}}, "ClassifyPayloadModel_Category": {"required": ["label"], "type": "object", "properties": {"label": {"type": "string"}, "value": {"type": "string", "nullable": true}}}, "CreateDemographicRapidEndpoint_Input": {"required": ["key", "payload"], "type": "object", "properties": {"key": {"type": "string", "description": "The identifier of the demographic classification."}, "payload": {"allOf": [{"$ref": "#/components/schemas/ClassifyPayloadModel"}], "description": "The payload for the classification."}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}, "nullable": true}], "description": "Optional feature flags to apply to the rapid."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "An optional asset to associate with the rapid."}, "context": {"type": "string", "description": "An optional text context to show to the user.", "nullable": true}, "contextAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "An optional asset to use as context to show to the user."}}}, "CreateDemographicRapidEndpoint_Output": {"required": ["rapidId"], "type": "object", "properties": {"rapidId": {"type": "string", "description": "The id of the created rapid."}}}, "CreateGlobalTextEndpoint_Input": {"required": ["key", "englishText"], "type": "object", "properties": {"key": {"type": "string", "description": "The human-readable key used to look up the text from translations."}, "englishText": {"type": "string", "description": "The English source text that all translations derive from."}}}, "CreateGlobalTextEndpoint_Output": {"required": ["globalTextId"], "type": "object", "properties": {"globalTextId": {"type": "string", "description": "The unique identifier of the created global text entry."}}}, "CreateValidationFeedbackEndpoint_Input": {"required": ["feedback"], "type": "object", "properties": {"feedback": {"type": "string", "description": "The feedback text."}}}, "GetAllGlobalTextsEndpoint_Output": {"required": ["globalTexts"], "type": "object", "properties": {"globalTexts": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetAllGlobalTextsEndpoint_Output_Item"}}], "description": "The list of global text entries."}}}, "GetAllGlobalTextsEndpoint_Output_Item": {"required": ["id", "key", "englishText"], "type": "object", "properties": {"id": {"type": "string"}, "key": {"type": "string"}, "englishText": {"type": "string"}}}, "GetGlobalResponsesEndpoint_Output": {"required": ["responses"], "type": "object", "properties": {"responses": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetGlobalResponsesEndpoint_Output_Response"}}], "description": "The most recent public responses."}}}, "GetGlobalResponsesEndpoint_Output_Response": {"required": ["id", "userId", "country"], "type": "object", "properties": {"id": {"type": "string"}, "userId": {"type": "string"}, "country": {"type": "string"}, "age": {"type": "string", "nullable": true}, "occupation": {"type": "string", "nullable": true}, "gender": {"type": "string", "nullable": true}}}, "GetResponsesForRapidEndpoint_Output": {"required": ["rapidId", "asset", "responses", "state"], "type": "object", "properties": {"rapidId": {"type": "string", "description": "The id of the rapid."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The asset of the rapid."}, "responses": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetResponsesForRapidEndpoint_Output_Response"}}], "description": "The list of responses for the rapid."}, "state": {"allOf": [{"$ref": "#/components/schemas/RapidStateModel"}], "description": "The state of the rapid."}}}, "GetResponsesForRapidEndpoint_Output_Response": {"required": ["id", "userId", "country", "result", "userScore", "userScores", "demographicInformation"], "type": "object", "properties": {"id": {"type": "string"}, "userId": {"type": "string"}, "country": {"type": "string"}, "result": {"$ref": "#/components/schemas/IRapidResultModel"}, "userScore": {"type": "number", "format": "double"}, "userScores": {"type": "object", "additionalProperties": {"type": "number", "format": "double"}}, "demographicInformation": {"type": "object", "additionalProperties": {"type": "string"}}}}, "InspectReportEndpoint_Output": {"type": "object", "properties": {"dump": {"type": "string", "description": "The captured dump, if any.", "nullable": true}}}, "IRapidPayloadModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IRapidPayloadModelBoundingBoxPayloadModel"}, {"$ref": "#/components/schemas/IRapidPayloadModelClassifyPayloadModel"}, {"$ref": "#/components/schemas/IRapidPayloadModelComparePayloadModel"}, {"$ref": "#/components/schemas/IRapidPayloadModelFreeTextPayloadModel"}, {"$ref": "#/components/schemas/IRapidPayloadModelLinePayloadModel"}, {"$ref": "#/components/schemas/IRapidPayloadModelLocatePayloadModel"}, {"$ref": "#/components/schemas/IRapidPayloadModelNamedEntityPayloadModel"}, {"$ref": "#/components/schemas/IRapidPayloadModelPolygonPayloadModel"}, {"$ref": "#/components/schemas/IRapidPayloadModelScrubPayloadModel"}, {"$ref": "#/components/schemas/IRapidPayloadModelTranscriptionPayloadModel"}], "discriminator": {"propertyName": "_t", "mapping": {"BoundingBoxPayload": "#/components/schemas/IRapidPayloadModelBoundingBoxPayloadModel", "ClassifyPayload": "#/components/schemas/IRapidPayloadModelClassifyPayloadModel", "ComparePayload": "#/components/schemas/IRapidPayloadModelComparePayloadModel", "FreeTextPayload": "#/components/schemas/IRapidPayloadModelFreeTextPayloadModel", "LinePayload": "#/components/schemas/IRapidPayloadModelLinePayloadModel", "LocatePayload": "#/components/schemas/IRapidPayloadModelLocatePayloadModel", "NamedEntityPayload": "#/components/schemas/IRapidPayloadModelNamedEntityPayloadModel", "PolygonPayload": "#/components/schemas/IRapidPayloadModelPolygonPayloadModel", "ScrubPayload": "#/components/schemas/IRapidPayloadModelScrubPayloadModel", "TranscriptionPayload": "#/components/schemas/IRapidPayloadModelTranscriptionPayloadModel"}}}, "IRapidPayloadModelBoundingBoxPayloadModel": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["BoundingBoxPayload"], "type": "string"}, "target": {"type": "string"}}}, "IRapidPayloadModelClassifyPayloadModel": {"required": ["categories", "title", "_t"], "properties": {"_t": {"enum": ["ClassifyPayload"], "type": "string"}, "categories": {"type": "array", "items": {"$ref": "#/components/schemas/ClassifyPayloadModel_Category"}}, "title": {"type": "string"}}}, "IRapidPayloadModelComparePayloadModel": {"required": ["criteria", "_t"], "properties": {"_t": {"enum": ["ComparePayload"], "type": "string"}, "criteria": {"type": "string"}}}, "IRapidPayloadModelFreeTextPayloadModel": {"required": ["question", "_t"], "properties": {"_t": {"enum": ["FreeTextPayload"], "type": "string"}, "question": {"type": "string"}, "shouldValidateResponse": {"type": "boolean"}, "validationSystemPrompt": {"type": "string", "nullable": true}}}, "IRapidPayloadModelLinePayloadModel": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["LinePayload"], "type": "string"}, "target": {"type": "string"}}}, "IRapidPayloadModelLocatePayloadModel": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["LocatePayload"], "type": "string"}, "target": {"type": "string"}}}, "IRapidPayloadModelNamedEntityPayloadModel": {"required": ["target", "classes", "_t"], "properties": {"_t": {"enum": ["NamedEntityPayload"], "type": "string"}, "target": {"type": "string"}, "classes": {"type": "array", "items": {"type": "string"}}}}, "IRapidPayloadModelPolygonPayloadModel": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["PolygonPayload"], "type": "string"}, "target": {"type": "string"}}}, "IRapidPayloadModelScrubPayloadModel": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["ScrubPayload"], "type": "string"}, "target": {"type": "string"}}}, "IRapidPayloadModelTranscriptionPayloadModel": {"required": ["title", "transcription", "_t"], "properties": {"_t": {"enum": ["TranscriptionPayload"], "type": "string"}, "title": {"type": "string"}, "transcription": {"type": "array", "items": {"$ref": "#/components/schemas/TranscriptionPayloadModel_TranscriptionWord"}}}}, "IRapidResultModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IRapidResultModelAttachCategoryResultModel"}, {"$ref": "#/components/schemas/IRapidResultModelBoundingBoxResultModel"}, {"$ref": "#/components/schemas/IRapidResultModelCompareResultModel"}, {"$ref": "#/components/schemas/IRapidResultModelFreeTextResultModel"}, {"$ref": "#/components/schemas/IRapidResultModelLineResultModel"}, {"$ref": "#/components/schemas/IRapidResultModelLocateResultModel"}, {"$ref": "#/components/schemas/IRapidResultModelNamedEntityResultModel"}, {"$ref": "#/components/schemas/IRapidResultModelPolygonResultModel"}, {"$ref": "#/components/schemas/IRapidResultModelScrubResultModel"}, {"$ref": "#/components/schemas/IRapidResultModelSkipResultModel"}, {"$ref": "#/components/schemas/IRapidResultModelTranscriptionResultModel"}], "discriminator": {"propertyName": "_t", "mapping": {"AttachCategoryResult": "#/components/schemas/IRapidResultModelAttachCategoryResultModel", "BoundingBoxResult": "#/components/schemas/IRapidResultModelBoundingBoxResultModel", "CompareResult": "#/components/schemas/IRapidResultModelCompareResultModel", "FreeTextResult": "#/components/schemas/IRapidResultModelFreeTextResultModel", "LineResult": "#/components/schemas/IRapidResultModelLineResultModel", "LocateResult": "#/components/schemas/IRapidResultModelLocateResultModel", "NamedEntityResult": "#/components/schemas/IRapidResultModelNamedEntityResultModel", "PolygonResult": "#/components/schemas/IRapidResultModelPolygonResultModel", "ScrubResult": "#/components/schemas/IRapidResultModelScrubResultModel", "SkipResult": "#/components/schemas/IRapidResultModelSkipResultModel", "TranscriptionResult": "#/components/schemas/IRapidResultModelTranscriptionResultModel"}}}, "IRapidResultModelAttachCategoryResultModel": {"required": ["rapidId", "category", "_t"], "properties": {"_t": {"enum": ["AttachCategoryResult"], "type": "string"}, "rapidId": {"type": "string"}, "category": {"type": "string"}}}, "IRapidResultModelBoundingBoxResultModel": {"required": ["rapidId", "boundingBoxes", "_t"], "properties": {"_t": {"enum": ["BoundingBoxResult"], "type": "string"}, "rapidId": {"type": "string"}, "boundingBoxes": {"type": "array", "items": {"$ref": "#/components/schemas/BoundingBoxResultModel_Box"}}}}, "IRapidResultModelCompareResultModel": {"required": ["rapidId", "_t"], "properties": {"_t": {"enum": ["CompareResult"], "type": "string"}, "rapidId": {"type": "string"}, "winners": {"type": "array", "items": {"type": "string"}}}}, "IRapidResultModelFreeTextResultModel": {"required": ["rapidId", "answer", "_t"], "properties": {"_t": {"enum": ["FreeTextResult"], "type": "string"}, "rapidId": {"type": "string"}, "answer": {"type": "string"}}}, "IRapidResultModelLineResultModel": {"required": ["rapidId", "lines", "_t"], "properties": {"_t": {"enum": ["LineResult"], "type": "string"}, "rapidId": {"type": "string"}, "lines": {"type": "array", "items": {"$ref": "#/components/schemas/LineResultModel_Line"}}}}, "IRapidResultModelLocateResultModel": {"required": ["rapidId", "coordinates", "_t"], "properties": {"_t": {"enum": ["LocateResult"], "type": "string"}, "rapidId": {"type": "string"}, "coordinates": {"type": "array", "items": {"$ref": "#/components/schemas/LocateCoordinateModel"}}}}, "IRapidResultModelNamedEntityResultModel": {"required": ["rapidId", "classifications", "_t"], "properties": {"_t": {"enum": ["NamedEntityResult"], "type": "string"}, "rapidId": {"type": "string"}, "classifications": {"type": "array", "items": {"$ref": "#/components/schemas/NamedEntityResultModel_NamedClassification"}}}}, "IRapidResultModelPolygonResultModel": {"required": ["rapidId", "shapes", "_t"], "properties": {"_t": {"enum": ["PolygonResult"], "type": "string"}, "rapidId": {"type": "string"}, "shapes": {"type": "array", "items": {"$ref": "#/components/schemas/PolygonResultModel_Shape"}}}}, "IRapidResultModelScrubResultModel": {"required": ["rapidId", "timestamps", "_t"], "properties": {"_t": {"enum": ["ScrubResult"], "type": "string"}, "rapidId": {"type": "string"}, "timestamps": {"type": "array", "items": {"type": "integer", "format": "int32"}}}}, "IRapidResultModelSkipResultModel": {"required": ["rapidId", "_t"], "properties": {"_t": {"enum": ["SkipResult"], "type": "string"}, "rapidId": {"type": "string"}}}, "IRapidResultModelTranscriptionResultModel": {"required": ["rapidId", "selectedWords", "_t"], "properties": {"_t": {"enum": ["TranscriptionResult"], "type": "string"}, "rapidId": {"type": "string"}, "selectedWords": {"type": "array", "items": {"$ref": "#/components/schemas/TranscriptionResultModel_TranscriptionWord"}}}}, "IRefereeInfoModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IRefereeInfoModelNaiveRefereeInfoModel"}, {"$ref": "#/components/schemas/IRefereeInfoModelNeverEndingRefereeInfoModel"}, {"$ref": "#/components/schemas/IRefereeInfoModelProbabilisticAttachCategoryRefereeInfoModel"}, {"$ref": "#/components/schemas/IRefereeInfoModelQuorumRefereeInfoModel"}], "discriminator": {"propertyName": "_t", "mapping": {"NaiveRefereeInfo": "#/components/schemas/IRefereeInfoModelNaiveRefereeInfoModel", "NeverEndingRefereeInfo": "#/components/schemas/IRefereeInfoModelNeverEndingRefereeInfoModel", "ProbabilisticAttachCategoryRefereeInfo": "#/components/schemas/IRefereeInfoModelProbabilisticAttachCategoryRefereeInfoModel", "QuorumRefereeInfo": "#/components/schemas/IRefereeInfoModelQuorumRefereeInfoModel"}}}, "IRefereeInfoModelNaiveRefereeInfoModel": {"required": ["_t"], "properties": {"_t": {"enum": ["NaiveRefereeInfo"], "type": "string"}, "guessAmountThreshold": {"type": "integer", "format": "int32"}, "serveThreshold": {"type": "integer", "format": "int32", "nullable": true}}}, "IRefereeInfoModelNeverEndingRefereeInfoModel": {"required": ["_t"], "properties": {"_t": {"enum": ["NeverEndingRefereeInfo"], "type": "string"}}}, "IRefereeInfoModelProbabilisticAttachCategoryRefereeInfoModel": {"required": ["threshold", "maxVotes", "_t"], "properties": {"_t": {"enum": ["ProbabilisticAttachCategoryRefereeInfo"], "type": "string"}, "threshold": {"type": "number", "format": "double"}, "maxVotes": {"type": "integer", "format": "int32"}}}, "IRefereeInfoModelQuorumRefereeInfoModel": {"required": ["maxVotes", "threshold", "_t"], "properties": {"_t": {"enum": ["QuorumRefereeInfo"], "type": "string"}, "maxVotes": {"type": "integer", "format": "int32"}, "threshold": {"type": "integer", "format": "int32"}}}, "IsRapidBagValidEndpoint_Output": {"required": ["isValid"], "type": "object", "properties": {"isValid": {"type": "boolean", "description": "Whether the rapid bag is valid."}}}, "IValidationTruthModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IValidationTruthModelAttachCategoryTruthModel"}, {"$ref": "#/components/schemas/IValidationTruthModelBoundingBoxTruthModel"}, {"$ref": "#/components/schemas/IValidationTruthModelClassifyTruthModel"}, {"$ref": "#/components/schemas/IValidationTruthModelCompareTruthModel"}, {"$ref": "#/components/schemas/IValidationTruthModelEmptyValidationTruthModel"}, {"$ref": "#/components/schemas/IValidationTruthModelLineTruthModel"}, {"$ref": "#/components/schemas/IValidationTruthModelLocateBoxTruthModel"}, {"$ref": "#/components/schemas/IValidationTruthModelMultiCompareTruthModel"}, {"$ref": "#/components/schemas/IValidationTruthModelNamedEntityTruthModel"}, {"$ref": "#/components/schemas/IValidationTruthModelPolygonTruthModel"}, {"$ref": "#/components/schemas/IValidationTruthModelScrubTruthModel"}, {"$ref": "#/components/schemas/IValidationTruthModelSkipTruthModel"}, {"$ref": "#/components/schemas/IValidationTruthModelTranscriptionTruthModel"}], "discriminator": {"propertyName": "_t", "mapping": {"AttachCategoryTruth": "#/components/schemas/IValidationTruthModelAttachCategoryTruthModel", "BoundingBoxTruth": "#/components/schemas/IValidationTruthModelBoundingBoxTruthModel", "ClassifyTruth": "#/components/schemas/IValidationTruthModelClassifyTruthModel", "CompareTruth": "#/components/schemas/IValidationTruthModelCompareTruthModel", "EmptyValidationTruth": "#/components/schemas/IValidationTruthModelEmptyValidationTruthModel", "LineTruth": "#/components/schemas/IValidationTruthModelLineTruthModel", "LocateBoxTruth": "#/components/schemas/IValidationTruthModelLocateBoxTruthModel", "MultiCompareTruth": "#/components/schemas/IValidationTruthModelMultiCompareTruthModel", "NamedEntityTruth": "#/components/schemas/IValidationTruthModelNamedEntityTruthModel", "PolygonTruth": "#/components/schemas/IValidationTruthModelPolygonTruthModel", "ScrubTruth": "#/components/schemas/IValidationTruthModelScrubTruthModel", "SkipTruth": "#/components/schemas/IValidationTruthModelSkipTruthModel", "TranscriptionTruth": "#/components/schemas/IValidationTruthModelTranscriptionTruthModel"}}}, "IValidationTruthModelAttachCategoryTruthModel": {"required": ["correctCategories", "_t"], "properties": {"_t": {"enum": ["AttachCategoryTruth"], "type": "string"}, "correctCategories": {"type": "array", "items": {"type": "string"}}}}, "IValidationTruthModelBoundingBoxTruthModel": {"required": ["xMin", "yMin", "xMax", "yMax", "_t"], "properties": {"_t": {"enum": ["BoundingBoxTruth"], "type": "string"}, "xMin": {"type": "number", "format": "double"}, "yMin": {"type": "number", "format": "double"}, "xMax": {"type": "number", "format": "double"}, "yMax": {"type": "number", "format": "double"}}}, "IValidationTruthModelClassifyTruthModel": {"required": ["correctCategories", "_t"], "properties": {"_t": {"enum": ["ClassifyTruth"], "type": "string"}, "correctCategories": {"type": "array", "items": {"type": "string"}}}}, "IValidationTruthModelCompareTruthModel": {"required": ["winnerId", "_t"], "properties": {"_t": {"enum": ["CompareTruth"], "type": "string"}, "winnerId": {"type": "string"}}}, "IValidationTruthModelEmptyValidationTruthModel": {"required": ["_t"], "properties": {"_t": {"enum": ["EmptyValidationTruth"], "type": "string"}}}, "IValidationTruthModelLineTruthModel": {"required": ["_t"], "properties": {"_t": {"enum": ["LineTruth"], "type": "string"}}}, "IValidationTruthModelLocateBoxTruthModel": {"required": ["boundingBoxes", "_t"], "properties": {"_t": {"enum": ["LocateBoxTruth"], "type": "string"}, "boundingBoxes": {"type": "array", "items": {"$ref": "#/components/schemas/LocateBoxTruthModel_Box"}}, "requiredPrecision": {"type": "number", "format": "double"}, "requiredCompleteness": {"type": "number", "format": "double"}}}, "IValidationTruthModelMultiCompareTruthModel": {"required": ["correctCombinations", "_t"], "properties": {"_t": {"enum": ["MultiCompareTruth"], "type": "string"}, "correctCombinations": {"type": "array", "items": {"type": "array", "items": {"type": "string"}}}}}, "IValidationTruthModelNamedEntityTruthModel": {"required": ["classifications", "_t"], "properties": {"_t": {"enum": ["NamedEntityTruth"], "type": "string"}, "classifications": {"type": "array", "items": {"$ref": "#/components/schemas/NamedEntityTruthModel_NamedClassification"}}}}, "IValidationTruthModelPolygonTruthModel": {"required": ["_t"], "properties": {"_t": {"enum": ["PolygonTruth"], "type": "string"}}}, "IValidationTruthModelScrubTruthModel": {"required": ["validRanges", "_t"], "properties": {"_t": {"enum": ["ScrubTruth"], "type": "string"}, "validRanges": {"type": "array", "items": {"$ref": "#/components/schemas/ScrubTruthModel_ScrubRange"}}}}, "IValidationTruthModelSkipTruthModel": {"required": ["_t"], "properties": {"_t": {"enum": ["SkipTruth"], "type": "string"}}}, "IValidationTruthModelTranscriptionTruthModel": {"required": ["correctWords", "_t"], "properties": {"_t": {"enum": ["TranscriptionTruth"], "type": "string"}, "correctWords": {"type": "array", "items": {"$ref": "#/components/schemas/TranscriptionTruthModel_TranscriptionWord"}}, "strictGrading": {"type": "boolean", "nullable": true}, "requiredPrecision": {"type": "number", "format": "double", "nullable": true}, "requiredCompleteness": {"type": "number", "format": "double", "nullable": true}}}, "LineResultModel_Line": {"required": ["size", "points"], "type": "object", "properties": {"size": {"type": "number", "format": "double"}, "points": {"type": "array", "items": {"$ref": "#/components/schemas/LineResultModel_LinePoint"}}}}, "LineResultModel_LinePoint": {"required": ["x", "y"], "type": "object", "properties": {"x": {"type": "number", "format": "double"}, "y": {"type": "number", "format": "double"}}}, "LocateBoxTruthModel_Box": {"type": "object", "properties": {"xMin": {"type": "number", "format": "double", "nullable": true}, "yMin": {"type": "number", "format": "double", "nullable": true}, "xMax": {"type": "number", "format": "double", "nullable": true}, "yMax": {"type": "number", "format": "double", "nullable": true}}}, "LocateCoordinateModel": {"required": ["x", "y"], "type": "object", "properties": {"x": {"type": "number", "format": "double"}, "y": {"type": "number", "format": "double"}}}, "NamedEntityResultModel_NamedClassification": {"required": ["start", "end", "classification"], "type": "object", "properties": {"start": {"type": "integer", "format": "int32"}, "end": {"type": "integer", "format": "int32"}, "classification": {"type": "string"}}}, "NamedEntityTruthModel_NamedClassification": {"required": ["start", "end", "classification"], "type": "object", "properties": {"start": {"type": "integer", "format": "int32"}, "end": {"type": "integer", "format": "int32"}, "classification": {"type": "string"}}}, "PolygonResultModel_Coordinate": {"required": ["x", "y"], "type": "object", "properties": {"x": {"type": "number", "format": "double", "nullable": true}, "y": {"type": "number", "format": "double", "nullable": true}}}, "PolygonResultModel_Shape": {"required": ["edges"], "type": "object", "properties": {"edges": {"type": "array", "items": {"$ref": "#/components/schemas/PolygonResultModel_Coordinate"}}}}, "QueryFlaggedRapidsEndpoint_Output": {"required": ["id", "payload", "referee", "asset", "state", "hasResponses", "shouldAcceptIncorrect", "truth", "explanation", "randomCorrectProbability", "key", "completedAt", "featureFlags"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the rapid."}, "payload": {"allOf": [{"$ref": "#/components/schemas/IRapidPayloadModel"}], "description": "The payload of the rapid."}, "referee": {"allOf": [{"$ref": "#/components/schemas/IRefereeInfoModel"}], "description": "The referee that created the rapid."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The asset associated with the rapid."}, "state": {"allOf": [{"$ref": "#/components/schemas/RapidStateModel"}], "description": "The state of the rapid."}, "hasResponses": {"type": "boolean", "description": "Whether the rapid has any responses."}, "shouldAcceptIncorrect": {"type": "boolean", "description": "Whether the rapid should accept incorrect answers."}, "truth": {"allOf": [{"$ref": "#/components/schemas/IValidationTruthModel"}], "description": "The optional validation truth of the rapid."}, "explanation": {"type": "string", "description": "The optional explanation shown when users answer incorrectly.", "nullable": true}, "randomCorrectProbability": {"type": "number", "description": "The probability of a random correct answer.", "format": "double", "nullable": true}, "key": {"type": "string", "description": "An optional key for the rapid.", "nullable": true}, "completedAt": {"type": "string", "description": "The timestamp when the rapid was completed.", "format": "date-time", "nullable": true}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}}], "description": "The feature flags enabled for the rapid."}}}, "QueryFlaggedRapidsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryFlaggedRapidsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryValidationFeedbacksEndpoint_Output": {"required": ["id", "userId", "sessionId", "feedback", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the feedback."}, "userId": {"type": "string", "description": "The ID of the user who submitted the feedback."}, "sessionId": {"type": "string", "description": "The session ID of the user who submitted the feedback."}, "feedback": {"type": "string", "description": "The feedback text."}, "createdAt": {"type": "string", "description": "The timestamp when the feedback was created.", "format": "date-time"}}}, "QueryValidationFeedbacksEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryValidationFeedbacksEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QueryValidationRapidEligibilityEndpoint_Output": {"required": ["rapidId", "payload", "responseCount", "confidence", "truth"], "type": "object", "properties": {"rapidId": {"type": "string", "description": "The id of the rapid."}, "payload": {"allOf": [{"$ref": "#/components/schemas/IRapidPayloadModel"}], "description": "The payload of the rapid."}, "responseCount": {"type": "integer", "description": "The number of responses that the rapid has received.", "format": "int32"}, "confidence": {"type": "number", "description": "The confidence of the rapid's aggregated response.", "format": "double"}, "truth": {"allOf": [{"$ref": "#/components/schemas/IValidationTruthModel"}], "description": "The derived validation truth for the rapid."}}}, "QueryValidationRapidEligibilityEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryValidationRapidEligibilityEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "RapidIssueModel": {"enum": ["Other", "CannotSubmit", "NoAsset", "Inappropriate", "NoCorrectOption", "WrongLanguage", "DoNotUnderstand", "DoNotCare", "NotSeeOptionsOrMediaDidntLoad", "MyAnswerIsCorrect"]}, "RapidStateModel": {"enum": ["Labeling", "Paused", "Incomplete", "Flagged", "Done", "None", "Rejected"]}, "ReportRapidEndpoint_Input": {"required": ["issue"], "type": "object", "properties": {"issue": {"allOf": [{"$ref": "#/components/schemas/RapidIssueModel"}], "description": "A streamlined enum representing common issues."}, "message": {"type": "string", "description": "An optional message typed by the user.", "nullable": true}, "dump": {"type": "string", "description": "A dump that the frontend defines and can read again.", "nullable": true}, "source": {"type": "string", "description": "An optional identifier where the report originated from.", "nullable": true}}}, "ScrubTruthModel_ScrubRange": {"required": ["start", "end"], "type": "object", "properties": {"start": {"type": "integer", "format": "int32"}, "end": {"type": "integer", "format": "int32"}}}, "SkipRapidEndpoint_Input": {"required": ["rapidId", "sessionIndex"], "type": "object", "properties": {"rapidId": {"type": "string", "description": "The ID of the Rapid that was skipped."}, "sessionIndex": {"type": "integer", "description": "The index of the session when the Rapid was skipped.", "format": "int32"}}}, "SkipRapidEndpoint_Output": {"required": ["isAccepted", "userScore"], "type": "object", "properties": {"isAccepted": {"type": "boolean", "description": "Whether the skip was accepted."}, "validationTruth": {"allOf": [{"$ref": "#/components/schemas/IValidationTruthModel"}], "description": "The validation truth applied, if any."}, "explanation": {"allOf": [{"$ref": "#/components/schemas/TranslatedString"}], "description": "An optional translated explanation for the user."}, "userScore": {"type": "number", "description": "The user's score after the skip.", "format": "double"}}}, "TranscriptionPayloadModel_TranscriptionWord": {"required": ["word", "wordIndex"], "type": "object", "properties": {"word": {"type": "string"}, "wordIndex": {"type": "integer", "format": "int32"}}}, "TranscriptionResultModel_TranscriptionWord": {"required": ["word", "wordIndex"], "type": "object", "properties": {"word": {"type": "string"}, "wordIndex": {"type": "integer", "format": "int32"}}}, "TranscriptionTruthModel_TranscriptionWord": {"required": ["word", "wordIndex"], "type": "object", "properties": {"word": {"type": "string"}, "wordIndex": {"type": "integer", "format": "int32"}}}, "TranslatedString": {"required": ["englishText", "text", "targetLanguage"], "type": "object", "properties": {"wasTranslated": {"type": "boolean"}, "englishText": {"type": "string"}, "text": {"type": "string"}, "targetLanguage": {"type": "string"}}}, "UpdateGlobalTextEndpoint_Input": {"type": "object", "properties": {"key": {"type": "string", "description": "The new key for the global text entry."}, "englishText": {"type": "string", "description": "The new English source text for the global text entry."}}}, "UpdateValidationRapidEndpoint_Input": {"type": "object", "properties": {"truth": {"allOf": [{"$ref": "#/components/schemas/IValidationTruthModel"}], "description": "The truth for the validation rapid."}, "explanation": {"type": "string", "description": "The optional explanation shown when users answer incorrectly.", "nullable": true}, "context": {"type": "string", "description": "An optional text context to show the user.", "nullable": true}, "contextAsset": {"oneOf": [{"$ref": "#/components/schemas/IAssetInput"}, {"nullable": true}], "description": "An optional asset to use as context to show the user."}, "randomCorrectProbability": {"type": "number", "description": "The probability that a random answer is correct.", "format": "double", "nullable": true}, "sortIndex": {"type": "integer", "description": "Controls the serving order of rapids within a target group.", "format": "int32"}}}, "CreateSignalEndpoint_Input": {"required": ["name", "audienceId", "jobDefinitionId", "intervalSeconds"], "type": "object", "properties": {"name": {"type": "string", "description": "The human-readable name of the signal."}, "description": {"type": "string", "description": "Optional description.", "nullable": true}, "audienceId": {"type": "string", "description": "The audience the spawned jobs will target."}, "jobDefinitionId": {"type": "string", "description": "The job definition each firing creates a job from."}, "revisionNumber": {"type": "integer", "description": "Optional revision pin; omit for \"latest at fire time\".", "format": "int32", "nullable": true}, "intervalSeconds": {"type": "integer", "description": "Seconds between consecutive firings. Minimum 60.", "format": "int32"}, "isPublic": {"type": "boolean", "description": "If true the signal is readable by every authenticated user."}}}, "CreateSignalEndpoint_Output": {"required": ["id", "nextRunAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the created signal."}, "nextRunAt": {"type": "string", "description": "Timestamp at which the first scheduled run will fire.", "format": "date-time"}}}, "GetSignalByIdEndpoint_Output": {"required": ["id", "name", "audienceId", "jobDefinitionId", "intervalSeconds", "nextRunAt", "isPaused", "isPublic", "ownerId", "ownerMail", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the signal."}, "name": {"type": "string", "description": "The human-readable name of the signal."}, "description": {"type": "string", "description": "Optional description.", "nullable": true}, "audienceId": {"type": "string", "description": "The id of the audience the signal targets."}, "jobDefinitionId": {"type": "string", "description": "The id of the job definition each firing creates a job from."}, "revisionNumber": {"type": "integer", "description": "Pinned revision number; null means \"latest at fire time\".", "format": "int32", "nullable": true}, "intervalSeconds": {"type": "integer", "description": "Seconds between consecutive firings.", "format": "int32"}, "nextRunAt": {"type": "string", "description": "Timestamp of the next scheduled run.", "format": "date-time"}, "lastRunAt": {"type": "string", "description": "Timestamp of the most recent run (null if the signal has never fired).", "format": "date-time", "nullable": true}, "isPaused": {"type": "boolean", "description": "Whether the scheduler is currently skipping this signal."}, "isPublic": {"type": "boolean", "description": "Whether the signal is readable by every authenticated user."}, "ownerId": {"type": "string", "description": "The customer id of the signal owner.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The email of the signal owner."}, "createdAt": {"type": "string", "description": "When the signal was created.", "format": "date-time"}}}, "GetSignalRunByIdEndpoint_Output": {"required": ["id", "signalId", "triggerSource", "status", "startedAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the run."}, "signalId": {"type": "string", "description": "The id of the parent signal."}, "triggerSource": {"allOf": [{"$ref": "#/components/schemas/SignalRunTriggerSource"}], "description": "Whether the run was started by the scheduler or by a manual trigger."}, "status": {"allOf": [{"$ref": "#/components/schemas/SignalRunStatus"}], "description": "Current lifecycle state of the run."}, "startedAt": {"type": "string", "description": "When the run was started.", "format": "date-time"}, "audienceJobId": {"type": "string", "description": "The id of the audience job this run spawned (null until orders confirms creation).", "nullable": true}, "completedAt": {"type": "string", "description": "When the run reached a terminal state.", "format": "date-time", "nullable": true}, "resultFileName": {"type": "string", "description": "File name of the audience-job result, when completed.", "nullable": true}, "failureMessage": {"type": "string", "description": "Reason the run failed.", "nullable": true}, "skippedReason": {"type": "string", "description": "Reason the run was skipped without spawning an audience job.", "nullable": true}}}, "QuerySignalRunsEndpoint_Output": {"required": ["id", "signalId", "triggerSource", "status", "startedAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the run."}, "signalId": {"type": "string", "description": "The id of the parent signal."}, "triggerSource": {"allOf": [{"$ref": "#/components/schemas/SignalRunTriggerSource"}], "description": "Whether the run was started by the scheduler or by a manual trigger."}, "status": {"allOf": [{"$ref": "#/components/schemas/SignalRunStatus"}], "description": "Current lifecycle state of the run."}, "startedAt": {"type": "string", "description": "When the run was started.", "format": "date-time"}, "audienceJobId": {"type": "string", "description": "The id of the audience job this run spawned (null until orders confirms creation).", "nullable": true}, "completedAt": {"type": "string", "description": "When the run reached a terminal state.", "format": "date-time", "nullable": true}, "resultFileName": {"type": "string", "description": "File name of the audience-job result, when completed.", "nullable": true}, "failureMessage": {"type": "string", "description": "Reason the run failed.", "nullable": true}, "skippedReason": {"type": "string", "description": "Reason the run was skipped without spawning an audience job.", "nullable": true}}}, "QuerySignalRunsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QuerySignalRunsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "QuerySignalsEndpoint_Output": {"required": ["id", "name", "audienceId", "jobDefinitionId", "intervalSeconds", "nextRunAt", "isPaused", "isPublic", "ownerId", "ownerMail", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the signal."}, "name": {"type": "string", "description": "The human-readable name of the signal."}, "description": {"type": "string", "description": "Optional description.", "nullable": true}, "audienceId": {"type": "string", "description": "The id of the audience the signal targets."}, "jobDefinitionId": {"type": "string", "description": "The id of the job definition each firing creates a job from."}, "revisionNumber": {"type": "integer", "description": "Pinned revision number; null means \"latest at fire time\".", "format": "int32", "nullable": true}, "intervalSeconds": {"type": "integer", "description": "Seconds between consecutive firings.", "format": "int32"}, "nextRunAt": {"type": "string", "description": "Timestamp of the next scheduled run.", "format": "date-time"}, "lastRunAt": {"type": "string", "description": "Timestamp of the most recent run (null if the signal has never fired).", "format": "date-time", "nullable": true}, "isPaused": {"type": "boolean", "description": "Whether the scheduler is currently skipping this signal."}, "isPublic": {"type": "boolean", "description": "Whether the signal is readable by every authenticated user."}, "ownerId": {"type": "string", "description": "The customer id of the signal owner.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The email of the signal owner."}, "createdAt": {"type": "string", "description": "When the signal was created.", "format": "date-time"}}}, "QuerySignalsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QuerySignalsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "SignalRunStatus": {"enum": ["Pending", "Running", "Completed", "Failed", "Skipped"]}, "SignalRunTriggerSource": {"enum": ["Scheduled", "Manual"]}, "TriggerSignalEndpoint_Output": {"required": ["signalId"], "type": "object", "properties": {"signalId": {"type": "string", "description": "Echoes the signal id; the spawned run is created asynchronously."}}}, "UpdateSignalEndpoint_Input": {"type": "object", "properties": {"name": {"type": "string", "description": "The new name of the signal."}, "description": {"type": "string", "description": "The new description; pass null to clear it.", "nullable": true}, "intervalSeconds": {"type": "integer", "description": "The new cadence in seconds. Minimum 60.", "format": "int32"}}}, "EnsureEnglishEndpoint_Input": {"required": ["text"], "type": "object", "properties": {"text": {"type": "string", "description": "The text to ensure is English."}}}, "EnsureEnglishEndpoint_Output": {"required": ["englishText"], "type": "object", "properties": {"englishText": {"type": "string", "description": "The English version of the provided text."}}}, "TranslateEndpoint_Input": {"required": ["translator", "text", "targetLanguage"], "type": "object", "properties": {"translator": {"allOf": [{"$ref": "#/components/schemas/TranslatorType"}], "description": "The type of translator to use."}, "text": {"type": "string", "description": "The text to translate."}, "targetLanguage": {"type": "string", "description": "The language to translate the text into."}, "sourceLanguage": {"type": "string", "description": "The original language of the text."}}}, "TranslateEndpoint_Output": {"required": ["translation", "sourceLanguage", "targetLanguage"], "type": "object", "properties": {"translation": {"type": "string", "description": "The translated text."}, "sourceLanguage": {"type": "string", "description": "The detected or provided source language of the text.", "nullable": true}, "targetLanguage": {"type": "string", "description": "The language the text was translated into."}}}, "TranslatorType": {"enum": ["Google", "Deepl", "OpenAi", "OpenAi4O", "OpenAi4OMini", "LibreTranslate", "Gemini", "Tllm"]}, "AddValidationRapidEndpoint_Input": {"required": ["asset", "payload"], "type": "object", "properties": {"asset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "The asset to use for the rapid."}, "payload": {"allOf": [{"$ref": "#/components/schemas/IRapidPayloadModel"}], "description": "The payload to use for the rapid."}, "truth": {"allOf": [{"$ref": "#/components/schemas/IValidationTruthModel"}], "description": "The ground truth for the rapid."}, "randomCorrectProbability": {"type": "number", "description": "The probability for an answer to be correct when randomly guessing.", "format": "double", "nullable": true}, "explanation": {"type": "string", "description": "An explanation shown to the users if they answer the rapid incorrectly.", "nullable": true}, "context": {"type": "string", "description": "An optional textual context that provides additional information to the user about the rapid.", "nullable": true}, "contextAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetInput"}], "description": "An optional asset that provides additional context to the user about the rapid."}, "featureFlags": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/FeatureFlag"}, "nullable": true}], "description": "The feature flags to enable for the rapid."}}}, "AssetType": {"type": "array", "items": {"enum": ["None", "Image", "Video", "Audio", "Text"], "type": "string"}}, "CreateValidationSetEndpoint_Input": {"required": ["name"], "type": "object", "properties": {"name": {"type": "string", "description": "The name of the validation set."}}}, "CreateValidationSetEndpoint_Output": {"required": ["validationSetId"], "type": "object", "properties": {"validationSetId": {"type": "string", "description": "The id of the created validation set."}}}, "GetAvailableValidationSetsEndpoint_Output": {"required": ["validationSets"], "type": "object", "properties": {"validationSets": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetAvailableValidationSetsEndpoint_ValidationSetOverviewOutputModel"}}], "description": "The validation sets available to the current user."}}}, "GetAvailableValidationSetsEndpoint_ValidationSetOverviewOutputModel": {"required": ["id", "name", "ownerId"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "ownerId": {"type": "string", "format": "uuid"}}}, "GetCompatibleValidationSetsEndpoint_Output": {"required": ["validationSets"], "type": "object", "properties": {"validationSets": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetCompatibleValidationSetsEndpoint_ValidationSetOutputModel"}}], "description": "The validation sets that the rapid can be added to."}}}, "GetCompatibleValidationSetsEndpoint_ValidationSetOutputModel": {"required": ["id", "name", "assetType", "modality", "promptType", "dimensions", "isPublic", "ownerId", "ownerMail", "createdAt"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "assetType": {"$ref": "#/components/schemas/AssetType"}, "modality": {"$ref": "#/components/schemas/RapidModality"}, "promptType": {"$ref": "#/components/schemas/PromptType"}, "dimensions": {"type": "array", "items": {"type": "string"}, "nullable": true}, "isPublic": {"type": "boolean"}, "ownerId": {"type": "string", "format": "uuid"}, "ownerMail": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}}}, "GetRecommendedValidationSetEndpoint_Output": {"required": ["validationSets"], "type": "object", "properties": {"validationSets": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetRecommendedValidationSetEndpoint_ValidationSetOutputModel"}}], "description": "The validation sets that best match the provided parameters."}}}, "GetRecommendedValidationSetEndpoint_ValidationSetOutputModel": {"required": ["id", "name", "assetType", "modality", "promptType", "dimensions", "isPublic", "ownerId", "ownerMail", "createdAt"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "assetType": {"$ref": "#/components/schemas/AssetType"}, "modality": {"$ref": "#/components/schemas/RapidModality"}, "promptType": {"$ref": "#/components/schemas/PromptType"}, "dimensions": {"type": "array", "items": {"type": "string"}, "nullable": true}, "isPublic": {"type": "boolean"}, "ownerId": {"type": "string", "format": "uuid"}, "ownerMail": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}}}, "GetValidationRapidsEndpoint_Output": {"required": ["id", "type", "asset", "payload", "correctValidationCount", "invalidValidationCount", "state"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the rapid."}, "type": {"type": "string", "description": "The type of the rapid."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The asset associated with the rapid."}, "truth": {"allOf": [{"$ref": "#/components/schemas/IValidationTruthModel"}], "description": "The truth of the rapid."}, "payload": {"allOf": [{"$ref": "#/components/schemas/IRapidPayloadModel"}], "description": "The payload of the rapid."}, "context": {"type": "string", "description": "The optional textual context of the rapid.", "nullable": true}, "contextAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The optional asset shown as context to the user."}, "correctValidationCount": {"type": "integer", "description": "The number of correct validations received.", "format": "int32"}, "invalidValidationCount": {"type": "integer", "description": "The number of invalid validations received.", "format": "int32"}, "explanation": {"type": "string", "description": "The explanation shown when users answer incorrectly.", "nullable": true}, "randomCorrectProbability": {"type": "number", "description": "The probability of a random correct answer.", "format": "double", "nullable": true}, "state": {"allOf": [{"$ref": "#/components/schemas/RapidStateModel"}], "description": "The state of the rapid."}}}, "GetValidationRapidsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/GetValidationRapidsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "GetValidationSetByIdEndpoint_Output": {"required": ["id", "name", "isPublic", "ownerMail", "ownerId", "dimensions", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the validation set."}, "name": {"type": "string", "description": "The name of the validation set."}, "isPublic": {"type": "boolean", "description": "Whether the validation set is public."}, "ownerMail": {"type": "string", "description": "The mail of the owning customer."}, "ownerId": {"type": "string", "description": "The id of the owning customer.", "format": "uuid"}, "dimensions": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The dimensions shared across all rapids in the validation set."}, "createdAt": {"type": "string", "description": "The time at which the validation set was created.", "format": "date-time"}}}, "PromptType": {"type": "array", "items": {"enum": ["None", "Text", "Asset"], "type": "string"}}, "QueryValidationSetsEndpoint_Output": {"required": ["id", "name", "assetType", "modality", "promptType", "dimensions", "isPublic", "ownerId", "ownerMail", "createdAt"], "type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier of the validation set."}, "name": {"type": "string", "description": "The name of the validation set."}, "assetType": {"allOf": [{"$ref": "#/components/schemas/AssetType"}], "description": "The asset types contained in the validation set."}, "modality": {"allOf": [{"$ref": "#/components/schemas/RapidModality"}], "description": "The rapid modalities contained in the validation set."}, "promptType": {"allOf": [{"$ref": "#/components/schemas/PromptType"}], "description": "The prompt types contained in the validation set."}, "dimensions": {"allOf": [{"type": "array", "items": {"type": "string"}, "nullable": true}], "description": "The dimensions shared across all rapids in the validation set."}, "isPublic": {"type": "boolean", "description": "Whether the validation set is public."}, "ownerId": {"type": "string", "description": "The id of the owning customer.", "format": "uuid"}, "ownerMail": {"type": "string", "description": "The mail of the owning customer."}, "createdAt": {"type": "string", "description": "The time at which the validation set was created.", "format": "date-time"}}}, "QueryValidationSetsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryValidationSetsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "RapidModality": {"type": "array", "items": {"enum": ["None", "BoundingBox", "Classify", "Compare", "FreeText", "Line", "Locate", "NamedEntity", "Polygon", "Scrub", "Transcription"], "type": "string"}}, "UpdateValidationSetDimensionsEndpoint_Input": {"required": ["dimensions"], "type": "object", "properties": {"dimensions": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The dimensions to set on all rapids within the validation set."}}}, "UpdateValidationSetEndpoint_Input": {"type": "object", "properties": {"name": {"type": "string", "description": "The new name of the validation set."}, "dimensions": {"allOf": [{"type": "array", "items": {"type": "string"}}], "description": "The new dimensions of the validation set."}, "shouldAlert": {"type": "boolean", "description": "Whether users should be alerted if they answer incorrectly."}, "isPublic": {"type": "boolean", "description": "Whether the validation set should be public."}, "isFlagOverruled": {"type": "boolean", "description": "Whether flags on validation rapids should be overruled."}}}, "UpdateValidationSetShouldAlertEndpoint_Input": {"required": ["shouldAlert"], "type": "object", "properties": {"shouldAlert": {"type": "boolean", "description": "A flag indicating whether users should be alerted if they answer incorrectly."}}}, "AttachCategoryWorkflowRapidBlueprintModel_Category": {"required": ["label", "value"], "type": "object", "properties": {"label": {"type": "string"}, "value": {"type": "string"}}}, "BoxShape": {"type": "object", "properties": {"xMin": {"type": "number", "format": "double", "nullable": true}, "yMin": {"type": "number", "format": "double", "nullable": true}, "xMax": {"type": "number", "format": "double", "nullable": true}, "yMax": {"type": "number", "format": "double", "nullable": true}}}, "ClassifyCategory": {"required": ["label", "value"], "type": "object", "properties": {"label": {"type": "string"}, "value": {"type": "string"}}}, "GetCompareAbSummaryEndpoint_Output": {"required": ["winCounter", "allTargetGroupsCompleted"], "type": "object", "properties": {"winCounter": {"allOf": [{"type": "object", "additionalProperties": {"type": "number", "format": "double"}}], "description": "The number of times each asset index was the winner."}, "allTargetGroupsCompleted": {"type": "boolean", "description": "Whether all target groups for this workflow are completed."}}}, "GetGroupedRankingWorkflowResultsEndpoint_Output": {"required": ["id", "name", "state", "pairMakerInformation"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the sub-workflow."}, "name": {"type": "string", "description": "The name of the sub-workflow."}, "state": {"type": "string", "description": "The state of the sub-workflow."}, "pairMakerInformation": {"allOf": [{"$ref": "#/components/schemas/IPairMakerInformation"}], "description": "Information about the pair-maker used by the sub-workflow."}}}, "GetGroupedRankingWorkflowResultsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/GetGroupedRankingWorkflowResultsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "GetRankingWorkflowResultsEndpoint_Datapoint": {"required": ["workflowDatapointId", "asset", "elo"], "type": "object", "properties": {"workflowDatapointId": {"type": "string"}, "asset": {"$ref": "#/components/schemas/IAssetModel"}, "elo": {"type": "integer", "format": "int32"}}}, "GetRankingWorkflowResultsEndpoint_Output": {"required": ["total", "page", "pageSize", "totalVotes", "items"], "type": "object", "properties": {"total": {"type": "integer", "description": "The total number of items in the result.", "format": "int64"}, "page": {"type": "integer", "description": "The current page.", "format": "int32"}, "pageSize": {"type": "integer", "description": "The size of the page.", "format": "int32"}, "totalVotes": {"type": "integer", "description": "The total number of votes across all datapoints.", "format": "int64"}, "items": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetRankingWorkflowResultsEndpoint_Datapoint"}}], "description": "The datapoints on the current page."}}}, "GetSimpleWorkflowResultsEndpoint_Output": {"required": ["rapidId", "payload", "asset", "responses", "totalResponseCount", "state"], "type": "object", "properties": {"rapidId": {"type": "string", "description": "The id of the rapid."}, "payload": {"allOf": [{"$ref": "#/components/schemas/IRapidPayload"}], "description": "The payload of the rapid."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The asset of the rapid."}, "responses": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetWorkflowResultsResult_Response"}}], "description": "The (possibly capped) list of responses for the rapid."}, "totalResponseCount": {"type": "integer", "description": "The true number of matching responses for this rapid, regardless of whether the\n returned list was capped.", "format": "int64"}, "state": {"allOf": [{"$ref": "#/components/schemas/RapidState"}], "description": "The state of the rapid."}, "context": {"type": "string", "description": "The optional textual context of the rapid.", "nullable": true}, "contextAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The optional asset shown as context to the user."}, "decisiveness": {"type": "number", "description": "The decisiveness of the rapid.", "format": "double", "nullable": true}, "aggregation": {"allOf": [{"$ref": "#/components/schemas/IResponseAggregation"}], "description": "Per-payload-type aggregation over all matching responses (computed before sampling).\n Populated for Compare and Classify rapids; null otherwise."}}}, "GetSimpleWorkflowResultsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/GetSimpleWorkflowResultsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "GetWorkflowByIdEndpoint_Output": {"required": ["workflow"], "type": "object", "properties": {"workflow": {"allOf": [{"$ref": "#/components/schemas/IWorkflowModel"}], "description": "The workflow."}}}, "GetWorkflowProgressEndpoint_Output": {"required": ["completionPercentage", "total", "completed", "state"], "type": "object", "properties": {"completionPercentage": {"type": "number", "description": "The percentage of workflow datapoints that have been completed.", "format": "double"}, "total": {"type": "integer", "description": "The total number of datapoints in the workflow.", "format": "int64"}, "completed": {"type": "integer", "description": "The number of datapoints that have been completed.", "format": "int64"}, "state": {"allOf": [{"$ref": "#/components/schemas/WorkflowState"}], "description": "The current state of the workflow."}}}, "GetWorkflowResponsesEndpoint_Output": {"required": ["responses"], "type": "object", "properties": {"responses": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetWorkflowResponsesEndpoint_Response"}}], "description": "The responses for the workflow."}}}, "GetWorkflowResponsesEndpoint_Response": {"required": ["id", "userId", "country", "language", "result", "userScore", "userScores", "demographicInformation"], "type": "object", "properties": {"id": {"type": "string"}, "userId": {"type": "string"}, "country": {"type": "string"}, "language": {"type": "string"}, "result": {"$ref": "#/components/schemas/IRapidResult"}, "userScore": {"type": "number", "format": "double"}, "userScores": {"type": "object", "additionalProperties": {"type": "number", "format": "double"}}, "demographicInformation": {"type": "object", "additionalProperties": {"type": "string"}}}}, "GetWorkflowResultsEndpoint_Output": {"required": ["rapidId", "payload", "asset", "responses", "totalResponseCount", "state"], "type": "object", "properties": {"rapidId": {"type": "string", "description": "The id of the rapid."}, "payload": {"allOf": [{"$ref": "#/components/schemas/IRapidPayload"}], "description": "The payload of the rapid."}, "asset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The asset of the rapid."}, "responses": {"allOf": [{"type": "array", "items": {"$ref": "#/components/schemas/GetWorkflowResultsResult_Response"}}], "description": "The (possibly capped) list of responses for the rapid."}, "totalResponseCount": {"type": "integer", "description": "The true number of matching responses for this rapid, regardless of whether the\n returned list was capped.", "format": "int64"}, "state": {"allOf": [{"$ref": "#/components/schemas/RapidState"}], "description": "The state of the rapid."}, "context": {"type": "string", "description": "The optional textual context of the rapid.", "nullable": true}, "contextAsset": {"allOf": [{"$ref": "#/components/schemas/IAssetModel"}], "description": "The optional asset shown as context to the user."}, "decisiveness": {"type": "number", "description": "The decisiveness of the rapid.", "format": "double", "nullable": true}, "aggregation": {"allOf": [{"$ref": "#/components/schemas/IResponseAggregation"}], "description": "Per-payload-type aggregation over all matching responses (computed before sampling).\n Populated for Compare and Classify rapids; null otherwise."}}}, "GetWorkflowResultsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/GetWorkflowResultsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "GetWorkflowResultsResult_Response": {"required": ["id", "userId", "country", "language", "result", "userScore", "userScores", "demographicInformation"], "type": "object", "properties": {"id": {"type": "string"}, "userId": {"type": "string"}, "country": {"type": "string"}, "language": {"type": "string"}, "result": {"$ref": "#/components/schemas/IRapidResult"}, "userScore": {"type": "number", "format": "double"}, "userScores": {"type": "object", "additionalProperties": {"type": "number", "format": "double"}}, "demographicInformation": {"type": "object", "additionalProperties": {"type": "string"}}}}, "IPairMakerInformation": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IPairMakerInformationFullPermutationPairMakerInformation"}, {"$ref": "#/components/schemas/IPairMakerInformationOnlinePairMakerInformation"}], "discriminator": {"propertyName": "_t", "mapping": {"FullPermutationPairMakerInformation": "#/components/schemas/IPairMakerInformationFullPermutationPairMakerInformation", "OnlinePairMakerInformation": "#/components/schemas/IPairMakerInformationOnlinePairMakerInformation"}}}, "IPairMakerInformationFullPermutationPairMakerInformation": {"required": ["_t"], "properties": {"_t": {"enum": ["FullPermutationPairMakerInformation"], "type": "string"}}}, "IPairMakerInformationModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IPairMakerInformationModelFullPermutationPairMakerInformationModel"}, {"$ref": "#/components/schemas/IPairMakerInformationModelOnlinePairMakerInformationModel"}], "discriminator": {"propertyName": "_t", "mapping": {"FullPermutationPairMakerInformation": "#/components/schemas/IPairMakerInformationModelFullPermutationPairMakerInformationModel", "OnlinePairMakerInformation": "#/components/schemas/IPairMakerInformationModelOnlinePairMakerInformationModel"}}}, "IPairMakerInformationModelFullPermutationPairMakerInformationModel": {"required": ["_t"], "properties": {"_t": {"enum": ["FullPermutationPairMakerInformation"], "type": "string"}}}, "IPairMakerInformationModelOnlinePairMakerInformationModel": {"required": ["randomMatchesRatio", "totalComparisonBudget", "currentComparisonBudget", "_t"], "properties": {"_t": {"enum": ["OnlinePairMakerInformation"], "type": "string"}, "randomMatchesRatio": {"type": "number", "format": "float"}, "totalComparisonBudget": {"type": "integer", "format": "int32"}, "currentComparisonBudget": {"type": "integer", "format": "int32"}}}, "IPairMakerInformationOnlinePairMakerInformation": {"required": ["_t"], "properties": {"_t": {"enum": ["OnlinePairMakerInformation"], "type": "string"}, "randomMatchesRatio": {"type": "number", "format": "float"}, "totalComparisonBudget": {"type": "integer", "format": "int32"}, "currentComparisonBudget": {"type": "integer", "format": "int32"}}}, "IRapidPayload": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IRapidPayloadBoundingBoxPayload"}, {"$ref": "#/components/schemas/IRapidPayloadClassifyPayload"}, {"$ref": "#/components/schemas/IRapidPayloadComparePayload"}, {"$ref": "#/components/schemas/IRapidPayloadFreeTextPayload"}, {"$ref": "#/components/schemas/IRapidPayloadLinePayload"}, {"$ref": "#/components/schemas/IRapidPayloadLocatePayload"}, {"$ref": "#/components/schemas/IRapidPayloadNamedEntityPayload"}, {"$ref": "#/components/schemas/IRapidPayloadPolygonPayload"}, {"$ref": "#/components/schemas/IRapidPayloadScrubPayload"}, {"$ref": "#/components/schemas/IRapidPayloadTranscriptionPayload"}], "discriminator": {"propertyName": "_t", "mapping": {"BoundingBoxPayload": "#/components/schemas/IRapidPayloadBoundingBoxPayload", "ClassifyPayload": "#/components/schemas/IRapidPayloadClassifyPayload", "ComparePayload": "#/components/schemas/IRapidPayloadComparePayload", "FreeTextPayload": "#/components/schemas/IRapidPayloadFreeTextPayload", "LinePayload": "#/components/schemas/IRapidPayloadLinePayload", "LocatePayload": "#/components/schemas/IRapidPayloadLocatePayload", "NamedEntityPayload": "#/components/schemas/IRapidPayloadNamedEntityPayload", "PolygonPayload": "#/components/schemas/IRapidPayloadPolygonPayload", "ScrubPayload": "#/components/schemas/IRapidPayloadScrubPayload", "TranscriptionPayload": "#/components/schemas/IRapidPayloadTranscriptionPayload"}}}, "IRapidPayloadBoundingBoxPayload": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["BoundingBoxPayload"], "type": "string"}, "target": {"type": "string"}}}, "IRapidPayloadClassifyPayload": {"required": ["categories", "title", "_t"], "properties": {"_t": {"enum": ["ClassifyPayload"], "type": "string"}, "categories": {"type": "array", "items": {"$ref": "#/components/schemas/ClassifyCategory"}}, "title": {"type": "string"}}}, "IRapidPayloadComparePayload": {"required": ["criteria", "_t"], "properties": {"_t": {"enum": ["ComparePayload"], "type": "string"}, "criteria": {"type": "string"}}}, "IRapidPayloadFreeTextPayload": {"required": ["question", "_t"], "properties": {"_t": {"enum": ["FreeTextPayload"], "type": "string"}, "question": {"type": "string"}, "shouldValidateResponse": {"type": "boolean"}, "validationSystemPrompt": {"type": "string", "nullable": true}}}, "IRapidPayloadLinePayload": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["LinePayload"], "type": "string"}, "target": {"type": "string"}}}, "IRapidPayloadLocatePayload": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["LocatePayload"], "type": "string"}, "target": {"type": "string"}}}, "IRapidPayloadNamedEntityPayload": {"required": ["target", "classes", "_t"], "properties": {"_t": {"enum": ["NamedEntityPayload"], "type": "string"}, "target": {"type": "string"}, "classes": {"type": "array", "items": {"type": "string"}}}}, "IRapidPayloadPolygonPayload": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["PolygonPayload"], "type": "string"}, "target": {"type": "string"}}}, "IRapidPayloadScrubPayload": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["ScrubPayload"], "type": "string"}, "target": {"type": "string"}}}, "IRapidPayloadTranscriptionPayload": {"required": ["title", "transcription", "_t"], "properties": {"_t": {"enum": ["TranscriptionPayload"], "type": "string"}, "title": {"type": "string"}, "transcription": {"type": "array", "items": {"$ref": "#/components/schemas/TranscriptionWord"}}}}, "IRapidResult": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IRapidResultAttachCategoryResult"}, {"$ref": "#/components/schemas/IRapidResultBoundingBoxResult"}, {"$ref": "#/components/schemas/IRapidResultCompareResult"}, {"$ref": "#/components/schemas/IRapidResultFreeTextResult"}, {"$ref": "#/components/schemas/IRapidResultLineResult"}, {"$ref": "#/components/schemas/IRapidResultLocateResult"}, {"$ref": "#/components/schemas/IRapidResultNamedEntityResult"}, {"$ref": "#/components/schemas/IRapidResultPolygonResult"}, {"$ref": "#/components/schemas/IRapidResultScrubResult"}, {"$ref": "#/components/schemas/IRapidResultSkipResult"}, {"$ref": "#/components/schemas/IRapidResultTranscriptionResult"}], "discriminator": {"propertyName": "_t", "mapping": {"AttachCategoryResult": "#/components/schemas/IRapidResultAttachCategoryResult", "BoundingBoxResult": "#/components/schemas/IRapidResultBoundingBoxResult", "CompareResult": "#/components/schemas/IRapidResultCompareResult", "FreeTextResult": "#/components/schemas/IRapidResultFreeTextResult", "LineResult": "#/components/schemas/IRapidResultLineResult", "LocateResult": "#/components/schemas/IRapidResultLocateResult", "NamedEntityResult": "#/components/schemas/IRapidResultNamedEntityResult", "PolygonResult": "#/components/schemas/IRapidResultPolygonResult", "ScrubResult": "#/components/schemas/IRapidResultScrubResult", "SkipResult": "#/components/schemas/IRapidResultSkipResult", "TranscriptionResult": "#/components/schemas/IRapidResultTranscriptionResult"}}}, "IRapidResultAttachCategoryResult": {"required": ["category", "rapidId", "_t"], "properties": {"_t": {"enum": ["AttachCategoryResult"], "type": "string"}, "category": {"type": "string"}, "rapidId": {"type": "string"}}}, "IRapidResultBoundingBoxResult": {"required": ["boundingBoxes", "rapidId", "_t"], "properties": {"_t": {"enum": ["BoundingBoxResult"], "type": "string"}, "boundingBoxes": {"type": "array", "items": {"$ref": "#/components/schemas/BoxShape"}}, "rapidId": {"type": "string"}}}, "IRapidResultCompareResult": {"required": ["winners", "rapidId", "_t"], "properties": {"_t": {"enum": ["CompareResult"], "type": "string"}, "winners": {"type": "array", "items": {"type": "string"}}, "rapidId": {"type": "string"}}}, "IRapidResultFreeTextResult": {"required": ["answer", "rapidId", "_t"], "properties": {"_t": {"enum": ["FreeTextResult"], "type": "string"}, "answer": {"type": "string"}, "rapidId": {"type": "string"}}}, "IRapidResultLineResult": {"required": ["lines", "rapidId", "_t"], "properties": {"_t": {"enum": ["LineResult"], "type": "string"}, "lines": {"type": "array", "items": {"$ref": "#/components/schemas/Line"}}, "rapidId": {"type": "string"}}}, "IRapidResultLocateResult": {"required": ["coordinates", "rapidId", "_t"], "properties": {"_t": {"enum": ["LocateResult"], "type": "string"}, "coordinates": {"type": "array", "items": {"$ref": "#/components/schemas/LocateCoordinate"}}, "rapidId": {"type": "string"}}}, "IRapidResultNamedEntityResult": {"required": ["classifications", "rapidId", "_t"], "properties": {"_t": {"enum": ["NamedEntityResult"], "type": "string"}, "classifications": {"type": "array", "items": {"$ref": "#/components/schemas/NamedClassification"}}, "rapidId": {"type": "string"}}}, "IRapidResultPolygonResult": {"required": ["shapes", "rapidId", "_t"], "properties": {"_t": {"enum": ["PolygonResult"], "type": "string"}, "shapes": {"type": "array", "items": {"$ref": "#/components/schemas/PolygonShape"}}, "rapidId": {"type": "string"}}}, "IRapidResultScrubResult": {"required": ["timestamps", "rapidId", "_t"], "properties": {"_t": {"enum": ["ScrubResult"], "type": "string"}, "timestamps": {"type": "array", "items": {"type": "integer", "format": "int32"}}, "rapidId": {"type": "string"}}}, "IRapidResultSkipResult": {"required": ["rapidId", "_t"], "properties": {"_t": {"enum": ["SkipResult"], "type": "string"}, "rapidId": {"type": "string"}}}, "IRapidResultTranscriptionResult": {"required": ["selectedWords", "rapidId", "_t"], "properties": {"_t": {"enum": ["TranscriptionResult"], "type": "string"}, "selectedWords": {"type": "array", "items": {"$ref": "#/components/schemas/TranscriptionWord"}}, "rapidId": {"type": "string"}}}, "IRefereeConfigModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IRefereeConfigModelBudgetRefereeConfigModel"}, {"$ref": "#/components/schemas/IRefereeConfigModelNaiveRefereeConfigModel"}, {"$ref": "#/components/schemas/IRefereeConfigModelNeverEndingRefereeConfigModel"}, {"$ref": "#/components/schemas/IRefereeConfigModelProbabilisticAttachCategoryRefereeConfigModel"}, {"$ref": "#/components/schemas/IRefereeConfigModelQuorumRefereeConfigModel"}], "discriminator": {"propertyName": "_t", "mapping": {"BudgetRefereeConfig": "#/components/schemas/IRefereeConfigModelBudgetRefereeConfigModel", "NaiveRefereeConfig": "#/components/schemas/IRefereeConfigModelNaiveRefereeConfigModel", "NeverEndingRefereeConfig": "#/components/schemas/IRefereeConfigModelNeverEndingRefereeConfigModel", "ProbabilisticAttachCategoryRefereeConfig": "#/components/schemas/IRefereeConfigModelProbabilisticAttachCategoryRefereeConfigModel", "QuorumRefereeConfig": "#/components/schemas/IRefereeConfigModelQuorumRefereeConfigModel"}}}, "IRefereeConfigModelBudgetRefereeConfigModel": {"required": ["totalBudget", "_t"], "properties": {"_t": {"enum": ["BudgetRefereeConfig"], "type": "string"}, "totalBudget": {"type": "integer", "format": "int32"}, "totalServeBudget": {"type": "integer", "format": "int32", "nullable": true}}}, "IRefereeConfigModelNaiveRefereeConfigModel": {"required": ["guessesRequired", "_t"], "properties": {"_t": {"enum": ["NaiveRefereeConfig"], "type": "string"}, "guessesRequired": {"type": "integer", "format": "int32"}}}, "IRefereeConfigModelNeverEndingRefereeConfigModel": {"required": ["_t"], "properties": {"_t": {"enum": ["NeverEndingRefereeConfig"], "type": "string"}}}, "IRefereeConfigModelProbabilisticAttachCategoryRefereeConfigModel": {"required": ["threshold", "maxVotes", "_t"], "properties": {"_t": {"enum": ["ProbabilisticAttachCategoryRefereeConfig"], "type": "string"}, "threshold": {"type": "number", "format": "double"}, "maxVotes": {"type": "integer", "format": "int32"}}}, "IRefereeConfigModelQuorumRefereeConfigModel": {"required": ["maxVotes", "threshold", "_t"], "properties": {"_t": {"enum": ["QuorumRefereeConfig"], "type": "string"}, "maxVotes": {"type": "integer", "format": "int32"}, "threshold": {"type": "integer", "format": "int32"}}}, "IResponseAggregation": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IResponseAggregationClassifyAggregation"}, {"$ref": "#/components/schemas/IResponseAggregationCompareAggregation"}], "discriminator": {"propertyName": "_t", "mapping": {"ClassifyAggregation": "#/components/schemas/IResponseAggregationClassifyAggregation", "CompareAggregation": "#/components/schemas/IResponseAggregationCompareAggregation"}}}, "IResponseAggregationClassifyAggregation": {"required": ["categoryTallies", "_t"], "properties": {"_t": {"enum": ["ClassifyAggregation"], "type": "string"}, "categoryTallies": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/ResponseTally"}}}}, "IResponseAggregationCompareAggregation": {"required": ["winnerTallies", "_t"], "properties": {"_t": {"enum": ["CompareAggregation"], "type": "string"}, "winnerTallies": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/ResponseTally"}}}}, "IWorkflowModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IWorkflowModelEvaluationWorkflowModel"}, {"$ref": "#/components/schemas/IWorkflowModelGroupedRankingWorkflowModel"}, {"$ref": "#/components/schemas/IWorkflowModelRankingWorkflowModel"}, {"$ref": "#/components/schemas/IWorkflowModelSimpleWorkflowModel"}], "discriminator": {"propertyName": "_t", "mapping": {"EvaluationWorkflow": "#/components/schemas/IWorkflowModelEvaluationWorkflowModel", "GroupedRankingWorkflowModel": "#/components/schemas/IWorkflowModelGroupedRankingWorkflowModel", "RankingWorkflowModel": "#/components/schemas/IWorkflowModelRankingWorkflowModel", "SimpleWorkflowModel": "#/components/schemas/IWorkflowModelSimpleWorkflowModel"}}}, "IWorkflowModelEvaluationWorkflowModel": {"required": ["id", "validationSetId", "state", "referee", "name", "ownerMail", "_t"], "properties": {"_t": {"enum": ["EvaluationWorkflow"], "type": "string"}, "id": {"type": "string"}, "validationSetId": {"type": "string"}, "state": {"$ref": "#/components/schemas/WorkflowStateModel"}, "referee": {"$ref": "#/components/schemas/IRefereeConfigModel"}, "name": {"type": "string"}, "ownerMail": {"type": "string", "nullable": true}}}, "IWorkflowModelGroupedRankingWorkflowModel": {"required": ["id", "referee", "state", "criteria", "name", "ownerMail", "_t"], "properties": {"_t": {"enum": ["GroupedRankingWorkflowModel"], "type": "string"}, "id": {"type": "string"}, "referee": {"$ref": "#/components/schemas/IRefereeConfigModel"}, "state": {"$ref": "#/components/schemas/WorkflowStateModel"}, "criteria": {"type": "string"}, "name": {"type": "string"}, "ownerMail": {"type": "string", "nullable": true}, "rankingConfig": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/IRankingConfigModel"}]}}}, "IWorkflowModelRankingWorkflowModel": {"required": ["id", "referee", "pairMakerInformation", "state", "criteria", "name", "context", "contextAsset", "ownerMail", "_t"], "properties": {"_t": {"enum": ["RankingWorkflowModel"], "type": "string"}, "id": {"type": "string"}, "referee": {"$ref": "#/components/schemas/IRefereeConfigModel"}, "pairMakerInformation": {"$ref": "#/components/schemas/IPairMakerInformationModel"}, "state": {"$ref": "#/components/schemas/WorkflowStateModel"}, "criteria": {"type": "string"}, "name": {"type": "string"}, "rankingConfig": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/IRankingConfigModel"}]}, "context": {"type": "string", "nullable": true}, "contextAsset": {"oneOf": [{"nullable": true}, {"$ref": "#/components/schemas/IAssetModel"}]}, "ownerMail": {"type": "string", "nullable": true}}}, "IWorkflowModelSimpleWorkflowModel": {"required": ["id", "state", "blueprint", "referee", "name", "ownerMail", "_t"], "properties": {"_t": {"enum": ["SimpleWorkflowModel"], "type": "string"}, "id": {"type": "string"}, "state": {"$ref": "#/components/schemas/WorkflowStateModel"}, "blueprint": {"$ref": "#/components/schemas/IWorkflowRapidBlueprintModel"}, "referee": {"$ref": "#/components/schemas/IRefereeConfigModel"}, "name": {"type": "string"}, "ownerMail": {"type": "string", "nullable": true}}}, "IWorkflowRapidBlueprintModel": {"required": ["_t"], "type": "object", "oneOf": [{"$ref": "#/components/schemas/IWorkflowRapidBlueprintModelAttachCategoryWorkflowRapidBlueprintModel"}, {"$ref": "#/components/schemas/IWorkflowRapidBlueprintModelBoundingBoxWorkflowRapidBlueprintModel"}, {"$ref": "#/components/schemas/IWorkflowRapidBlueprintModelCompareWorkflowRapidBlueprintModel"}, {"$ref": "#/components/schemas/IWorkflowRapidBlueprintModelFreeTextWorkflowRapidBlueprintModel"}, {"$ref": "#/components/schemas/IWorkflowRapidBlueprintModelLineWorkflowRapidBlueprintModel"}, {"$ref": "#/components/schemas/IWorkflowRapidBlueprintModelLocateWorkflowRapidBlueprintModel"}, {"$ref": "#/components/schemas/IWorkflowRapidBlueprintModelNamedEntityWorkflowRapidBlueprintModel"}, {"$ref": "#/components/schemas/IWorkflowRapidBlueprintModelPolygonWorkflowRapidBlueprintModel"}, {"$ref": "#/components/schemas/IWorkflowRapidBlueprintModelScrubWorkflowRapidBlueprintModel"}, {"$ref": "#/components/schemas/IWorkflowRapidBlueprintModelTranscriptionWorkflowRapidBlueprintModel"}], "discriminator": {"propertyName": "_t", "mapping": {"ClassifyBlueprint": "#/components/schemas/IWorkflowRapidBlueprintModelAttachCategoryWorkflowRapidBlueprintModel", "BoundingBoxBlueprint": "#/components/schemas/IWorkflowRapidBlueprintModelBoundingBoxWorkflowRapidBlueprintModel", "CompareBlueprint": "#/components/schemas/IWorkflowRapidBlueprintModelCompareWorkflowRapidBlueprintModel", "FreeTextBlueprint": "#/components/schemas/IWorkflowRapidBlueprintModelFreeTextWorkflowRapidBlueprintModel", "LineBlueprint": "#/components/schemas/IWorkflowRapidBlueprintModelLineWorkflowRapidBlueprintModel", "LocateBlueprint": "#/components/schemas/IWorkflowRapidBlueprintModelLocateWorkflowRapidBlueprintModel", "NamedEntityBlueprint": "#/components/schemas/IWorkflowRapidBlueprintModelNamedEntityWorkflowRapidBlueprintModel", "PolygonBlueprint": "#/components/schemas/IWorkflowRapidBlueprintModelPolygonWorkflowRapidBlueprintModel", "ScrubBlueprint": "#/components/schemas/IWorkflowRapidBlueprintModelScrubWorkflowRapidBlueprintModel", "TranscriptionBlueprint": "#/components/schemas/IWorkflowRapidBlueprintModelTranscriptionWorkflowRapidBlueprintModel"}}}, "IWorkflowRapidBlueprintModelAttachCategoryWorkflowRapidBlueprintModel": {"required": ["categories", "title", "_t"], "properties": {"_t": {"enum": ["ClassifyBlueprint"], "type": "string"}, "categories": {"type": "array", "items": {"$ref": "#/components/schemas/AttachCategoryWorkflowRapidBlueprintModel_Category"}}, "title": {"type": "string"}}}, "IWorkflowRapidBlueprintModelBoundingBoxWorkflowRapidBlueprintModel": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["BoundingBoxBlueprint"], "type": "string"}, "target": {"type": "string"}}}, "IWorkflowRapidBlueprintModelCompareWorkflowRapidBlueprintModel": {"required": ["criteria", "indexIdentifiers", "_t"], "properties": {"_t": {"enum": ["CompareBlueprint"], "type": "string"}, "criteria": {"type": "string"}, "indexIdentifiers": {"type": "array", "items": {"type": "string"}}}}, "IWorkflowRapidBlueprintModelFreeTextWorkflowRapidBlueprintModel": {"required": ["question", "shouldValidateResponse", "_t"], "properties": {"_t": {"enum": ["FreeTextBlueprint"], "type": "string"}, "question": {"type": "string"}, "shouldValidateResponse": {"type": "boolean"}, "validationSystemPrompt": {"type": "string", "nullable": true}}}, "IWorkflowRapidBlueprintModelLineWorkflowRapidBlueprintModel": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["LineBlueprint"], "type": "string"}, "target": {"type": "string"}}}, "IWorkflowRapidBlueprintModelLocateWorkflowRapidBlueprintModel": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["LocateBlueprint"], "type": "string"}, "target": {"type": "string"}}}, "IWorkflowRapidBlueprintModelNamedEntityWorkflowRapidBlueprintModel": {"required": ["target", "classes", "_t"], "properties": {"_t": {"enum": ["NamedEntityBlueprint"], "type": "string"}, "target": {"type": "string"}, "classes": {"type": "array", "items": {"type": "string"}}}}, "IWorkflowRapidBlueprintModelPolygonWorkflowRapidBlueprintModel": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["PolygonBlueprint"], "type": "string"}, "target": {"type": "string"}}}, "IWorkflowRapidBlueprintModelScrubWorkflowRapidBlueprintModel": {"required": ["target", "_t"], "properties": {"_t": {"enum": ["ScrubBlueprint"], "type": "string"}, "target": {"type": "string"}}}, "IWorkflowRapidBlueprintModelTranscriptionWorkflowRapidBlueprintModel": {"required": ["title", "_t"], "properties": {"_t": {"enum": ["TranscriptionBlueprint"], "type": "string"}, "title": {"type": "string"}}}, "Line": {"required": ["points"], "type": "object", "properties": {"size": {"type": "number", "format": "double"}, "points": {"type": "array", "items": {"$ref": "#/components/schemas/LinePoint"}}}}, "LinePoint": {"type": "object", "properties": {"x": {"type": "number", "format": "double"}, "y": {"type": "number", "format": "double"}}}, "LocateCoordinate": {"type": "object", "properties": {"x": {"type": "number", "format": "double"}, "y": {"type": "number", "format": "double"}}}, "NamedClassification": {"required": ["classification"], "type": "object", "properties": {"start": {"type": "integer", "format": "int32"}, "end": {"type": "integer", "format": "int32"}, "classification": {"type": "string"}}}, "PolygonCoordinate": {"type": "object", "properties": {"x": {"type": "number", "format": "double", "nullable": true}, "y": {"type": "number", "format": "double", "nullable": true}}}, "PolygonShape": {"required": ["edges"], "type": "object", "properties": {"edges": {"type": "array", "items": {"$ref": "#/components/schemas/PolygonCoordinate"}}}}, "QueryWorkflowsEndpoint_Output": {"required": ["workflow"], "type": "object", "properties": {"workflow": {"allOf": [{"$ref": "#/components/schemas/IWorkflowModel"}], "description": "The workflow."}}}, "QueryWorkflowsEndpoint_PagedResultOfOutput": {"required": ["total", "page", "pageSize", "items"], "type": "object", "properties": {"total": {"type": "integer", "format": "int64"}, "page": {"type": "integer", "format": "int32"}, "pageSize": {"type": "integer", "format": "int32"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/QueryWorkflowsEndpoint_Output"}}, "totalPages": {"type": "integer", "format": "int32"}}}, "RapidState": {"enum": ["Labeling", "Paused", "Incomplete", "Flagged", "Done", "None", "Rejected"]}, "ResponseTally": {"type": "object", "properties": {"count": {"type": "integer", "format": "int64"}, "userScoreSum": {"type": "number", "format": "double"}}}, "SortDirection": {"enum": ["Asc", "Desc"]}, "TranscriptionWord": {"required": ["word"], "type": "object", "properties": {"word": {"type": "string"}, "wordIndex": {"type": "integer", "format": "int32"}}}, "WorkflowState": {"enum": ["Created", "Started", "Labeling", "Paused", "Done", "Failed"]}, "WorkflowStateModel": {"enum": ["Created", "Started", "Labeling", "Paused", "Done", "Failed"]}}, "securitySchemes": {"OpenIdConnect": {"type": "openIdConnect", "description": "OpenID Connect connection flow", "openIdConnectUrl": "https://auth.rapidata.ai/.well-known/openid-configuration"}}}, "x-tagGroups": [{"name": "Rapidata Asset API", "tags": ["Asset", "BatchUpload"]}, {"name": "Rapidata Audience API", "tags": ["Audience", "Examples"]}, {"name": "Rapidata Campaign API", "tags": ["Cache", "Campaign", "ExternalAudience"]}, {"name": "Rapidata Dataset API", "tags": ["ContextShortening", "Datapoints", "Dataset", "DatasetGroup"]}, {"name": "Rapidata Flow API", "tags": ["Flow", "FlowItem", "RankingFlow", "RankingFlowItem"]}, {"name": "Rapidata Identity API", "tags": ["Rapidata.Identity.API", "Client", "Customer", "Identity", "Newsletter", "Organization", "Survey"]}, {"name": "Rapidata Leaderboard API", "tags": ["Benchmark", "SampleGeneration", "Faucet", "Replicate", "Leaderboard", "Participant", "Prompt", "Sample"]}, {"name": "Rapidata Order API", "tags": ["Feedback", "Job", "Order"]}, {"name": "Rapidata Pipeline API", "tags": ["Pipeline"]}, {"name": "Rapidata Rapid API", "tags": ["CustomerRapid", "GlobalText", "Rapid", "UserRapid", "ValidationFeedback"]}, {"name": "Rapidata Signal API", "tags": ["Signal"]}, {"name": "Rapidata Translation API", "tags": ["Translation"]}, {"name": "Rapidata Validation API", "tags": ["ValidationSet"]}, {"name": "Rapidata Workflow API", "tags": ["Evaluation", "GroupedRanking", "Ranking", "SimpleWorkflow", "Workflow"]}]}