The Arthur Platform REST API (Arthur Scope) for managing models, tasks, datasets, connectors, metrics, alerts, alert rules, policies, workspaces, projects, agents, and webhooks. OpenAPI 3.1, OAuth2 (Keycloak), URI-path versioned at /api/v1.
{"openapi":"3.1.0","info":{"title":"Arthur Scope","version":"0.1.0"},"paths":{"/api/health":{"get":{"summary":"Health Check","description":"Confirms the API is healthy and responsive.","operationId":"Health_check_api_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthStatus"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/api/v1/jobs/{job_id}":{"get":{"tags":["Jobs V1"],"summary":"Get Job By Id","description":"Returns a single job by ID. Requires project_job_read permission.","operationId":"get_job","security":[{"OAuth2AuthorizationCode":["project_job_read"]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Jobs V1"],"summary":"Update Job By Id","description":"Updates a single job by ID. Requires project_job_update permission.","operationId":"update_job","security":[{"OAuth2AuthorizationCode":["project_job_update"]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchJob"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/jobs/{job_id}/state":{"put":{"tags":["Jobs V1"],"summary":"Update Job State","description":"Update job state. Requires project_job_put_state permission.","operationId":"put_job_state","security":[{"OAuth2AuthorizationCode":["project_job_put_state"]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"job_run_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Job run ID associated with the state update.","title":"Job Run Id"},"description":"Job run ID associated with the state update."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutJobState"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/jobs/{job_id}/runs":{"get":{"tags":["Jobs V1"],"summary":"Get Job Runs","description":"Get Job runs. Required project_job_read_runs permission.","operationId":"get_job_runs","security":[{"OAuth2AuthorizationCode":["project_job_read_runs"]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceList_JobRun_"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/jobs/{job_id}/runs/{job_run_id}/logs":{"post":{"tags":["Jobs V1"],"summary":"Append To Job Logs","description":"Append job logs. Requires project_job_append_logs permission.","operationId":"post_job_logs","security":[{"OAuth2AuthorizationCode":["project_job_append_logs"]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"job_run_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The job run associated with the logs. Should be formatted as a UUID.","title":"Job Run Id"},"description":"The job run associated with the logs. Should be formatted as a UUID."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobLogs"}}}},"responses":{"204":{"description":"Successful Response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Jobs V1"],"summary":"Get Job Logs","description":"Get job logs for a run. Requires project_job_read_logs permission.","operationId":"get_job_logs","security":[{"OAuth2AuthorizationCode":["project_job_read_logs"]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"job_run_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The job run associated with the logs. Should be formatted as a UUID.","title":"Job Run Id"},"description":"The job run associated with the logs. Should be formatted as a UUID."},{"name":"order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Override the sort order used. Optional.","default":"asc"},"description":"Override the sort order used. Optional."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceList_JobLog_"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/jobs/{job_id}/runs/{job_run_id}/errors":{"post":{"tags":["Jobs V1"],"summary":"Append To Job Errors","description":"Append job errors. Requires project_job_append_errors permission.","operationId":"post_job_errors","security":[{"OAuth2AuthorizationCode":["project_job_append_errors"]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"job_run_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The job run associated with the errors. Should be formatted as a UUID.","title":"Job Run Id"},"description":"The job run associated with the errors. Should be formatted as a UUID."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobErrors"}}}},"responses":{"204":{"description":"Successful Response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Jobs V1"],"summary":"Get Job Errors","description":"Get job errors. Requires project_job_read_errors permission.","operationId":"get_job_errors","security":[{"OAuth2AuthorizationCode":["project_job_read_errors"]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"job_run_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The job run associated with the errors. Should be formatted as a UUID.","title":"Job Run Id"},"description":"The job run associated with the errors. Should be formatted as a UUID."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceList_JobError_"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/connectors/{connector_id}":{"get":{"tags":["Connectors V1"],"summary":"Get Connector","description":"Returns a single connector by ID. Requires connector_read permission.","operationId":"get_connector","security":[{"OAuth2AuthorizationCode":["connector_read"]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorSpec"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Connectors V1"],"summary":"Update Connector","description":"Updates a single connector. Requires connector_update permission.","operationId":"patch_connector","security":[{"OAuth2AuthorizationCode":["connector_update"]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchConnectorSpec"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorSpec"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Connectors V1"],"summary":"Delete Connector","description":"Deletes a single connector by id. Requires connector_delete permission.","operationId":"delete_connector","security":[{"OAuth2AuthorizationCode":["connector_delete"]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"responses":{"204":{"description":"No Content"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/connectors/{connector_id}/sensitive":{"get":{"tags":["Connectors V1"],"summary":"Get Sensitive Connector","description":"Returns a single connector by ID with unmasked sensitive fields. Requires connector_get_sensitive_fields permission.","operationId":"get_sensitive_connector","security":[{"OAuth2AuthorizationCode":["connector_get_sensitive_fields"]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorSpec"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/connectors/{connector_id}/check_results":{"put":{"tags":["Connectors V1"],"summary":"Persist Connector Check Results","description":"Sets the check result of the connector. Requires connector_put_check_result permission.","operationId":"put_connector_check_results","security":[{"OAuth2AuthorizationCode":["connector_put_check_result"]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorCheckResult"}}}},"responses":{"204":{"description":"Successful Response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/connectors/{connector_id}/datasets":{"get":{"tags":["Datasets V1"],"summary":"Get Datasets By Connector Id","description":"Returns a list of configured datasets for the connector. Requires connector_list_datasets permission.","operationId":"get_connector_datasets","security":[{"OAuth2AuthorizationCode":["connector_list_datasets"]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceList_Dataset_"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Datasets V1"],"summary":"Create Connector Dataset","description":"Create connector dataset. Requires connector_create_dataset permission.","operationId":"post_connector_dataset","security":[{"OAuth2AuthorizationCode":["connector_create_dataset"]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostDataset"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/connectors/{connector_id}/available_datasets":{"get":{"tags":["Datasets V1"],"summary":"Get Available Datasets By Connector Id","description":"Returns a list of available datasets for the connector. Requires connector_list_available_datasets permission.","operationId":"get_connector_available_datasets","security":[{"OAuth2AuthorizationCode":["connector_list_available_datasets"]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AvailableDatasetsSort","description":"The field to sort by.","default":"created_at"},"description":"The field to sort by."},{"name":"order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"The order to sort by.","default":"desc"},"description":"The order to sort by."},{"name":"search","in":"query","required":false,"schema":{"type":"string","description":"Search term to filter by.","title":"Search"},"description":"Search term to filter by."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page to return starting from 1 up to total_pages.","default":1,"title":"Page"},"description":"The page to return starting from 1 up to total_pages."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The number of records per page. The max is 1000.","default":20,"title":"Page Size"},"description":"The number of records per page. The max is 1000."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceList_AvailableDataset_"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Datasets V1"],"summary":"Overwrite Connector Available Datasets","description":"Overwrite all available datasets for this connector. Requires connector_put_available_datasets permission.","operationId":"put_connector_available_datasets","security":[{"OAuth2AuthorizationCode":["connector_put_available_datasets"]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutAvailableDatasets"}}}},"responses":{"204":{"description":"Successful Response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Datasets V1"],"summary":"Create Single Available Dataset","description":"Create a single available dataset for this connector. Requires connector_create_available_datasetpermission.","operationId":"post_available_dataset","security":[{"OAuth2AuthorizationCode":["connector_create_available_dataset"]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutAvailableDataset"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableDataset"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/connector_schemas/connector_types":{"get":{"tags":["Connector Schemas V1"],"summary":"Get Available Connector Types","description":"Returns all Arthur-supported connector types.","operationId":"get_connector_types","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceList_ConnectorType_"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}},"security":[{"OAuth2AuthorizationCode":[]}]}},"/api/v1/connector_schemas/{connector_type}":{"get":{"tags":["Connector Schemas V1"],"summary":"Get Connector Schema By Type","description":"Returns a connector schema by type.","operationId":"get_connector_schema_by_type","security":[{"OAuth2AuthorizationCode":[]}],"parameters":[{"name":"connector_type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ConnectorType","description":"The type of the connector schema to fetch."},"description":"The type of the connector schema to fetch."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorSpecSchema"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/datasets/{dataset_id}":{"get":{"tags":["Datasets V1"],"summary":"Get Dataset By Id","description":"Returns a single dataset by ID. Requires dataset_read permission.","operationId":"get_dataset","security":[{"OAuth2AuthorizationCode":["dataset_read"]}],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Datasets V1"],"summary":"Update Dataset","description":"Update a dataset. Requires dataset_update permission.","operationId":"patch_dataset","security":[{"OAuth2AuthorizationCode":["dataset_update"]}],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchDataset"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Datasets V1"],"summary":"Delete Dataset","description":"Delete a dataset. Requires dataset_delete permission.","operationId":"delete_dataset","security":[{"OAuth2AuthorizationCode":["dataset_delete"]}],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"}}],"responses":{"204":{"description":"No Content"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/datasets/{dataset_id}/schema":{"put":{"tags":["Datasets V1"],"summary":"Update Dataset Schema","description":"Update a dataset schema. Requires dataset_put_schema permission.","operationId":"put_dataset_schema","security":[{"OAuth2AuthorizationCode":["dataset_put_schema"]}],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutDatasetSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/models/{model_id}/metrics/versions":{"get":{"tags":["Metrics V1"],"summary":"Get Metric Versions","description":"Get metric versions for a model. Requires model_list_metric_versions permission.","operationId":"get_model_metrics_versions","security":[{"OAuth2AuthorizationCode":["model_list_metric_versions"]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Model Id"}},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/MetricsVersionsSort","description":"Override the field used for sorting the returned list. Optional.","default":"range_end"},"description":"Override the field used for sorting the returned list. Optional."},{"name":"order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Override the sort order used. Optional.","default":"desc"},"description":"Override the sort order used. Optional."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page to return starting from 1 up to total_pages.","default":1,"title":"Page"},"description":"The page to return starting from 1 up to total_pages."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The number of records per page. The max is 1000.","default":20,"title":"Page Size"},"description":"The number of records per page. The max is 1000."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceList_MetricsVersion_"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Metrics V1"],"summary":"Create A Metric Version","description":"Creates a new version for metrics to be uploaded for this model. Requires model_create_metric_version permission.","operationId":"post_model_metrics_version","security":[{"OAuth2AuthorizationCode":["model_create_metric_version"]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Model Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostMetricsVersions"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsVersion"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/models/{model_id}/metrics/versions/{metric_version_num}":{"post":{"tags":["Metrics V1"],"summary":"Upload Metrics For Version","description":"Adds metrics for a model by version. This will create the version if it does not exist. Requires model_add_metrics_for_version permission.","operationId":"post_model_metrics_by_version","security":[{"OAuth2AuthorizationCode":["model_add_metrics_for_version"]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Model Id"}},{"name":"metric_version_num","in":"path","required":true,"schema":{"type":"integer","description":"The version number for the metrics being uploaded. Should be an integer.","title":"Metric Version Num"},"description":"The version number for the metrics being uploaded. Should be an integer."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsUpload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsUploadResult"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/models/{model_id}/task":{"patch":{"tags":["Tasks V1"],"summary":"Update A Task","description":"Submits a job to update the task definition for this model and returns the job ID. When the job finishes, it will upload the latest copy of the task state. Requires model_task_update permission.","operationId":"patch_task","security":[{"OAuth2AuthorizationCode":["model_task_update"]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Model Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchTaskRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskMutationResponse"}}}},"500":{"conten
# --- truncated at 32 KB (553 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/arthur-ai/refs/heads/main/openapi/arthur-ai-platform-openapi.json