Jump to Content
Guides
API Reference
API Reference
Guides
API Reference
Get all requirements
Search
All
Pages
Start typing to search…
JUMP TO
Assessment API
AI Systems
Create an AI System
post
Get all AI Systems
get
Get an AI System
get
Delete an AI system
delete
Get an AI system report URI
get
Creates a new report for AI system
post
Updates latest report for AI system with the attached file (MD).
put
Creates the template for the AI system report.
post
Update an AI System
put
Create an AI System
post
Get all AI Systems
get
Get an AI System
get
Update an AI System
put
Delete an AI system
delete
Creates the template for the AI system report.
post
Get an AI system report URI
get
Creates a new report for AI system
post
Updates latest report for AI system with the attached file (MD).
put
Assessments
Create an assessment
post
Get all assessments for an AI System
get
Get all assessments by a given AI System ID
get
Get an assessment report URI
get
Run an assessment
post
Creates a new report for assessment
post
Updates latest report for assessment with the attached file (MD).
put
Create an assessment
post
Get all assessments for an AI System
get
Get all assessments by a given AI System ID
get
Run an assessment
post
Get an assessment report URI
get
Creates a new report for assessment
post
Updates latest report for assessment with the attached file (MD).
put
Controls
Get all controls
get
Create a control
post
Get a control
get
Update a control
put
Delete a control
delete
Get all controls
get
Create a control
post
Get a control
get
Update a control
put
Delete a control
delete
Requirements
Create a requirement
post
Get a requirement
get
Update a requirement
put
Delete a requirement
delete
Get all requirements
get
Create a requirement
post
Get a requirement
get
Update a requirement
put
Delete a requirement
delete
Frameworks
Get all frameworks
get
Create a framework
post
Get a framework
get
Update a framework
put
Delete a framework
delete
Get all controls associated to a framework
get
Get all frameworks
get
Create a framework
post
Get a framework
get
Update a framework
put
Delete a framework
delete
Get all controls associated to a framework
get
Model Providers
Get all model providers
get
Get all models from a given model provider
get
Create a model for the model provider
post
Delete a model for the provider model
delete
Get a model.
get
Get all model providers
get
Get all models from a given model provider
get
Create a model for the model provider
post
Get a model.
get
Delete a model for the provider model
delete
Artifacts
Delete an artifact
delete
Delete an artifact
delete
Evaluations
Get all control evaluations for the assessment
get
Get a control evaluation by id
get
Get the report URI for a control evaluation
get
Get all requirement evaluations for the control evaluation.
get
Upload an artifact for a requirement evaluation
post
Run a requirement evaluation
post
Creates a new report for control evaluation
post
Updates latest report for control evaluation with the attached file (MD).
put
Delete a metric evaluation
delete
Get a metric evaluation
get
Get all risk evaluations for the assessment
get
Get a risk evaluation by ID.
get
Get the report URI for a risk evaluation
get
Creates a new report for risk evaluation
post
Updates latest report for risk evaluation with the attached file (MD).
put
Update a control evaluation
put
Update a metric evaluation.
put
Cancel a metric evaluation
post
Download a metric evaluation's evidence by ID.
get
Retrieves the report, associated to a metric evaluation.
get
Creates a new report for metric evaluation.
post
Get the report URI for a requirement evaluation
get
Creates a new report for requirement evaluation
post
Updates latest report for requirement evaluation with the attached file (MD).
put
Set a requirement evaluation status
put
Update a risk evaluation
put
Get all risk evaluations for the assessment
get
Get a risk evaluation by ID.
get
Update a risk evaluation
put
Get the report URI for a risk evaluation
get
Creates a new report for risk evaluation
post
Updates latest report for risk evaluation with the attached file (MD).
put
Get all control evaluations for the assessment
get
Get a control evaluation by id
get
Update a control evaluation
put
Get the report URI for a control evaluation
get
Creates a new report for control evaluation
post
Updates latest report for control evaluation with the attached file (MD).
put
Get all requirement evaluations for the control evaluation.
get
Get the report URI for a requirement evaluation
get
Creates a new report for requirement evaluation
post
Updates latest report for requirement evaluation with the attached file (MD).
put
Run a requirement evaluation
post
Set a requirement evaluation status
put
Upload an artifact for a requirement evaluation
post
Creates a new metric evaluation and links it to the requirement evaluation.
post
Unlink a metric evaluation from a requirement evaluation.
delete
Create a metric evaluation
post
Get a metric evaluation
get
Delete a metric evaluation
delete
Update a metric evaluation.
put
Retrieves the report, associated to a metric evaluation.
get
Creates a new report for metric evaluation.
post
Download a metric evaluation's evidence by ID.
get
Get metric evaluation's evidence by ID.
get
Cancel a metric evaluation
post
Schedule a metric evaluation run
post
Dataset Providers
Get all the dataset providers
get
Get all datasets from a given dataset provider
get
Get all the dataset providers
get
Get all datasets from a given dataset provider
get
Datasets
Create a local CSV dataset
post
Get a dataset
get
Delete a dataset
delete
Create a local CSV dataset
post
Get a dataset
get
Delete a dataset
delete
Metric Evaluators
Create a metric evaluation
post
Get all metric evaluators
get
Create a metric evaluator
post
Delete metric evaluator
delete
Update a metric evaluator
put
Get all metric evaluators
get
Create a metric evaluator
post
Get a metric evaluator
get
Update a metric evaluator
put
Delete metric evaluator
delete
Users
Get all users
get
Create a user
post
Get a user
get
Get all users
get
Create a user
post
Get a user
get
Update a user.
put
Risks
Get all risks
get
Create a risk.
post
Delete a risk
delete
Get a risk
get
Update a risk
put
Get all risks
get
Create a risk.
post
Get a risk
get
Update a risk
put
Delete a risk
delete
Embeddings Model Providers
Get all embeddings model providers
get
Get all embedding models from a given embeddings model provider
get
Create an embeddings model for the embeddings model provider.
post
Get an embeddings model.
get
Update an embeddings model. Only "rate_limit" can be updated.
put
Delete an embeddings model endpoint for the provider.
delete
Run a test inference for an embeddings model
get
Dataset
Get all registered datasets
get
Get all registered datasets
get
Model Adapters
Get all model adapters
get
Create a model adapter
post
Delete the model adapter
delete
Get the model adapter
get
Update the model adapter
put
Get all model adapters
get
Create a model adapter
post
Get the model adapter
get
Update the model adapter
put
Delete the model adapter
delete
Models
Get all models
get
Create a model
post
Delete a model
delete
Get a model
get
Run a test inference for a model
get
Run a test inference for a model
get
Get all models
get
Create a model
post
Get a model
get
Delete a model
delete
Status
Ping
get
Ping
get
ResetCredentials
Reset a user credential.
post
SetCredentials
Set a user credential.
post
Technical Risk Assessment
Get all technical risk assessments.
get
Create a technical risk assessment
post
Get a technical risk assessment by ID.
get
Update a technical risk assessment
put
Delete a technical risk assessment
delete
Schedule the execution of a technical risk assessment by ID.
post
Cancel the running technical risk assessment and put it in "In configuration" mode again.
post
Get the report URI for a technical risk assessment
get
Creates a new report for technical risk assessment
post
Updates report for technical risk assessment with attached file (MD).
put
Powered by
Get all requirements
get
http://127.0.0.1:5005/api/requirements
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
