Credo AI

Credo AI Governance Platform API (v2)

Multi-tenant JSON:API REST interface to the Credo AI Governance Platform. 300 operations across 26 tags cover use cases, use case questionnaires, risk scenarios, controls, policy packs, reports, reviews, comments and custom fields, plus models and model versions, vendors, questionnaires, policy controls, risk classifications, tasks, fields, users, teams, triggers and trigger actions, and Shadow AI tools and events. Media type is application/vnd.api+json throughout, with cursor pagination (page[after]/page[before]/page[limit]), filter[...]/sort/include query conventions, and a JSON:API errors[] envelope. Authenticated with a Bearer token exchanged from a tenant API token.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.sdk.credo.ai/docs/intro/
📖
APIReference
https://docs.sdk.credo.ai/docs/api-reference
📖
GettingStarted
https://docs.sdk.credo.ai/docs/getting-started
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/authentication/credo-ai-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/openapi/credo-ai-governance-platform-swagger.json

Other Resources

🔗
Swagger
https://api.credo.ai/swagger.json
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/overlays/credo-ai-governance-platform-overlay.yaml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/conventions/credo-ai-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/errors/credo-ai-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/data-model/credo-ai-data-model.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/apis.yml

OpenAPI Specification

credo-ai-governance-platform-swagger.json Raw ↑ 
{
  "info": {
    "description": "Credo AI server API",
    "title": "Credo AI server API"
  },
  "definitions": {
    "UseCaseQuestionnaireCreateRequest": {
      "description": "",
      "properties": {
        "data": {
          "description": "",
          "properties": {
            "attributes": {
              "properties": {
                "key": {
                  "description": "questionnaire key",
                  "example": "QUES",
                  "type": "string"
                },
                "version": {
                  "description": "quetionnaire version",
                  "type": "integer"
                }
              },
              "required": [
                "key",
                "version"
              ],
              "type": "object"
            },
            "type": {
              "description": "The JSON-API resource type",
              "example": "resource-type",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "UseCaseRiskScenarioCreateRequest": {
      "description": "",
      "properties": {
        "data": {
          "description": "",
          "properties": {
            "attributes": {
              "properties": {
                "description": {
                  "description": "risk scenario description",
                  "type": "string"
                },
                "inherent_risk_impact": {
                  "description": "inherent risk impact(1-5)",
                  "example": 1,
                  "type": "integer"
                },
                "inherent_risk_likelihood": {
                  "description": "inherent risk likelihood(1-5)",
                  "example": 1,
                  "type": "integer"
                },
                "name": {
                  "description": "risk scenario name",
                  "type": "string"
                },
                "risk_scenario_id": {
                  "description": "risk scenario id",
                  "example": "8zA2nPjVSenyvcc429LPDT",
                  "type": "string"
                },
                "risk_type_ids": {
                  "description": "risk type ids",
                  "example": [
                    "NkBkDB9i64w53eVR6ssfzj"
                  ],
                  "type": "array"
                },
                "type": {
                  "description": "risk type",
                  "example": "abuse_misuse",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "type": {
              "description": "The JSON-API resource type",
              "example": "resource-type",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "UseCaseScheduledReviewCreateRequest": {
      "description": "",
      "properties": {
        "data": {
          "description": "",
          "properties": {
            "attributes": {
              "properties": {
                "due_date": {
                  "description": "due date",
                  "example": "2024-01-30T17:00:00.000Z",
                  "type": "string"
                },
                "scheduled_at": {
                  "description": "scheduled date time",
                  "example": "2024-01-30T17:00:00.000Z",
                  "type": "string"
                },
                "team_ids": {
                  "description": "list of team ids",
                  "example": [
                    "team_123",
                    "team_456"
                  ],
                  "type": "array"
                },
                "timezone": {
                  "description": "timezone",
                  "example": "America/New_York",
                  "type": "string"
                },
                "user_ids": {
                  "description": "list of user ids",
                  "example": [
                    "user_123",
                    "user_456"
                  ],
                  "type": "array"
                },
                "workflow_stage_step": {
                  "description": "workflow stage step",
                  "example": "step_123",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "type": {
              "description": "The JSON-API resource type",
              "example": "resource-type",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "VendorQuestionnaireCreateRequest": {
      "description": "",
      "properties": {
        "data": {
          "description": "",
          "properties": {
            "attributes": {
              "properties": {
                "key": {
                  "description": "questionnaire key",
                  "type": "string"
                },
                "version": {
                  "description": "questionnaire version",
                  "type": "integer"
                }
              },
              "required": [
                "key",
                "version"
              ],
              "type": "object"
            },
            "id": {
              "description": "The JSON-API resource ID",
              "example": "64YUaLWSviHgibJaRWr3ZE",
              "type": "string"
            },
            "type": {
              "description": "The JSON-API resource type",
              "example": "resource-type",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "VendorResource": {
      "description": "",
      "properties": {
        "attributes": {
          "properties": {
            "configurable_risk_score_classification": {
              "description": "",
              "type": "string"
            },
            "custom": {
              "description": "",
              "type": "string"
            },
            "description": {
              "description": "",
              "type": "string"
            },
            "entity_id": {
              "description": "",
              "type": "string"
            },
            "inserted_at": {
              "description": "",
              "type": "string"
            },
            "name": {
              "description": "",
              "type": "string"
            },
            "questionnaire_ids": {
              "description": "",
              "type": "string"
            },
            "risk_classification_id": {
              "description": "",
              "type": "string"
            },
            "risk_classification_level": {
              "description": "",
              "type": "string"
            },
            "risk_classification_set_at": {
              "description": "",
              "type": "string"
            },
            "risk_classification_set_by": {
              "description": "",
              "type": "string"
            },
            "risk_classification_set_by_user_id": {
              "description": "",
              "type": "string"
            },
            "status": {
              "description": "",
              "type": "string"
            },
            "updated_at": {
              "description": "",
              "type": "string"
            },
            "user_id": {
              "description": "",
              "type": "string"
            },
            "workflow_stage_id": {
              "description": "",
              "type": "string"
            },
            "workflow_stage_step": {
              "description": "",
              "type": "string"
            },
            "workflow_stage_step_status": {
              "description": "",
              "type": "string"
            }
          },
          "type": "object"
        },
        "id": {
          "description": "The JSON-API resource ID",
          "example": "64YUaLWSviHgibJaRWr3ZE",
          "type": "string"
        },
        "relationships": {
          "properties": {
            "models": {
              "properties": {
                "data": {
                  "properties": {
                    "id": {
                      "description": "Related models resource id",
                      "type": "string"
                    },
                    "type": {
                      "description": "Type of related models resource",
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              },
              "type": "object"
            },
            "questionnaires": {
              "properties": {
                "data": {
                  "properties": {
                    "id": {
                      "description": "Related questionnaires resource id",
                      "type": "string"
                    },
                    "type": {
                      "description": "Type of related questionnaires resource",
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              },
              "type": "object"
            },
            "use_case_links": {
              "properties": {
                "data": {
                  "properties": {
                    "id": {
                      "description": "Related use_case_links resource id",
                      "type": "string"
                    },
                    "type": {
                      "description": "Type of related use_case_links resource",
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              },
              "type": "object"
            },
            "use_cases": {
              "properties": {
                "data": {
                  "properties": {
                    "id": {
                      "description": "Related use_cases resource id",
                      "type": "string"
                    },
                    "type": {
                      "description": "Type of related use_cases resource",
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              },
              "type": "object"
            },
            "user": {
              "properties": {
                "data": {
                  "properties": {
                    "id": {
                      "description": "Related user resource id",
                      "type": "string"
                    },
                    "type": {
                      "description": "Type of related user resource",
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              },
              "type": "object"
            }
          },
          "type": "object"
        },
        "type": {
          "description": "The JSON-API resource type",
          "example": "vendors",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ModelLinkUpdateRequest": {
      "description": "",
      "properties": {
        "data": {
          "description": "",
          "properties": {
            "attributes": {
              "properties": {
                "model_version": {
                  "description": "",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "id": {
              "description": "The JSON-API resource ID",
              "example": "64YUaLWSviHgibJaRWr3ZE",
              "type": "string"
            },
            "type": {
              "description": "The JSON-API resource type",
              "example": "resource-type",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "IntegrationUpdateRequest": {
      "description": "",
      "properties": {
        "data": {
          "description": "",
          "properties": {
            "attributes": {
              "properties": {
                "data": {
                  "description": "integration data",
                  "type": "object"
                },
                "type": {
                  "description": "integration type",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "id": {
              "description": "The JSON-API resource ID",
              "example": "64YUaLWSviHgibJaRWr3ZE",
              "type": "string"
            },
            "type": {
              "description": "The JSON-API resource type",
              "example": "resource-type",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "CommentThreadResponse": {
      "description": "A JSON-API document with a single [CommentThreadResource](#commentthreadresource) resource",
      "properties": {
        "data": {
          "$ref": "#/definitions/CommentThreadResource"
        },
        "included": {
          "description": "Included resources",
          "items": {
            "properties": {
              "id": {
                "description": "The JSON-API resource ID",
                "type": "string"
              },
              "type": {
                "description": "The JSON-API resource type",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": [
        "data"
      ],
      "type": "object"
    },
    "EntityControlFileResource": {
      "description": "",
      "properties": {
        "attributes": {
          "properties": {
            "content_type": {
              "description": "",
              "type": "string"
            },
            "control_id": {
              "description": "",
              "type": "string"
            },
            "filename": {
              "description": "",
              "type": "string"
            },
            "id": {
              "description": "",
              "type": "string"
            },
            "inserted_at": {
              "description": "",
              "type": "string"
            },
            "requirement_key": {
              "description": "",
              "type": "string"
            },
            "size": {
              "description": "",
              "type": "string"
            },
            "updated_at": {
              "description": "",
              "type": "string"
            },
            "url": {
              "description": "",
              "type": "string"
            }
          },
          "type": "object"
        },
        "id": {
          "description": "The JSON-API resource ID",
          "example": "64YUaLWSviHgibJaRWr3ZE",
          "type": "string"
        },
        "relationships": {
          "properties": {},
          "type": "object"
        },
        "type": {
          "description": "The JSON-API resource type",
          "example": "entity_control_files",
          "type": "string"
        }
      },
      "type": "object"
    },
    "VendorQuestionnaireResponse": {
      "description": "A JSON-API document with a single [VendorQuestionnaireResource](#vendorquestionnaireresource) resource",
      "properties": {
        "data": {
          "$ref": "#/definitions/VendorQuestionnaireResource"
        },
        "included": {
          "description": "Included resources",
          "items": {
            "properties": {
              "id": {
                "description": "The JSON-API resource ID",
                "type": "string"
              },
              "type": {
                "description": "The JSON-API resource type",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": [
        "data"
      ],
      "type": "object"
    },
    "PolicyControlVersionResponse": {
      "description": "A JSON-API document with a single [PolicyControlVersionResource](#policycontrolversionresource) resource",
      "properties": {
        "data": {
          "$ref": "#/definitions/PolicyControlVersionResource"
        },
        "included": {
          "description": "Included resources",
          "items": {
            "properties": {
              "id": {
                "description": "The JSON-API resource ID",
                "type": "string"
              },
              "type": {
                "description": "The JSON-API resource type",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": [
        "data"
      ],
      "type": "object"
    },
    "CustomPolicyPackBaseCreateRequest": {
      "description": "",
      "properties": {
        "data": {
          "description": "",
          "properties": {
            "attributes": {
              "properties": {
                "entity_type_ids": {
                  "description": "entity type ids this pack targets; omit or [] for all",
                  "example": [],
                  "type": "array"
                },
                "id": {
                  "description": "id",
                  "type": "string"
                },
                "info": {
                  "description": "policy pack info shared across versions",
                  "example": {
                    "name": "Policy pack name"
                  },
                  "type": "object"
                }
              },
              "required": [
                "id"
              ],
              "type": "object"
            },
            "type": {
              "description": "The JSON-API resource type",
              "example": "resource-type",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "TeamsResponse": {
      "description": "A page of [TeamResource](#teamresource) results",
      "properties": {
        "data": {
          "description": "Content with [TeamResource](#teamresource) objects",
          "items": {
            "$ref": "#/definitions/TeamResource"
          },
          "type": "array"
        },
        "meta": {
          "properties": {
            "after": {
              "description": "after cursor for the next page resources",
              "type": "string"
            },
            "before": {
              "description": "before cursor for the previous page resources",
              "type": "string"
            },
            "limit": {
              "description": "number of resources limit applied to this request",
              "type": "integer"
            }
          },
          "type": "object"
        }
      },
      "required": [
        "data"
      ],
      "type": "object"
    },
    "RelationshipResource": {
      "description": "Represents a relationship between resources",
      "properties": {
        "id": {
          "description": "Unique identifier for the resource",
          "type": "string"
        },
        "type": {
          "description": "Type of the resource",
          "type": "string"
        }
      },
      "required": [
        "id"
      ],
      "type": "object"
    },
    "UnprocessableEntityError": {
      "properties": {
        "errors": {
          "description": "Errors",
          "items": {
            "properties": {
              "code": {
                "description": "an application-specific error code, expressed as a string value.",
                "type": "integer"
              },
              "detail": {
                "description": "a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.",
                "type": "string"
              },
              "title": {
                "description": "a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "AuditLogResource": {
      "description": "",
      "properties": {
        "attributes": {
          "properties": {
            "action": {
              "description": "",
              "type": "string"
            },
            "action_id": {
              "description": "",
              "type": "string"
            },
            "inserted_at": {
              "description": "",
              "type": "string"
            },
            "message": {
              "description": "",
              "type": "string"
            },
            "metadata": {
              "description": "",
              "type": "string"
            },
            "name": {
              "description": "",
              "type": "string"
            },
            "resource_id": {
              "description": "",
              "type": "string"
            },
            "resource_name": {
              "description": "",
              "type": "string"
            },
            "resource_type": {
              "description": "",
              "type": "string"
            },
            "source": {
              "description": "",
              "type": "string"
            },
            "sub_object_id": {
              "description": "",
              "type": "string"
            },
            "sub_object_name": {
              "description": "",
              "type": "string"
            },
            "sub_object_type": {
              "description": "",
              "type": "string"
            },
            "use_case_id": {
              "description": "",
              "type": "string"
            },
            "user": {
              "description": "",
              "type": "string"
            },
            "user_id": {
              "description": "",
              "type": "string"
            }
          },
          "type": "object"
        },
        "id": {
          "description": "The JSON-API resource ID",
          "example": "64YUaLWSviHgibJaRWr3ZE",
          "type": "string"
        },
        "relationships": {
          "properties": {},
          "type": "object"
        },
        "type": {
          "description": "The JSON-API resource type",
          "example": "audit_logs",
          "type": "string"
        }
      },
      "type": "object"
    },
    "UseCaseQuestionnaireSectionsResponse": {
      "description": "A collection of [UseCaseQuestionnaireSectionResource](#usecasequestionnairesectionresource)",
      "properties": {
        "data": {
          "description": "Content with [UseCaseQuestionnaireSectionResource](#usecasequestionnairesectionresource) objects",
          "items": {
            "$ref": "#/definitions/UseCaseQuestionnaireSectionResource"
          },
          "type": "array"
        }
      },
      "required": [
        "data"
      ],
      "type": "object"
    },
    "ApiTokenCreateRequest": {
      "description": "",
      "properties": {
        "data": {
          "description": "",
          "properties": {
            "attributes": {
              "properties": {
                "name": {
                  "description": "",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "id": {
              "description": "The JSON-API resource ID",
              "example": "64YUaLWSviHgibJaRWr3ZE",
              "type": "string"
            },
            "type": {
              "description": "The JSON-API resource type",
              "example": "resource-type",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "RiskTypeResponse": {
      "description": "A JSON-API document with a single [RiskTypeResource](#risktyperesource) resource",
      "properties": {
        "data": {
          "$ref": "#/definitions/RiskTypeResource"
        },
        "included": {
          "description": "Included resources",
          "items": {
            "properties": {
              "id": {
                "description": "The JSON-API resource ID",
                "type": "string"
              },
              "type": {
                "description": "The JSON-API resource type",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": [
        "data"
      ],
      "type": "object"
    },
    "EntityControlUpdateRequest": {
      "description": "",
      "properties": {
        "data": {
          "description": "",
          "properties": {
            "attributes": {
              "properties": {
                "due_date": {
                  "description": "due date",
                  "example": "2024-01-30T17:00:00.000Z",
                  "type": "string"
                },
                "timezone": {
                  "description": "due date timezone",
                  "example": "America/New_York",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "id": {
              "description": "The JSON-API resource ID",
              "example": "64YUaLWSviHgibJaRWr3ZE",
              "type": "string"
            },
            "type": {
              "description": "The JSON-API resource type",
              "example": "resource-type",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "PolicyControlBasesResponse": {
      "description": "A collection of [PolicyControlBaseResource](#policycontrolbaseresource)",
      "properties": {
        "data": {
          "description": "Content with [PolicyControlBaseResource](#policycontrolbaseresource) objects",
          "items": {
            "$ref": "#/definitions/PolicyControlBaseResource"
          },
          "type": "array"
        }
      },
      "required": [
        "data"
      ],
      "type": "object"
    },
    "PolicyControlBaseCreateRequest": {
      "description": "",
      "properties": {
        "data": {
          "description": "",
          "properties": {
            "attributes": {
              "properties": {
                "entity_type_ids": {
                  "description": "entity type ids this control targets; omit or [] for all",
                  "example": [],
                  "type": "array"
                },
                "id": {
                  "description": "id",
                  "type": "string"
                }
              },
              "required": [
                "id"
              ],
              "type": "object"
            },
            "type": {
              "description": "The JSON-API resource type",
              "example": "resource-type",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "DomainsResponse": {
      "description": "A collection of [DomainResource](#domainresource)",
      "properties": {
        "data": {
          "description": "Content with [DomainResource](#domainresource) objects",
          "items": {
            "$ref": "#/definitions/DomainResource"
          },
          "type": "array"
        }
      },
      "required": [
        "data"
      ],
      "type": "object"
    },
    "UseCaseVendorLinksResponse": {
      "description": "A page of [UseCaseVendorLinkResource](#usecasevendorlinkresource) results",
      "properties": {
        "data": {
          "description": "Content with [UseCaseVendorLinkResource](#usecasevendorlinkresource) objects",
          "items": {
            "$ref": "#/definitions/UseCaseVendorLinkResource"
          },
          "type": "array"
        },
        "meta": {
          "properties": {
            "after": {
              "description": "after cursor for the next page resources",
              "type": "string"
            },
            "before": {
              "description": "before cursor for the previous page resources",
              "type": "string"
            },
            "limit": {
              "description": "number of resources limit applied to this request",
              "type": "integer"
            }
          },
          "type": "object"
        }
      },
      "required": [
        "data"
      ],
      "type": "object"
    },
    "ModifyPolicyPackResource": {
      "description": "A PolicyPackRel",
      "properties": {
        "id": {
          "description": "policy pack id",
          "type": "string"
        }
      },
      "required": [
        "id"
      ],
      "title": "PolicyPackRel",
      "type": "object"
    },
    "EntityControlEvidenceCreateRequest": {
      "description": "",
      "properties": {
        "data": {
          "description": "",
          "properties": {
            "attributes": {
              "properties": {
                "data": {
                  "description": "value data",
                  "example": {
                    "value": "This is text evidence"
                  },
                  "type": "object"
                },
                "generated_at": {
                  "description": "2022-05-03T11:33:25.582138Z",
                  "type": "string"
                },
                "requirement_key": {
                  "description": "evidence requirement key",
                  "type": "string"
                }
              },
              "required": [
                "data"
              ],
              "type": "object"
            },
            "type": {
              "description": "The JSON-API resource type",
              "example": "resource-type",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "UseCaseControlCookbookResource": {
      "description": "",
      "properties": {
        "attributes": {
          "properties": {
            "data": {
              "description": "",
              "type": "string"
            }
          },
          "type": "object"
        },
        "id": {
          "description": "The JSON-API resource ID",
          "example": "64YUaLWSviHgibJaRWr3ZE",
          "type": "string"
        },
        "relationships": {
          "properties": {},
          "type": "object"
        },
        "type": {
          "description": "The JSON-API resource type",
          "example": "use_case_control_cookbooks",
          "type": "string"
        }
      },
      "type": "object"
    },
    "UseCaseCreateRequest": {
      "description": "",
      "properties": {
        "data": {
          "description": "",
          "properties": {
            "attributes": {
              "properties": {
                "ai_type": {
                  "description": "",
                  "type": "string"
                },
                "description": {
                  "description": "",
                  "type": "string"
                },
                "icon": {
                  "description": "",
                  "type": "string"
                },
                "industries": {
                  "description": "Industries",
                  "example": [
                    "Fishing, Hunting, & Trapping"
                  ],
                  "type": "array"
                },
                "is_vendor": {
                  "description": "",
                  "type": "boolean"
                },
                "monetary_value": {
                  "description": "",
                  "type": "integer"
                },
                "name": {
                  "description": "",
                  "type": "string"
                },
                "owner": {
                  "description": "Owner Details",
                  "example": {
                    "owner_id": "user_id",
                    "owner_type": "user"
                  },
                  "type": "object"
     

# --- truncated at 32 KB (861 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/credo-ai/refs/heads/main/openapi/credo-ai-governance-platform-swagger.json