Manage via the UI

App Overview

The App Overview page gives a glimpse of your app and its purpose. To access it, go to your application's individual page and select the Overview option from the collapsible left sidebar.

You'll be redirected to a page that gives an overview of the contents of your app.

You can accomplish various tasks on that page.

• Click the pencil icon next to the app ID to change it.
• Click the Edit Visibility button in the upper-right corner to edit the visibility of your app to either public or private.
• Click the star icon in the upper-right corner to highlight your app. This marks it as a favorite and makes it easier to access among other listed apps.
• Click the three dots in the upper-right corner to reveal a dropdown list that lets you duplicate the app, copy its ID, or delete it.
• View the number of each type of resource contained in your app — inputs, datasets, models, workflows, and modules. If the number is large and has been truncated in the display, click on the tooltip (?) to reveal the precise count of the resource.
• Click the plus icon ( +) within any resource type section to add the resource to your app. If you click the button, you’ll be redirected to a subsequent page that allows you to add the resource you want.
• Click the "view" link within any resource type section to view all the respective resources available in your app.
• Add notes that describe what your app is about.
• Upload a cover image and use it as a reference for the app.
• Edit the app’s description.
• View the app’s base workflow, last updated date, and default language.
• Copy the app's URL and share it across various platforms and social media channels for wider visibility and reach.
• View the types of models contained in the app.
• View and edit the collaborators associated with the app.

App Settings

You can change the settings of an application at any time. To do so, go to the application's individual page and select the Settings option in the collapsible left sidebar.

You'll be redirected to the App Settings page, where you can change the application's settings.

Let's talk about the changes you can make on the page.

API Keys

Create API Keys

Click the Create API Key button to add a new API key to your app. Then, use the form that pops up to generate a new API key — provide a short description, select the scopes, and click the Create API Key button.

The new app-specific key will be listed in the API Keys section, where you can carry out various management tasks on it.

Manage API Keys

The Actions column allows you to complete the following actions:

• Copy an API key to the clipboard by clicking the copy button.
• Reveal an API key by clicking the show button. You can also hide it by clicking the same button.
• Edit an API key by clicking the edit button. A form will pop up that allows you to update the description and scopes of your API key.
• Delete an API key by clicking the delete button.

Collaborators
Collaboration is a functionality that allows you to share your apps so that you can work with your team members to label data, create models, and more. With this feature, you can control the permissions available in your apps and manage the capabilities available to each user.

For example, you can give a trusted collaborator full access privileges. You can also invite a worker and grant them limited permissions, such as only to annotate data but not to delete them.

Add Collaborators

To add a collaborator to your app, click the Add Collaborators button in the Collaborators section. A form will appear that allows you to invite a collaborator.

Enter the email address associated with the collaborator’s Clarifai account and specify the scope of resources you want them to access.

Lastly, click the Confirm button. The invited collaborator will receive an email notification informing them that they have been added to the app.

Choose Scopes

You can select specific scopes when adding a collaborator. Modifying these scopes provides fine-grained control over the data that users can access, enhancing your app's security and preventing unauthorized intrusions.

In the Add Collaborator form, you can click the Select All Scopes button to choose all scopes at once. Alternatively, you can select individual scopes from the listed BASIC SCOPES, or click on the ADVANCED SCOPES option to access more advanced choices.

These are the basic scopes you can choose:

Annotation: Add and Remove Annotations on Inputs
Collaborator: Add, Remove and Patch Collaborators
Collector: Add, Remove and Patch Input Collectors
Concept: Add, Remove and Patch Concept
Input: Add and Remove Inputs to an App
Model: Add, Remove and Train Custom Models
Predict: Predict on Public and Custom Models
Search: Search over Inputs an App
Task: Add, Remove and Patch Scribe labeling Tasks
Vocab: Add, Remove and Delete lists of Concepts
Workflow: Add, Remove and Delete Workflows of Models

Update Visibility

To change your app’s visibility, click the Edit Visibility button. In the pop-up window, select either Public to make the app accessible to anyone or Private to restrict access. Then, click Confirm to apply the change.

Delete Application

You can delete the application by clicking the Delete App button. A small window will pop up, prompting you to confirm the action.

Manage via the API

Patch App

You can perform patch operations on an app by merging, removing, or overwriting data. By default, all actions support overwriting, with specific behaviors for lists of objects.