Managing Fabricate API keys
To use the Fabricate API, and to interact with mock APIs and MCP servers, you must have a Fabricate API key.
Each Fabricate API key is granted access to specific workspaces and is assigned an account role.
Account owners can generate new Fabricate API keys as needed. API keys have no effect on an account's user seats.
Displaying the list of API keys
To display the list of API keys, click the user icon at the bottom left of Fabricate, then select Account Settings.
The API Keys page contains the list of API keys for the account.
Creating an API key
To create an API key, click New API Key.
Setting the API key name
On the Create New API Key panel, in the Name field, provide a name for the API key.
Setting the API key expiration
By default, API keys do not expire.
To set an expiration, from the Expires dropdown list, select when the API key expires. You can select one of the default options (30 days, 90 days, one year), or provide a custom expiration date.
Setting the API key AI spend limit
By default, an API key is subject to the default AI spend limit for account users.
To customize the limit for the API key, in the AI Spend Limit field, specify the limit.
Setting the account role for the API key
By default, new API keys are assigned the Member account role. For information about account roles, go to Assigning account roles to users.
To assign a different account role, select the role from the dropdown list.
Granting access to current account workspaces
By default:
For account roles other than Auditor, API keys are by default granted Editor access to all of the current account workspaces. For information about workspace roles, go to About workspace roles. To grant a different workspace role, select the role from the dropdown list. To not grant any access to the account workspaces, toggle Grant access to all workspaces to the off position. You can then add the API key as needed to specific workspaces.
For the Auditor account role, API keys are not by default granted specific access to existing workspaces, and the toggle is in the off position. To grant additional access to the account workspaces, toggle Grant access to all workspaces to the on position, then select the role to assign.
Note that this setting only applies to workspaces that exist when you create the API key. The API key is not automatically granted access to any future workspaces.
Setting the model preferences for calls to the MCP server
By default, when an API key is used to make calls to the Fabricate MCP server, it uses the default models that are configured for the account.
To customize the models that the API key uses for the MCP server:
From the Data Generation dropdown list, select the AI model to use for data generation.
From the Validation dropdown list, select the AI model to use for validation.
From the Data Profiling dropdown list, select the AI model to use for data profiling.
From the Freeform Text dropdown list, select the category of AI model to use to generate freeform text.
You can select from the available models for the account.
Saving and copying the API key
When you complete the API key configuration:
Click Create API Key.
On the API key created panel, Fabricate displays the key. To be able to use the key, you must copy it from this panel. The key is not displayed again. On the API Keys page, the keys are masked. To copy the key to the clipboard, click Copy.
Editing an API key
Changing the API key configuration
To change the API key configuration:
Click the edit icon for the API key.
On the Edit API Key panel, update the API key settings.
To save the changes, click Save Changes.
Changing the assigned account role for an API key
You can also change the assigned account role directly from the API Keys list.
To change the assigned account role for an API key, select the role from the Account Role dropdown list.
Changing the AI spend limit for an API key
You can change the AI spend limit directly from the API Keys list.
You can edit the regular spend limit, and set a temporary increased spend limit for the current billing period. For example, you might grant the API key a temporary increase to use to complete a special project.
To change the AI spend limit:
In the AI Spend Limit column for the API key, click the edit icon.
On the Edit AI Spend Limit panel, in the Billing-period spend limit field, provide the maximum AI spend per billing period for the API key. You can either type the value directly, or use the up and down arrows to increase or decrease the value. If the current value is different from the default, then to reset it to the default, click Reset to Default.
In the Temporary Spend Increase field, provide a larger spend limit that only applies to the current billing period. You can either type the value directly, or use the up and down arrows to increase or decrease the value. The value must be larger than Billing-period spend limit. The value represents the total increased spend limit, not the difference between the regular limit and the temporary increased limit. For example, if the billing-period spend limit is $5, then to temporarily increase it to $10, in the field, set the value to 10.
Click Save.
When a temporary increase is in effect, the AI Spend Limit column indicates the increased limit and when it expires.
Deleting an API key
To delete an API key:
Click its delete icon.
On the confirmation panel, click Confirm.
Last updated
Was this helpful?