This guide provides a step-by-step process for creating and updating questionnaires through the Credo AI API. It assumes the use of environment variables for configuration and relies on Python and the requests library to interact with the API. For more details on the endpoint, see our swagger documentation.
Note:
- Self-hosted customers must replace
https://api.credo.aiwith your Credo AI URL ${TENANT}is the tenant name used to log in to Credo AI- See Authentication for how to get the required
${ACCESS_TOKEN}
Step 1: When generating a questionnaire for a tenant you have to first create a questionnaire ID.
- Body params
name→ Use case name must be uniqueid→ Unique Identifier for the questionnaire
import requests
url = "https://api.credo.ai/api/v2/${TENANT}/questionnaire_bases"
headers = {
"Content-type": "application/vnd.api+json",
"Accept": "application/vnd.api+json",
"Authorization": "Bearer ${ACCESS_TOKEN}"
}
payload = {
"data": {
"attributes": {
"id": "string",
"info": {},
"metadata": {},
"name": "string"
},
"type": "resource-type"
}
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
Step 2: After creating the Questionnaire ID, describe the questions and sections for the questionnaire and create a version associated with the ID.
- URL params
questionnaire_id→ From step 1
- Body params
"draft": truethis has to be set to“draft": falseif you wish to publish this version into the tenant.
import requests
url = "https://api.credo.ai/api/v2/${TENANT}/questionnaire_bases/${questionnaire_id}/versions"
headers = {
"Content-type": "application/vnd.api+json",
"Accept": "application/vnd.api+json",
"Authorization": "Bearer ${ACCESS_TOKEN}"
}
payload = {
"data": {
"attributes": {
"version": 2,
"draft": true,
"sections": [
{
"description": "section example",
"title": "title",
"risk_types": [
"privacy"
],
"questions": [
{
"question": "Question 1?"
},
{
"question": "Question 2?"
}
]
}
]
},
"type": "questionnaire_versions"
}
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
Optional steps: Updating A Questionnaire
- Questionnaires can only be updated in draft status i.e. “draft" : true and not “draft": false
- To ensure that evidence is saved and users assigned to the questionnaire are saved while upgrading ID must be provided.
- The IDs are available from the response when a questionnaire is created
- Remember it will overwrite whole sections, so make sure to include ID for existing sections and questions
import requests
url = "https://api.credo.ai/api/v2/${TENANT}/questionnaire_vesions/{id}"
headers = {
"Content-type": "application/vnd.api+json",
"Accept": "application/vnd.api+json",
"Authorization": "Bearer ${ACCESS_TOKEN}"
}
payload = {
"attributes": {
"draft": false,
"sections": [
{
"id": "Gx8hL3q3TKXB7gCiCfdhSA",
"description": "hello world",
"title": "title",
"risk_types": [
"environmental_societal_impact",
"privacy"
],
"questions": [
{
"description": null,
"evidence_type": "text",
"id": "vvzGmr2pvPCGuUELjaW8hD",
"question": "Question 1?",
"select_options": null
},
{
"description": null,
"evidence_type": "text",
"id": "UYdFaLGVFP57iQR3sir6kD",
"question": "Question 2?",
"select_options": null
}
]
}
]
}
},
"id": "QUESTIONNAIREID",
"type": "questionnaire_versions"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)