openapi: 3.1.0 info: title: Refuel Cloud API description: REST API for the Refuel Cloud data-labeling and data-enrichment platform. Harvested verbatim from https://cloud-api.refuel.ai/openapi.json (FastAPI-generated, OpenAPI 3.1.0). Covers projects, datasets, tasks, task runs, taxonomies, seedsets/evalsets, calibration, finetuned models, deployed applications and their realtime label endpoint, users, teams, usage, and integrations. Authentication is an API key sent as an HTTP Bearer token. The upstream document carries the FastAPI default info block (title "FastAPI", version 0.1.0) and no servers[]; API Evangelist supplies the title/description and the servers[] host documented in Refuel's own quickstart and catalog pages. See openapi/_original/ for the untouched document and overlays/ for every change. version: 0.1.0 contact: name: Refuel url: https://www.refuel.ai email: support@refuel.ai termsOfService: https://www.refuel.ai/terms-of-service x-harvested-from: https://cloud-api.refuel.ai/openapi.json x-harvested-on: '2026-08-14' servers: - url: https://cloud-api.refuel.ai description: Refuel Cloud API paths: /projects: get: summary: Get Projects operationId: get_projects_projects_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_List_' security: - HTTPBearer: [] post: summary: Create Project operationId: create_project_projects_post parameters: - required: true schema: type: string title: Project Name name: project_name in: query - required: true schema: type: string title: Description name: description in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_List_' '409': description: Conflict Error content: application/json: schema: $ref: '#/components/schemas/HTTPError' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /projects/{project_id}: get: summary: Get Project operationId: get_project_projects__project_id__get parameters: - required: true schema: type: string title: Project Id name: project_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '404': description: Not Found Error content: application/json: schema: $ref: '#/components/schemas/HTTPError' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: summary: Delete Project operationId: delete_project_projects__project_id__delete parameters: - required: true schema: type: string title: Project Id name: project_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_ChangeResourceResponse_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /datasets/url: post: summary: Get Presigned Url operationId: get_presigned_url_datasets_url_post responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' security: - HTTPBearer: [] /datasets/infer_schema: post: summary: Infer Schema operationId: infer_schema_datasets_infer_schema_post parameters: - required: false schema: type: string title: Integration Id name: integration_id in: query - required: false schema: type: string title: Source Path name: source_path in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /datasets/ingest: post: summary: Ingest Dataset operationId: ingest_dataset_datasets_ingest_post parameters: - required: false schema: type: string title: S3 Path name: s3_path in: query - required: false schema: type: string title: Dataset Name name: dataset_name in: query - required: false schema: type: string title: Project Id name: project_id in: query - required: false schema: type: boolean title: Redact Pii default: false name: redact_pii in: query - required: false schema: type: string title: Ref Dataset Id name: ref_dataset_id in: query - required: false schema: type: string title: Append Dataset Id name: append_dataset_id in: query requestBody: content: application/json: schema: type: object title: Schema Dict responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /datasets: get: summary: Get Datasets operationId: get_datasets_datasets_get parameters: - required: false schema: type: string title: Project Id name: project_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_List_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /datasets/{dataset_id}: get: summary: Get Items From Dataset operationId: get_items_from_dataset_datasets__dataset_id__get parameters: - required: true schema: type: string title: Dataset Id name: dataset_id in: path - required: false schema: type: integer title: Offset default: 0 name: offset in: query - required: false schema: type: integer title: Max Items default: 10 name: max_items in: query - required: false schema: items: type: string type: array title: Filters name: filters in: query - required: false schema: items: type: string type: array title: Order Bys name: order_bys in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: summary: Delete Dataset operationId: delete_dataset_datasets__dataset_id__delete parameters: - required: true schema: type: string title: Dataset Id name: dataset_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_ChangeResourceResponse_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] patch: summary: Update Dataset operationId: update_dataset_datasets__dataset_id__patch parameters: - required: true schema: type: string title: Dataset Id name: dataset_id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDatasetRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /datasets/{dataset_id}/projects: get: summary: Get Dataset Projects operationId: get_dataset_projects_datasets__dataset_id__projects_get parameters: - required: true schema: type: string title: Dataset Id name: dataset_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /datasets/{dataset_id}/projects/{project_id}: post: summary: Add Project To Dataset operationId: add_project_to_dataset_datasets__dataset_id__projects__project_id__post parameters: - required: true schema: type: string title: Project Id name: project_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: summary: Delete Project From Dataset operationId: delete_project_from_dataset_datasets__dataset_id__projects__project_id__delete parameters: - required: true schema: type: string title: Project Id name: project_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_ChangeResourceResponse_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /datasets/{dataset_id}/items/{item_id}: get: summary: Get Item From Dataset operationId: get_item_from_dataset_datasets__dataset_id__items__item_id__get parameters: - required: true schema: type: string title: Item Id name: item_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: summary: Delete Item From Dataset operationId: delete_item_from_dataset_datasets__dataset_id__items__item_id__delete parameters: - required: true schema: type: string title: Item Id name: item_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /datasets/{dataset_id}/items: post: summary: Add Items To Dataset operationId: add_items_to_dataset_datasets__dataset_id__items_post parameters: - required: true schema: type: string title: Dataset Id name: dataset_id in: path requestBody: content: application/json: schema: items: type: object type: array title: Items required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /datasets/{dataset_id}/exports: post: summary: Export Dataset description: Exports dataset to S3 and emails the user a link to the S3 object operationId: export_dataset_datasets__dataset_id__exports_post parameters: - required: true schema: type: string title: Dataset Id name: dataset_id in: path - required: false schema: type: string title: Task Id name: task_id in: query - required: false schema: type: string title: Email Address name: email_address in: query - required: false schema: type: boolean title: Include Uuid default: false name: include_uuid in: query - required: false schema: type: boolean title: Include Labels default: false name: include_labels in: query - required: false schema: type: string title: Task Run Id name: task_run_id in: query - required: false schema: items: type: string type: array title: Filters name: filters in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '202': description: Accepted. Dataset export in progress. content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /datasets/{dataset_id}/exports/{export_id}: get: summary: Download Dataset operationId: download_dataset_datasets__dataset_id__exports__export_id__get parameters: - required: true schema: type: string title: Export Id name: export_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '202': description: Datset export is still in progress. content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /datasets/{dataset_id}/sample: post: summary: Sample Dataset operationId: sample_dataset_datasets__dataset_id__sample_post parameters: - required: true schema: type: string title: Dataset Id name: dataset_id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/SamplingParams' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /projects/{project_id}/datasets: post: summary: Ingest Dataset V2 description: 'Ingests a dataset into the platform. We support the following ingestion methods: 1. Upload a CSV from local disk 2. Provide an accessible URI to a CSV file' operationId: ingest_dataset_v2_projects__project_id__datasets_post parameters: - required: true schema: type: string title: Project Id name: project_id in: path requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_ingest_dataset_v2_projects__project_id__datasets_post' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /datasets/{dataset_id}/append: post: summary: Append Dataset operationId: append_dataset_datasets__dataset_id__append_post parameters: - required: true schema: type: string title: Dataset Id name: dataset_id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/AppendDatasetRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks: get: summary: Get Team Tasks description: "Get all tasks for a team.\n\nArgs:\n----\n token: Authentication token containing team info\n\nReturns:\n\ -------\n ResponseModel: List of tasks for the team" operationId: get_team_tasks_tasks_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_List_' security: - HTTPBearer: [] /models: get: summary: Get Models description: "Get available models for a team.\n\nArgs:\n----\n token: Authentication token containing team info\n\ \nReturns:\n-------\n ResponseModel: List of available models" operationId: get_models_models_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_List_' security: - HTTPBearer: [] /projects/{project_id}/tasks: get: summary: Get Tasks description: "Get tasks for a specific project.\n\nArgs:\n----\n project_id: ID of the project\n token: Authentication\ \ token containing team info\n\nReturns:\n-------\n ResponseModel: List of tasks for the project\n\nRaises:\n------\n\ \ HTTPException: If project not found or unauthorized" operationId: get_tasks_projects__project_id__tasks_get parameters: - required: true schema: type: string title: Project Id name: project_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_List_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Create Task description: "Create a new task in the specified project.\n\nArgs:\n----\n project_id: ID of the project to create\ \ task in\n task_name: Name of the new task\n task_settings: Dictionary of task configuration settings\n \ \ ref_task_id: Optional ID of reference task to copy settings from\n token: Access token for authentication\n\n\ Returns:\n-------\n ResponseModel containing the created task details\n\nRaises:\n------\n HTTPException: If\ \ task creation fails or validation errors occur" operationId: create_task_projects__project_id__tasks_post parameters: - required: true schema: type: string title: Project Id name: project_id in: path - required: true schema: type: string title: Task Name name: task_name in: query - required: false schema: type: string title: Ref Task Id name: ref_task_id in: query requestBody: content: application/json: schema: type: object title: Task Settings default: {} responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}: get: summary: Get Task description: "Get details for a specific task.\n\nArgs:\n----\n task_id: ID of the task to retrieve\n token: Access\ \ token for authentication\n\nReturns:\n-------\n ResponseModel containing the task details\n\nRaises:\n------\n\ \ HTTPException: If task not found or unauthorized" operationId: get_task_tasks__task_id__get parameters: - required: true schema: type: string title: Task Id name: task_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Edit Task description: "Edit properties of an existing task.\n\nArgs:\n----\n task_id: ID of the task to edit\n edits: Dictionary\ \ of edits to apply to the task\n clear_labels_and_feedback: Whether to clear existing labels and feedback\n \ \ token: Access token for authentication\n\nReturns:\n-------\n ResponseModel containing the updated task details\n\ \nRaises:\n------\n HTTPException: If task not found, unauthorized, or edits are invalid" operationId: edit_task_tasks__task_id__post parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: false schema: type: boolean title: Clear Labels And Feedback default: false name: clear_labels_and_feedback in: query requestBody: content: application/json: schema: type: object title: Edits default: {} responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: summary: Delete Task description: "Delete a task and all associated resources.\n\nArgs:\n----\n task_id: ID of the task to delete\n \ \ token: Access token for authentication\n\nReturns:\n-------\n ResponseModel containing success/failure status\n\ \nRaises:\n------\n HTTPException: If task not found, unauthorized, or deletion fails" operationId: delete_task_tasks__task_id__delete parameters: - required: true schema: type: string title: Task Id name: task_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_ChangeResourceResponse_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/models: get: summary: Get Task Models description: "Get available models for a task.\n\nArgs:\n----\n task_id: ID of the task to get models for\n token:\ \ Access token for authentication\n\nReturns:\n-------\n ResponseModel containing list of available and in-progress\ \ models\n\nRaises:\n------\n HTTPException: If task not found or unauthorized" operationId: get_task_models_tasks__task_id__models_get parameters: - required: true schema: type: string title: Task Id name: task_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/subtasks/{subtask_id}: delete: summary: Delete Subtask description: "Delete a subtask from a task.\n\nArgs:\n----\n task_id: ID of the task containing the subtask\n \ \ subtask_id: ID of the subtask to delete\n token: Access token for authentication\n\nReturns:\n-------\n ResponseModel\ \ indicating success/failure\n\nRaises:\n------\n HTTPException: If task/subtask not found or unauthorized" operationId: delete_subtask_tasks__task_id__subtasks__subtask_id__delete parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Subtask Id name: subtask_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/transforms/{transform_id}: delete: summary: Delete Transform description: "Delete a transform from a task.\n\nArgs:\n----\n task_id: ID of the task containing the transform\n\ \ transform_id: ID of the transform to delete\n token: Access token for authentication\n\nReturns:\n-------\n\ \ ResponseModel indicating success/failure\n\nRaises:\n------\n HTTPException: If task/transform not found or\ \ unauthorized" operationId: delete_transform_tasks__task_id__transforms__transform_id__delete parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Transform Id name: transform_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/datasets/{dataset_id}: get: summary: Get Items From Task Run description: "Get items from a task run for a specific dataset.\n\nArgs:\n----\n task_id: ID of the task to get items\ \ from\n dataset_id: ID of the dataset to get items from\n eval: Whether to get evaluation set items\n offset:\ \ Number of items to skip for pagination\n max_items: Maximum number of items to return\n filters: List of filters\ \ to apply to the query\n order_bys: List of order by clauses to apply\n token: Access token for authentication\n\ \nReturns:\n-------\n ResponseModel containing the items and metadata\n\nRaises:\n------\n HTTPException: If\ \ task/dataset not found or unauthorized" operationId: get_items_from_task_run_tasks__task_id__datasets__dataset_id__get parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path - required: false schema: type: boolean title: Eval default: false name: eval in: query - required: false schema: type: integer title: Offset default: 0 name: offset in: query - required: false schema: type: integer title: Max Items default: 10 name: max_items in: query - required: false schema: items: type: string type: array title: Filters name: filters in: query - required: false schema: items: type: string type: array title: Order Bys name: order_bys in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/seedset: get: summary: Get Items From Seedset description: "Get items from a task's seedset with filtering and pagination.\n\nArgs:\n----\n task_id: ID of the\ \ task to get seedset items from\n offset: Number of items to skip for pagination\n max_items: Maximum number\ \ of items to return\n filters: List of filters to apply to the results\n order_bys: List of fields to order\ \ results by\n token: Access token for authentication\n\nReturns:\n-------\n ResponseModel containing the filtered\ \ and paginated seedset items\n\nRaises:\n------\n HTTPException: If task not found or unauthorized" operationId: get_items_from_seedset_tasks__task_id__seedset_get parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: false schema: type: integer title: Offset default: 0 name: offset in: query - required: false schema: type: integer title: Max Items default: 10 name: max_items in: query - required: false schema: items: type: string type: array title: Filters name: filters in: query - required: false schema: items: type: string type: array title: Order Bys name: order_bys in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/evalset: get: summary: Get Items From Evalset description: "Get items from a task's evaluation set.\n\nArgs:\n----\n task_id: ID of the task to get evaluation\ \ items from\n model_id: Optional model ID to filter results\n offset: Number of items to skip for pagination\n\ \ max_items: Maximum number of items to return\n filters: List of filters to apply to results\n order_bys:\ \ List of fields to order results by\n token: Access token for authentication\n\nReturns:\n-------\n ResponseModel\ \ containing evaluation set items with:\n - schema: Dataset schema\n - items: List of evaluation items\n\ \ - total_count: Total number of items\n - task/dataset metadata\n\nRaises:\n------\n HTTPException:\ \ If task not found or unauthorized" operationId: get_items_from_evalset_tasks__task_id__evalset_get parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: false schema: type: string title: Model Id name: model_id in: query - required: false schema: type: integer title: Offset default: 0 name: offset in: query - required: false schema: type: integer title: Max Items default: 10 name: max_items in: query - required: false schema: items: type: string type: array title: Filters name: filters in: query - required: false schema: items: type: string type: array title: Order Bys name: order_bys in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Create Evalset description: "Create an evaluation set for a task by sampling items from a dataset.\n\nArgs:\n----\n task_id: ID\ \ of the task to create evalset for\n dataset_id: ID of the dataset to sample from\n sampling_parameters: Parameters\ \ for sampling items\n filters: List of filters to apply when sampling\n token: Access token for authentication\n\ \nReturns:\n-------\n ResponseModel containing success status\n\nRaises:\n------\n HTTPException: If task/dataset\ \ not found or unauthorized" operationId: create_evalset_tasks__task_id__evalset_post parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: query - required: false schema: items: type: string type: array title: Filters name: filters in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/SamplingEvent' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_ChangeResourceResponse_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/runs/{dataset_id}/metrics: get: summary: Get Metrics For Task Run description: "Get metrics for a specific task run.\n\nArgs:\n----\n task_id: ID of the task to get metrics for\n\ \ dataset_id: ID of the dataset to get metrics for\n filters: List of filters to apply when calculating metrics\n\ \ eval: Whether to get metrics for evaluation mode\n token: Access token for authentication\n\nReturns:\n-------\n\ \ ResponseModel containing metrics data\n\nRaises:\n------\n HTTPException: If task/dataset not found or unauthorized" operationId: get_metrics_for_task_run_tasks__task_id__runs__dataset_id__metrics_get parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path - required: false schema: type: boolean title: Eval default: false name: eval in: query - required: false schema: items: type: string type: array title: Filters name: filters in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/evalset/metrics: get: summary: Get Evalset Metrics For Task Run description: "Get evaluation metrics for a task's evaluation set.\n\nArgs:\n----\n task_id: ID of the task to get\ \ metrics for\n filters: Optional list of filters to apply to the evaluation set\n model_id: Optional model\ \ ID to filter results by\n token: Access token for authentication\n\nReturns:\n-------\n ResponseModel containing\ \ metrics data with:\n - Mapping of subtask IDs to list of MetricResult objects\n - Each MetricResult\ \ contains metric name, value and support count\n\nRaises:\n------\n HTTPException: If task not found or unauthorized" operationId: get_evalset_metrics_for_task_run_tasks__task_id__evalset_metrics_get parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: false schema: type: string title: Model Id name: model_id in: query - required: false schema: items: type: string type: array title: Filters name: filters in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/runs/{dataset_id}: get: summary: Get Task Run description: "Get details about a specific task run.\n\nArgs:\n----\n task_id: ID of the task to get run details\ \ for\n dataset_id: ID of the dataset the task was run on\n eval: If True, get evaluation run instead of regular\ \ run\n token: Access token for authentication\n\nReturns:\n-------\n ResponseModel containing the task run\ \ details\n\nRaises:\n------\n HTTPException: If task/dataset not found or unauthorized" operationId: get_task_run_tasks__task_id__runs__dataset_id__get parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path - required: false schema: type: boolean title: Eval default: false name: eval in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Update Task Run operationId: update_task_run_tasks__task_id__runs__dataset_id__post parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path - required: false schema: type: boolean title: Cancel Run default: false name: cancel_run in: query - required: false schema: type: integer title: Num Items name: num_items in: query - required: false schema: type: boolean title: Eval default: false name: eval in: query - required: false schema: items: type: string type: array title: Filters name: filters in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: summary: Clear Task Run description: "Delete a task run and its associated data.\n\nArgs:\n----\n task_id: ID of the task to clear run for\n\ \ dataset_id: ID of the dataset containing the run\n token: Access token for authentication\n\nReturns:\n-------\n\ \ ResponseModel indicating success/failure\n\nRaises:\n------\n HTTPException: If task/dataset not found or\ \ unauthorized" operationId: clear_task_run_tasks__task_id__runs__dataset_id__delete parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/runs: get: summary: Get Task Runs description: "Get all task runs for a specific task.\n\nArgs:\n----\n task_id: ID of the task to get runs for\n \ \ token: Access token for authentication\n\nReturns:\n-------\n ResponseModel containing list of task runs with:\n\ \ - id: str - Task run ID\n - project_id: str - Project ID\n - task_id: str - Task ID\n \ \ - task_name: str - Task name\n - model_name: str - Model name\n - dataset_id: str - Dataset ID\n\ \ - dataset_name: str - Dataset name\n - status: str - Run status\n - is_eval_run: bool - Whether\ \ this is an evaluation run\n - created_at: datetime - Creation timestamp\n - updated_at: datetime -\ \ Last update timestamp\n\nRaises:\n------\n HTTPException: If task not found or unauthorized" operationId: get_task_runs_tasks__task_id__runs_get parameters: - required: true schema: type: string title: Task Id name: task_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Update Task Run V2 description: "Update or manage a task run for a specific task.\n\nArgs:\n----\n task_id: ID of the task to update\ \ run for\n dataset_id: Optional ID of dataset to run task on\n cancel_run: Whether to cancel an existing run\n\ \ num_items: Number of items to process in run\n filters: List of filters to apply to dataset\n eval: Whether\ \ this is an evaluation run\n token: Access token for authentication\n\nReturns:\n-------\n Response indicating\ \ success/failure\n\nRaises:\n------\n HTTPException: If task not found or unauthorized" operationId: update_task_run_v2_tasks__task_id__runs_post parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: false schema: type: string title: Dataset Id name: dataset_id in: query - required: false schema: type: boolean title: Cancel Run default: false name: cancel_run in: query - required: false schema: type: integer title: Num Items name: num_items in: query - required: false schema: type: boolean title: Eval default: false name: eval in: query - required: false schema: items: type: string type: array title: Filters name: filters in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/datasets/{dataset_id}/items/{item_id}/label: get: summary: Preview Labels V2 description: "Preview labels for a specific item in a dataset.\n\nArgs:\n----\n task_id: ID of the task to preview\ \ labels for\n dataset_id: ID of the dataset containing the item\n item_id: ID of the item to preview labels\ \ for\n model_id: Optional model ID to use for generating labels\n subtask_id: Optional subtask ID to filter\ \ labels for\n token: Access token for authentication\n generate_missing_labels: Whether to generate missing\ \ labels\n generate_missing_explanations: Whether to generate missing explanations\n\nReturns:\n-------\n ResponseModel\ \ containing the previewed labels\n\nRaises:\n------\n HTTPException: If dataset/task not found or unauthorized" operationId: preview_labels_v2_tasks__task_id__datasets__dataset_id__items__item_id__label_get parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path - required: true schema: type: string title: Item Id name: item_id in: path - required: false schema: type: string title: Model Id name: model_id in: query - required: false schema: type: string title: Subtask Id name: subtask_id in: query - required: false schema: type: boolean title: Generate Missing Labels default: true name: generate_missing_labels in: query - required: false schema: type: boolean title: Generate Missing Explanations default: false name: generate_missing_explanations in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Edit Labels V2 description: "Edit labels for a specific item in a dataset.\n\nArgs:\n----\n task_id: ID of the task containing the\ \ item\n dataset_id: ID of the dataset containing the item\n item_id: ID of the item to edit labels for\n \ \ label_edits: Dictionary containing label edits to apply\n token: Access token for authentication\n\nReturns:\n\ -------\n ResponseModel indicating success/failure\n\nRaises:\n------\n HTTPException: If no label provided\ \ or validation fails" operationId: edit_labels_v2_tasks__task_id__datasets__dataset_id__items__item_id__label_post parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path - required: true schema: type: string title: Item Id name: item_id in: path requestBody: content: application/json: schema: type: object title: Label Edits required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/evalset/items/{item_id}: delete: summary: Remove Item From Evalset description: "Remove an item from a task's evaluation set.\n\nArgs:\n----\n task_id: ID of the task containing the\ \ evalset\n item_id: ID of the item to remove from evalset\n token: Access token for authentication\n\nReturns:\n\ -------\n ResponseModel containing success/failure status\n\nRaises:\n------\n HTTPException: If task/item not\ \ found or unauthorized" operationId: remove_item_from_evalset_tasks__task_id__evalset_items__item_id__delete parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Item Id name: item_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_ChangeResourceResponse_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/evalset/items: post: summary: Add Item To Evalset description: "Add an item to the evaluation set and set its expected label.\n\nArgs:\n----\n task_id: ID of the task\ \ to add item to\n dataset_id: ID of the dataset containing the item\n item_id: ID of the item to add to evalset\n\ \ token: Access token for authentication\n\nReturns:\n-------\n ResponseModel containing success/failure status\n\ \nRaises:\n------\n HTTPException: If task/dataset not found or unauthorized" operationId: add_item_to_evalset_tasks__task_id__evalset_items_post parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: query - required: true schema: type: string title: Item Id name: item_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_ChangeResourceResponse_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/seedset/items/{item_id}: delete: summary: Remove Item From Seedset description: "Remove an item from a task's seedset and optionally add it to evalset.\n\nArgs:\n----\n task_id: ID\ \ of the task containing the seedset\n item_id: ID of the item to remove from seedset\n token: Access token\ \ for authentication\n\nReturns:\n-------\n ResponseModel containing success/failure status\n\nRaises:\n------\n\ \ HTTPException: If task/item not found or unauthorized" operationId: remove_item_from_seedset_tasks__task_id__seedset_items__item_id__delete parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Item Id name: item_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_ChangeResourceResponse_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/seedset/items: post: summary: Add Item To Seedset description: "Add an item to the seedset and set its expected label.\n\nArgs:\n----\n task_id: ID of the task to\ \ add item to\n dataset_id: ID of the dataset containing the item\n item_id: ID of the item to add to seedset\n\ \ token: Access token for authentication\n\nReturns:\n-------\n ResponseModel containing success status\n\n\ Raises:\n------\n HTTPException: If task/dataset not found, unauthorized, or item not verified" operationId: add_item_to_seedset_tasks__task_id__seedset_items_post parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: query - required: true schema: type: string title: Item Id name: item_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_ChangeResourceResponse_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/datasets/{dataset_id}/items/{item_id}: get: summary: Get Item From Task Run description: "Get an item and its associated data from a task run.\n\nArgs:\n----\n task_id: ID of the task to get\ \ item from\n dataset_id: ID of the dataset containing the item\n item_id: ID of the item to retrieve\n model_id:\ \ Optional model ID to filter results\n token: Access token for authentication\n\nReturns:\n-------\n ResponseModel\ \ containing the item data with:\n - fields: Dict[str, Any] - Item field values\n - labels: List[Label]\ \ - Associated labels\n - telemetry: List[Telemetry] - Telemetry data\n - in_evalset: bool - Whether\ \ item is in evaluation set\n\nRaises:\n------\n HTTPException: If task/dataset/item not found or unauthorized" operationId: get_item_from_task_run_tasks__task_id__datasets__dataset_id__items__item_id__get parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path - required: true schema: type: string title: Item Id name: item_id in: path - required: false schema: type: string title: Model Id name: model_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Modify Item Properties description: "Modify properties of a labeled item in a dataset.\n\nThis endpoint allows modifying properties of items\ \ that have already been labeled.\nIt can add items to the evalset table and set their expected labels based on\n\ the final merged label from LLM and human annotations.\n\nArgs:\n----\n task_id: ID of the task containing the\ \ item\n dataset_id: ID of the dataset containing the item\n item_id: ID of the item to modify\n item_properties:\ \ Properties to modify for the item\n model_id: Optional model ID to use\n token: Access token for authentication\n\ \nReturns:\n-------\n ResponseModel containing success/failure status\n\nRaises:\n------\n HTTPException: If\ \ dataset/task not found or unauthorized" operationId: modify_item_properties_tasks__task_id__datasets__dataset_id__items__item_id__post parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Dataset Id name: dataset_id in: path - required: true schema: type: string title: Item Id name: item_id in: path - required: false schema: type: string title: Model Id name: model_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/ItemProperties' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_ChangeResourceResponse_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/evalset/runs: get: summary: Get Evalset Run description: "Get evaluation run details for a task.\n\nArgs:\n----\n task_id: ID of the task to get evaluation run\ \ for\n token: Access token for authentication\n\nReturns:\n-------\n ResponseModel containing evaluation run\ \ details\n\nRaises:\n------\n HTTPException: If task not found or unauthorized" operationId: get_evalset_run_tasks__task_id__evalset_runs_get parameters: - required: true schema: type: string title: Task Id name: task_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Update Task Run Evalset description: "Update or cancel evaluation set runs for a task.\n\nArgs:\n----\n task_id: ID of the task to update\ \ evalset runs for\n cancel_run: Whether to cancel existing runs\n filters: List of filters to apply to the\ \ evalset\n model_ids: List of model IDs to run evaluation for\n token: Access token for authentication\n\n\ Returns:\n-------\n ChangeResourceResponse indicating success/failure\n\nRaises:\n------\n HTTPException: If\ \ task not found or unauthorized" operationId: update_task_run_evalset_tasks__task_id__evalset_runs_post parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: false schema: type: boolean title: Cancel Run default: false name: cancel_run in: query - required: false schema: items: type: string type: array title: Model Ids default: [] name: model_ids in: query - required: false schema: items: type: string type: array title: Filters name: filters in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/{tag}/exports: post: summary: Export Task description: "Export task data with optional filters and email notification.\n\nArgs:\n----\n task_id: ID of the\ \ task to export\n tag: Type of data to export (e.g. train, test)\n email_address: Optional email to send export\ \ notification to\n filters: Optional list of filters to apply to export\n token: Access token for authentication\n\ \nReturns:\n-------\n ResponseModel indicating export started\n\nRaises:\n------\n HTTPException: If task not\ \ found or unauthorized" operationId: export_task_tasks__task_id___tag__exports_post parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: $ref: '#/components/schemas/TagType' name: tag in: path - required: false schema: type: string title: Email Address name: email_address in: query - required: false schema: items: type: string type: array title: Filters name: filters in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '202': description: Accepted. Task export in progress. content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/{tag}/exports/{export_id}: get: summary: Download Export Task description: "Download an exported task file.\n\nArgs:\n----\n task_id: ID of the task that was exported\n tag:\ \ Type of export tag\n export_id: ID of the export to download\n token: Access token for authentication\n\n\ Returns:\n-------\n ResponseModel containing download URL or progress status\n\nRaises:\n------\n HTTPException:\ \ If task/export not found or unauthorized" operationId: download_export_task_tasks__task_id___tag__exports__export_id__get parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: $ref: '#/components/schemas/TagType' name: tag in: path - required: true schema: type: string title: Export Id name: export_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '202': description: Task export is still in progress. content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /schema: post: summary: Validate Schema description: "Validate a schema string and return an example if valid.\n\nArgs:\n----\n schema: The schema string\ \ to validate\n token: Access token for authentication\n\nReturns:\n-------\n ResponseModel containing a valid\ \ example if schema is valid\n\nRaises:\n------\n HTTPException: If schema is invalid or validation fails" operationId: validate_schema_schema_post parameters: - required: true schema: type: string title: Schema name: schema in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/taxonomies/{taxonomy_id}: get: summary: Get Taxonomy description: "Get a taxonomy and its labels for a task.\n\nArgs:\n----\n task_id: ID of the task containing the taxonomy\n\ \ taxonomy_id: ID of the taxonomy to retrieve\n filter: Optional filter string to filter labels\n start_index:\ \ Optional starting index for pagination\n max_items: Optional maximum number of items to return\n token: Access\ \ token for authentication\n\nReturns:\n-------\n ResponseModel containing the taxonomy and its labels\n\nRaises:\n\ ------\n HTTPException: If task/taxonomy not found or unauthorized" operationId: get_taxonomy_tasks__task_id__taxonomies__taxonomy_id__get parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Taxonomy Id name: taxonomy_id in: path - required: false schema: type: string title: Filter name: filter in: query - required: false schema: type: integer title: Start Index default: 0 name: start_index in: query - required: false schema: type: integer title: Max Items default: 100 name: max_items in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Add Labels To Taxonomy With File description: "Add labels to an existing taxonomy from a file or JSON input.\n\nArgs:\n----\n task_id: ID of the task\ \ containing the taxonomy\n taxonomy_id: ID of the taxonomy to add labels to\n labels: JSON string containing\ \ label objects to add\n file: Optional CSV file containing labels to add\n token: Access token for authentication\n\ \nReturns:\n-------\n ResponseModel containing the updated taxonomy\n\nRaises:\n------\n HTTPException: If parsing\ \ labels fails or validation errors occur" operationId: add_labels_to_taxonomy_with_file_tasks__task_id__taxonomies__taxonomy_id__post parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Taxonomy Id name: taxonomy_id in: path requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_add_labels_to_taxonomy_with_file_tasks__task_id__taxonomies__taxonomy_id__post' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: summary: Delete Taxonomy operationId: delete_taxonomy_tasks__task_id__taxonomies__taxonomy_id__delete parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Taxonomy Id name: taxonomy_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/taxonomies: post: summary: Create Taxonomy With Labels File description: "Create a new taxonomy with labels for a task.\n\nArgs:\n----\n task_id: ID of the task to create taxonomy\ \ for\n labels: JSON string containing list of taxonomy labels\n file: Optional CSV file containing labels\n\ \ token: Access token for authentication\n\nReturns:\n-------\n ResponseModel containing the created taxonomy\n\ \nRaises:\n------\n HTTPException: If label parsing fails or validation errors occur" operationId: create_taxonomy_with_labels_file_tasks__task_id__taxonomies_post parameters: - required: true schema: type: string title: Task Id name: task_id in: path requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_create_taxonomy_with_labels_file_tasks__task_id__taxonomies_post' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/taxonomies/{taxonomy_id}/labels/{label_id}: delete: summary: Delete Subtask Label description: "Delete a label from a task's taxonomy.\n\nArgs:\n----\n task_id: ID of the task containing the taxonomy\n\ \ taxonomy_id: ID of the taxonomy containing the label\n label_id: ID of the label to delete\n token: Access\ \ token for authentication\n\nReturns:\n-------\n ResponseModel indicating success/failure\n\nRaises:\n------\n\ \ HTTPException: If task/taxonomy/label not found or unauthorized" operationId: delete_subtask_label_tasks__task_id__taxonomies__taxonomy_id__labels__label_id__delete parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Taxonomy Id name: taxonomy_id in: path - required: true schema: type: string title: Label Id name: label_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] patch: summary: Edit Taxonomy Label description: "Edit a label in a task's taxonomy.\n\nArgs:\n----\n task_id: ID of the task containing the taxonomy\n\ \ taxonomy_id: ID of the taxonomy containing the label\n label_id: ID of the label to edit\n taxonomy_label:\ \ Updated label data\n token: Access token for authentication\n\nReturns:\n-------\n ResponseModel indicating\ \ success/failure\n\nRaises:\n------\n HTTPException: If task/taxonomy not found or unauthorized" operationId: edit_taxonomy_label_tasks__task_id__taxonomies__taxonomy_id__labels__label_id__patch parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Taxonomy Id name: taxonomy_id in: path - required: true schema: type: string title: Label Id name: label_id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/TaxonomyLabel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/taxonomies/{taxonomy_id}/duplicate: post: summary: Duplicate Taxonomy operationId: duplicate_taxonomy_tasks__task_id__taxonomies__taxonomy_id__duplicate_post parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Taxonomy Id name: taxonomy_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /applications: get: summary: Get Team Applications operationId: get_team_applications_applications_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_List_' security: - HTTPBearer: [] /projects/{project_id}/applications: get: summary: Get Applications operationId: get_applications_projects__project_id__applications_get parameters: - required: true schema: type: string title: Project Id name: project_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_List_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Create Application operationId: create_application_projects__project_id__applications_post parameters: - required: true schema: type: string title: Project Id name: project_id in: path - required: true schema: type: string title: Task Id name: task_id in: query - required: false schema: type: string title: Application Name name: application_name in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /applications/{application_id}: get: summary: Get Application operationId: get_application_applications__application_id__get parameters: - required: true schema: type: string title: Application Id name: application_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: summary: Delete Application operationId: delete_application_applications__application_id__delete parameters: - required: true schema: type: string title: Application Id name: application_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_ChangeResourceResponse_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /applications/{application_id}/label: post: summary: Online Label operationId: online_label_applications__application_id__label_post parameters: - required: true schema: type: string title: Application Id name: application_id in: path - required: false schema: type: string title: Model Id name: model_id in: query - required: false schema: type: string title: Item Id name: item_id in: query - required: false schema: type: boolean title: Is Async default: false name: is_async in: query - required: false schema: type: boolean title: Log Data default: true name: log_data in: query - required: false schema: type: boolean title: Explain default: false name: explain in: query - required: false schema: type: boolean title: Redact Pii default: false name: redact_pii in: query - required: false schema: type: string title: Explain Fields name: explain_fields in: query - required: false schema: type: boolean title: Telemetry default: false name: telemetry in: query requestBody: content: application/json: schema: items: type: object type: array title: Items required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '202': description: Accepted for Processing. When is_async is set to True content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - HTTPBearer: [] /applications/{application_id}/items/{item_id}: get: summary: Get Application Item operationId: get_application_item_applications__application_id__items__item_id__get parameters: - required: true schema: type: string title: Application Id name: application_id in: path - required: true schema: type: string title: Item Id name: item_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '202': description: Application is still processing the request. content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /applications/{application_id}/items: get: summary: Get Items From Application operationId: get_items_from_application_applications__application_id__items_get parameters: - required: true schema: type: string title: Application Id name: application_id in: path - required: false schema: items: type: string type: array title: Item Ids name: item_ids in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /applications/{application_id}/items/{item_id}/label: post: summary: Application Feedback operationId: application_feedback_applications__application_id__items__item_id__label_post parameters: - required: true schema: type: string title: Application Id name: application_id in: path - required: true schema: type: string title: Item Id name: item_id in: path requestBody: content: application/json: schema: type: object title: Feedback required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /applications/{application_id}/usage: get: summary: Get Application Usage operationId: get_application_usage_applications__application_id__usage_get parameters: - required: true schema: type: string title: Application Id name: application_id in: path - required: false schema: type: string title: Start Date name: start_date in: query - required: false schema: type: string title: End Date name: end_date in: query - required: false schema: type: integer title: Period name: period in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /users: get: summary: Get Users operationId: get_users_users_get parameters: - required: false schema: items: type: string format: email type: array title: Emails default: [] name: emails in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_List_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Invite Users operationId: invite_users_users_post requestBody: content: application/json: schema: items: type: string format: email type: array title: Emails required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreateUsersResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /users/{user_id}: get: summary: Get User operationId: get_user_users__user_id__get parameters: - required: true schema: type: string title: User Id name: user_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] patch: summary: Update User operationId: update_user_users__user_id__patch parameters: - required: true schema: type: string title: User Id name: user_id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /users/{user_email}: post: summary: Create User operationId: create_user_users__user_email__post parameters: - required: true schema: type: string format: email title: User Email name: user_email in: path requestBody: content: application/json: schema: type: object title: Request required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /user: get: summary: Get Authenticated User operationId: get_authenticated_user_user_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_Dict_' security: - HTTPBearer: [] patch: summary: Update Authenticated User operationId: update_authenticated_user_user_patch requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAuthenticatedUserRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_Dict_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /teams: get: summary: Get Teams operationId: get_teams_teams_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_List_refuel_cloud_core.schemas.team.TeamSchema__' security: - HTTPBearer: [] /team/sign-url: get: summary: Get Presigned Url operationId: get_presigned_url_team_sign_url_get parameters: - required: true schema: type: string title: Url name: url in: query - required: false schema: type: integer title: Expiration default: 60 name: expiration in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SignedURLResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /usage: get: summary: Get Team Usage operationId: get_team_usage_usage_get parameters: - required: false schema: type: string title: Start Date name: start_date in: query - required: false schema: type: string title: End Date name: end_date in: query - required: false schema: type: string title: Application Id name: application_id in: query - required: false schema: type: string title: Task Id name: task_id in: query - required: false schema: type: string title: Model name: model in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /team: get: summary: Get Team operationId: get_team_team_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel_Dict_' security: - HTTPBearer: [] post: summary: Update Team operationId: update_team_team_post parameters: - required: false schema: type: boolean title: Regenerate Api Key default: false name: regenerate_api_key in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /integrations: get: summary: Get Integrations operationId: get_integrations_integrations_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' security: - HTTPBearer: [] /integrations/{integration_id}: get: summary: Get Integration operationId: get_integration_integrations__integration_id__get parameters: - required: true schema: type: string title: Integration Id name: integration_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] patch: summary: Update Integration operationId: update_integration_integrations__integration_id__patch parameters: - required: true schema: type: string title: Integration Id name: integration_id in: path requestBody: content: application/json: schema: type: object title: Data default: {} responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /webhook/events: post: summary: Process Event description: Process incoming webhook events operationId: process_event_webhook_events_post requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookEventRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WebhookResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /webhooks/{webhook_id}/events: post: summary: Process Webhook Event description: Process incoming webhook events operationId: process_webhook_event_webhooks__webhook_id__events_post parameters: - required: true schema: type: string title: Webhook Id name: webhook_id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/AirbyteWebhookRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WebhookResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /tasks/{task_id}/calibrations: get: summary: Get Calibration Models description: Gets all calibration models for a given task operationId: get_calibration_models_tasks__task_id__calibrations_get parameters: - required: true schema: type: string title: Task Id name: task_id in: path responses: '200': description: Successful Response content: application/json: schema: items: type: object type: array title: Response Get Calibration Models Tasks Task Id Calibrations Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Calibrate Task description: Triggers training for a calibration model for a given task. operationId: calibrate_task_tasks__task_id__calibrations_post parameters: - required: true schema: type: string title: Task Id name: task_id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCalibrationRequest' required: true responses: '200': description: Successful Response content: application/json: schema: items: type: object type: array title: Response Calibrate Task Tasks Task Id Calibrations Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/calibrations/{calibration_id}: get: summary: Get Calibration Model From Id description: Gets the calibration model object from the id operationId: get_calibration_model_from_id_tasks__task_id__calibrations__calibration_id__get parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Calibration Id name: calibration_id in: path responses: '200': description: Successful Response content: application/json: schema: type: object title: Response Get Calibration Model From Id Tasks Task Id Calibrations Calibration Id Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] patch: summary: Update Calibration Model description: Updates the calibration model object from the id operationId: update_calibration_model_tasks__task_id__calibrations__calibration_id__patch parameters: - required: true schema: type: string title: Task Id name: task_id in: path - required: true schema: type: string title: Calibration Id name: calibration_id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCalibrationRequest' required: true responses: '200': description: Successful Response content: application/json: schema: type: object title: Response Update Calibration Model Tasks Task Id Calibrations Calibration Id Patch '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /projects/{project_id}/finetuned_models: get: summary: Get Finetuned Models For Project Task description: Gets all finetuned models for a project. operationId: get_finetuned_models_for_project_task_projects__project_id__finetuned_models_get parameters: - required: true schema: type: string title: Project Id name: project_id in: path - required: false schema: type: string title: Task Id name: task_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: summary: Finetune Model For Task description: 'Triggers finetuning on the given data. Training data needs the following data per row: - task input columns - task instructions - label' operationId: finetune_model_for_task_projects__project_id__finetuned_models_post requestBody: content: application/json: schema: $ref: '#/components/schemas/TrainModelRequest' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /tasks/{task_id}/trainable: get: summary: Trainable Task description: Gets whether a task is trainable. operationId: trainable_task_tasks__task_id__trainable_get parameters: - required: true schema: type: string title: Task Id name: task_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TrainableResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /finetuned_models/{model_id}: get: summary: Get Finetuned Model From Id description: Gets the training status for a finetuned model. operationId: get_finetuned_model_from_id_finetuned_models__model_id__get parameters: - required: true schema: type: string title: Model Id name: model_id in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: summary: Delete Finetuned Model From Id description: Deletes a finetuned model. operationId: delete_finetuned_model_from_id_finetuned_models__model_id__delete parameters: - required: true schema: type: string title: Model Id name: model_id in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] patch: summary: Update Finetuned Model description: Update an existing finetuned model. operationId: update_finetuned_model_finetuned_models__model_id__patch parameters: - required: true schema: type: string title: Model Id name: model_id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/EditModelRequest' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /labs/label: post: summary: Label operationId: label_labs_label_post requestBody: content: application/json: schema: $ref: '#/components/schemas/LabsRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /labs/feedback: post: summary: Collect Feedback operationId: collect_feedback_labs_feedback_post requestBody: content: application/json: schema: $ref: '#/components/schemas/LabsFeedback' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /access/llm: post: summary: Request Llm Access operationId: request_llm_access_access_llm_post responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' /access/llm/interactions: post: summary: Handle Llm Slack Interactions description: 'Handles the interaction when an admin clicks on the button to approve or reject the access key generation request' operationId: handle_llm_slack_interactions_access_llm_interactions_post responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' /access/product: post: summary: Request Product Access operationId: request_product_access_access_product_post responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' /access/product/interactions: post: summary: Handle Product Slack Interactions description: 'Handles the interaction when an admin clicks on the button to approve or reject the access key generation request' operationId: handle_product_slack_interactions_access_product_interactions_post responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' /: get: summary: Read Root operationId: read_root__get responses: '200': description: Successful Response content: application/json: schema: {} /csp-reports: post: summary: Csp Reports operationId: csp_reports_csp_reports_post responses: '200': description: Successful Response content: application/json: schema: {} components: schemas: APIUsage: properties: quota: type: integer title: Quota monthly_quota: type: integer title: Monthly Quota monthly_usage: type: integer title: Monthly Usage default: 0 type: object required: - quota title: APIUsage AWSEventType: type: string enum: - s3_file_uploaded title: AWSEventType description: An enumeration. AWSS3FileUploadedPayload: properties: dataset: type: string title: Dataset project: type: string title: Project s3_path: type: string title: S3 Path task: type: string title: Task type: object required: - dataset - project - s3_path - task title: AWSS3FileUploadedPayload AirbyteWebhookRequest: properties: text: type: string title: Text blocks: items: type: object type: array title: Blocks default: [] data: type: object title: Data default: {} type: object required: - text title: AirbyteWebhookRequest AppendDatasetRequest: properties: source_path: type: string title: Source Path redact_pii: type: boolean title: Redact Pii type: object required: - source_path - redact_pii title: AppendDatasetRequest AvailabilityStatus: type: string enum: - UNAVAILABLE - AVAILABLE title: AvailabilityStatus description: An enumeration. Body_add_labels_to_taxonomy_with_file_tasks__task_id__taxonomies__taxonomy_id__post: properties: labels: type: string title: Labels default: '[]' file: type: string format: binary title: File type: object title: Body_add_labels_to_taxonomy_with_file_tasks__task_id__taxonomies__taxonomy_id__post Body_create_taxonomy_with_labels_file_tasks__task_id__taxonomies_post: properties: labels: type: string title: Labels default: '[]' file: type: string format: binary title: File type: object title: Body_create_taxonomy_with_labels_file_tasks__task_id__taxonomies_post Body_ingest_dataset_v2_projects__project_id__datasets_post: properties: file: type: string format: binary title: File name: type: string title: Name integration_id: type: string title: Integration Id redact_pii: type: boolean title: Redact Pii default: false source_path: type: string title: Source Path schema: type: string title: Schema source: allOf: - $ref: '#/components/schemas/DatasetSource' default: file type: object required: - name title: Body_ingest_dataset_v2_projects__project_id__datasets_post CalibrationStatus: type: string enum: - IN_PROGRESS - COMPLETED - INTERRUPTED - DELETED title: CalibrationStatus description: An enumeration. ChangeResourceResponse: properties: success: type: boolean title: Success error: type: string title: Error default: '' type: object required: - success title: ChangeResourceResponse CreateCalibrationRequest: properties: hyperparameters: type: object title: Hyperparameters default: {} type: object title: CreateCalibrationRequest CreateUsersResponse: properties: success: items: type: string type: array title: Success failed: items: type: string type: array title: Failed default: [] type: object required: - success title: CreateUsersResponse DatasaurEventType: type: string enum: - project_created title: DatasaurEventType description: An enumeration. DatasaurProjectCreationPayload: properties: project_id: type: string title: Project Id project_name: type: string title: Project Name refuel_task_name: type: string title: Refuel Task Name type: object required: - project_id - refuel_task_name title: DatasaurProjectCreationPayload DatasetSource: type: string enum: - databricks - file - s3 - snowflake - uri title: DatasetSource description: An enumeration. EditModelRequest: properties: availability_status: $ref: '#/components/schemas/AvailabilityStatus' finetuning_run_status: $ref: '#/components/schemas/UserAction' type: object title: EditModelRequest HTTPError: properties: detail: type: string title: Detail type: object required: - detail title: HTTPError example: detail: HTTPException raised. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ItemProperties: properties: in_evalset: type: boolean title: In Evalset type: object required: - in_evalset title: ItemProperties LabsFeedback: properties: session_id: type: string title: Session Id comparison_id: type: string title: Comparison Id referrer: type: string title: Referrer task_type: type: string title: Task Type guidelines: type: string title: Guidelines labels: items: type: string type: array title: Labels context: type: string title: Context input: type: string title: Input llm_labels: items: type: object type: array title: Llm Labels feedback: type: integer title: Feedback type: object required: - task_type - guidelines - input - llm_labels - feedback title: LabsFeedback LabsRequest: properties: session_id: type: string title: Session Id comparison_id: type: string title: Comparison Id referrer: type: string title: Referrer task_type: type: string title: Task Type guidelines: type: string title: Guidelines labels: items: type: string type: array title: Labels context: type: string title: Context input: type: string title: Input model: type: string title: Model type: object required: - task_type - guidelines - input - model title: LabsRequest ResponseModel: properties: success: type: boolean title: Success default: true error_msg: type: string title: Error Msg data: title: Data count: type: integer title: Count type: object title: ResponseModel ResponseModel_ChangeResourceResponse_: properties: success: type: boolean title: Success default: true error_msg: type: string title: Error Msg data: $ref: '#/components/schemas/ChangeResourceResponse' count: type: integer title: Count type: object title: ResponseModel[ChangeResourceResponse] ResponseModel_Dict_: properties: success: type: boolean title: Success default: true error_msg: type: string title: Error Msg data: type: object title: Data count: type: integer title: Count type: object title: ResponseModel[Dict] ResponseModel_List_: properties: success: type: boolean title: Success default: true error_msg: type: string title: Error Msg data: items: {} type: array title: Data count: type: integer title: Count type: object title: ResponseModel[List] ResponseModel_List_refuel_cloud_core.schemas.team.TeamSchema__: properties: success: type: boolean title: Success default: true error_msg: type: string title: Error Msg data: items: $ref: '#/components/schemas/TeamSchema' type: array title: Data count: type: integer title: Count type: object title: ResponseModel[List[refuel_cloud_core.schemas.team.TeamSchema]] SampleColumnType: type: string enum: - metadata - label - confidence title: SampleColumnType description: An enumeration. SamplingColumn: properties: column_name: type: string title: Column Name column_type: allOf: - $ref: '#/components/schemas/SampleColumnType' default: metadata subtask_id: type: string title: Subtask Id type: object title: SamplingColumn SamplingEvent: properties: sample_strategy: type: string title: Sample Strategy default: random sample_size: type: integer title: Sample Size default: 100 sampling_column: $ref: '#/components/schemas/SamplingColumn' sample_size_per_group: type: integer title: Sample Size Per Group default: 20 num_buckets: type: integer title: Num Buckets default: 10 type: object title: SamplingEvent SamplingParams: properties: sample_name: type: string title: Sample Name sample_type: $ref: '#/components/schemas/SamplingType' sample_size: type: integer title: Sample Size column: type: string title: Column filters: items: type: string type: array title: Filters default: [] sort_direction: type: string title: Sort Direction default: DESC dataset_id: type: string title: Dataset Id type: object required: - sample_type - sample_size title: SamplingParams SamplingType: type: string enum: - random - stratified - sorted title: SamplingType description: An enumeration. SignedURLResponse: properties: url: type: string title: Url type: object required: - url title: SignedURLResponse State: type: string enum: - CREATED - INVITED - INVITE_FAILED - ACTIVE title: State description: An enumeration. TagType: type: string enum: - seedset - evalset title: TagType description: An enumeration. TaxonomyLabel: properties: id: type: string title: Id name: type: string title: Name description: type: string title: Description embedding: items: type: number type: array title: Embedding level: type: integer title: Level parents: items: type: string type: array title: Parents type: object title: TaxonomyLabel TeamSchema: properties: name: type: string title: Name integrations: type: object title: Integrations default: {} web_app: type: object title: Web App default: {} llm_config: type: object title: Llm Config default: {} api_key: type: string title: Api Key api_key_sha: type: string title: Api Key Sha api_usage: $ref: '#/components/schemas/APIUsage' created_at: type: string format: date-time title: Created At email_domain: type: string title: Email Domain feature_flags: type: object title: Feature Flags default: {} type: object required: - name title: TeamSchema TrainModelRequest: properties: project_id: type: string title: Project Id task_id: type: string title: Task Id base_model: $ref: '#/components/schemas/TrainableBaseModels' max_training_rows: type: integer title: Max Training Rows lora: type: boolean title: Lora default: true augmented_finetuning_model: type: string title: Augmented Finetuning Model hyperparameters: type: object title: Hyperparameters default: num_epochs: 1 learning_rate_multiplier: 20 datasets: items: {} type: array title: Datasets comparison_model: type: string title: Comparison Model default: gpt-4o type: object required: - project_id - task_id - base_model title: TrainModelRequest TrainableBaseModels: type: string enum: - refuel-llm-2-large - refuel-llm-2-small - refuel-llm-2-mini title: TrainableBaseModels description: An enumeration. TrainableResponse: properties: trainable: type: boolean title: Trainable message: type: string title: Message default: '' type: object required: - trainable title: TrainableResponse UpdateAuthenticatedUserRequest: properties: name: type: string title: Name picture: type: string title: Picture team: type: string title: Team type: object title: UpdateAuthenticatedUserRequest UpdateCalibrationRequest: properties: status: $ref: '#/components/schemas/CalibrationStatus' type: object title: UpdateCalibrationRequest UpdateDatasetRequest: properties: name: type: string title: Name scheduled_ids: items: type: string type: array title: Scheduled Ids type: object title: UpdateDatasetRequest UpdateUserRequest: properties: auth0_username: type: string title: Auth0 Username name: type: string title: Name permissions: items: type: string type: array title: Permissions picture: type: string title: Picture update_picture: type: boolean title: Update Picture default: false state: $ref: '#/components/schemas/State' type: object title: UpdateUserRequest UserAction: type: string enum: - STARTED - INTERRUPTED title: UserAction description: An enumeration. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError WebhookEventCategory: type: string enum: - aws - datasaur title: WebhookEventCategory description: An enumeration. WebhookEventRequest: properties: event_type: anyOf: - $ref: '#/components/schemas/DatasaurEventType' - $ref: '#/components/schemas/AWSEventType' title: Event Type event_category: $ref: '#/components/schemas/WebhookEventCategory' payload: anyOf: - $ref: '#/components/schemas/DatasaurProjectCreationPayload' - $ref: '#/components/schemas/AWSS3FileUploadedPayload' title: Payload type: object required: - event_type - event_category - payload title: WebhookEventRequest WebhookResponse: properties: status: type: integer title: Status error: type: string title: Error type: object required: - status title: WebhookResponse securitySchemes: HTTPBearer: type: http scheme: bearer