C3 AI API

{"openapi":"3.1.0","info":{"title":"C3-AI-API","version":"0.1.d982cc5-8"},"paths":{"/c3/ai/prediction":{"get":{"tags":["prediction"],"summary":"Get Predictions","description":"This endpoint returns the list of predictions that AI API supports, which user has access to.\nAdditionally, a content set can be passed to filter down the list","operationId":"get_predictions_c3_ai_prediction_get","parameters":[{"name":"contentset","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contentset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredictionsResponse"}}}},"400":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Authorization Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/c3/ai/prediction/{prediction_name}":{"post":{"tags":["prediction"],"summary":"Make Prediction","description":"This endpoint runs the model inference given the model and inputs for the specific prediction","operationId":"make_prediction_c3_ai_prediction__prediction_name__post","parameters":[{"name":"prediction_name","in":"path","required":true,"schema":{"type":"string","title":"Prediction Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MakePredictionRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MakePredictionResponse"}}}},"400":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Authorization Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/c3/ai/info/{contentset}":{"get":{"tags":["ontology"],"summary":"Get Content Set Info","description":"This endpoint will return information (metadata) from the content set","operationId":"get_content_set_info_c3_ai_info__contentset__get","parameters":[{"name":"contentset","in":"path","required":true,"schema":{"type":"string","title":"Contentset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentSetInfoResponse"}}}},"400":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Authorization Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/c3/ai/ontology/{contentset}":{"get":{"tags":["ontology"],"summary":"Get Content Set Ontologies","description":"This endpoint returns all the available ontologies from a content set","operationId":"get_content_set_ontologies_c3_ai_ontology__contentset__get","parameters":[{"name":"contentset","in":"path","required":true,"schema":{"type":"string","title":"Contentset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentSetOntologiesResponse"}}}},"400":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Authorization Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/c3/ai/ontology/{contentset}/{ontology_name}":{"get":{"tags":["ontology"],"summary":"Get Content Set Ontology","description":"This endpoint returns the vocabulary for a given ontology.\nAdditionally, a search parameter is allowed to filter down the search.\nThe search looks for the ontology vocabulary for any term\nthat contains the text introduced (non-case sensitive) which a minimum length of 3","operationId":"get_content_set_ontology_c3_ai_ontology__contentset___ontology_name__get","parameters":[{"name":"contentset","in":"path","required":true,"schema":{"type":"string","title":"Contentset"}},{"name":"ontology_name","in":"path","required":true,"schema":{"type":"string","title":"Ontology Name"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":3},{"type":"null"}],"title":"Search"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentSetOntologyResponse"}}}},"400":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Authorization Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"ApiErrorEnum":{"type":"integer","enum":[1000,1001,1002,1003,1004,1005,1006,1007,2000,2001,2002,2003,2004,2005,2006,3000],"title":"ApiErrorEnum"},"ContentSetInfoResponse":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"}},"type":"object","required":["name","description"],"title":"ContentSetInfoResponse"},"ContentSetOntologiesResponse":{"properties":{"status":{"$ref":"#/components/schemas/Status","default":"success"},"data":{"items":{"$ref":"#/components/schemas/ContentSetOntologiesResponseData"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"ContentSetOntologiesResponse"},"ContentSetOntologiesResponseData":{"properties":{"name":{"type":"string","title":"Name"},"list":{"type":"boolean","title":"List"}},"type":"object","required":["name","list"],"title":"ContentSetOntologiesResponseData"},"ContentSetOntologyResponse":{"properties":{"status":{"$ref":"#/components/schemas/Status","default":"success"},"data":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"ContentSetOntologyResponse"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ApiErrorEnum"},"message":{"type":"string","title":"Message"},"location":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"}},"type":"object","required":["code","message"],"title":"Error"},"ErrorResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorResponse","description":"Customize Validation Error\nhttps://github.com/tiangolo/fastapi/issues/1376"},"Format":{"type":"string","enum":["json"],"title":"Format"},"MakePredictionRequest":{"properties":{"model":{"type":"string","title":"Model"},"format":{"$ref":"#/components/schemas/Format","default":"json"},"inputs":{"items":{"$ref":"#/components/schemas/PredictionInput"},"type":"array","title":"Inputs"}},"additionalProperties":false,"type":"object","required":["model","inputs"],"title":"MakePredictionRequest"},"MakePredictionResponse":{"properties":{"status":{"$ref":"#/components/schemas/Status","default":"success"},"data":{"items":{"$ref":"#/components/schemas/Prediction"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"MakePredictionResponse"},"OperationEnum":{"type":"string","enum":["eq","in"],"title":"OperationEnum"},"Prediction":{"additionalProperties":true,"type":"object"},"PredictionInput":{"properties":{"field":{"type":"string","title":"Field"},"op":{"$ref":"#/components/schemas/OperationEnum"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"items":{"type":"string"},"type":"array"},{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Value"}},"additionalProperties":false,"type":"object","required":["field","op","value"],"title":"PredictionInput"},"PredictionsResponse":{"properties":{"status":{"$ref":"#/components/schemas/Status","default":"success"},"data":{"items":{"$ref":"#/components/schemas/PredictionsResponseData"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"PredictionsResponse"},"PredictionsResponseData":{"properties":{"content_set":{"type":"string","title":"Content Set"},"name":{"type":"string","title":"Name"},"models":{"items":{"$ref":"#/components/schemas/PredictionsResponseDataModel"},"type":"array","title":"Models"},"inputs":{"items":{"$ref":"#/components/schemas/PredictionsResponseDataInput"},"type":"array","title":"Inputs"}},"type":"object","required":["content_set","name","models","inputs"],"title":"PredictionsResponseData"},"PredictionsResponseDataInput":{"properties":{"name":{"type":"string","title":"Name"},"type":{"type":"string","title":"Type"},"description":{"type":"string","title":"Description"},"mandatory":{"type":"boolean","title":"Mandatory"}},"type":"object","required":["name","type","description","mandatory"],"title":"PredictionsResponseDataInput"},"PredictionsResponseDataModel":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"PredictionsResponseDataModel"},"Status":{"type":"string","enum":["success"],"title":"Status"}},"securitySchemes":{"key":{"type":"apiKey","in":"header","name":"X-ApiKey"}}},"security":[{"key":[]}],"servers":[{"url":"https://api.clarivate.com/c3/ai"}]}