How to Add Custom Fields via API

This guide provides instructions for adding custom fields 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.ai with 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}
• Each request creates 1 new custom field
• To create multiple custom fields, push the first one then change the precious to reflect the new field needed for the tenant and then make a new request
• Body params
  • element_type can be set to 
    • select which allows the user to set options for a user to select from. 
    • input which allows user input and can be filtered in the AI registry.
    • checkbox allows a user to check options.

import requests

url = "https://api.credo.ai/api/v2/${TENANT}/tenant_info"

headers = {

      "Content-type": "application/vnd.api+json",

      "Accept": "application/vnd.api+json",

      "Authorization": "Bearer ${ACCESS_TOKEN}"

}

payload = {

  "data": {

    "attributes": {

      "element_type": "input",

      "metadata": {

        "max": 100,

        "min": 0

      },

      "multiple": true,

      "name": "string",

      "options": [

        "Finance",

        "Marketing"

      ],

      "target": "use_case",

      "type": "string"

    },

    "type": "resource-type"

  }

}

response = requests.post(url, json=payload, headers=headers)

print(response.text)