Connecting to Clarifai

Using API Key Authentication

Clarifai uses Personal Access Tokens (PATs) for authentication. To obtain a PAT:

Log in to your Clarifai account at https://clarifai.com.
Navigate to your profile settings and select Security.
Click Create Personal Access Token.
Select the required scopes and click Create Token.
Copy the generated token (it will only be shown once).

After obtaining your Personal Access Token, set the following connection properties:

AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

APIKey: Set this to your Clarifai Personal Access Token (PAT).

Example Connection String

Profile=C:\profiles\Clarifai.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_personal_access_token";

Connecting to Clarifai

Once the authentication is configured, you can connect to Clarifai and query data from any of the available tables such as Users, Apps, Models, Workflows, and Datasets.

Available Tables

The Clarifai API Profile provides access to the following tables:

AnnotationFilters: Retrieve annotation filter definitions for a Clarifai app (requires UserId and AppId)
Annotations: Retrieve annotations for a Clarifai app (requires UserId and AppId)
Apps: Retrieve a list of apps for the specified Clarifai user (requires UserId)
Artifacts: Retrieve artifacts for a Clarifai app (requires UserId and AppId)
ComputeClusters: Retrieve compute clusters for a Clarifai user (requires UserId)
Concepts: Retrieve concepts defined in a Clarifai app (requires UserId and AppId)
Datasets: Retrieve datasets for a Clarifai app, or a single dataset when DatasetId is provided (requires UserId and AppId)
Deployments: Retrieve model deployments for a Clarifai user (requires UserId)
Inputs: Retrieve inputs for a Clarifai app (requires UserId and AppId)
Keys: Retrieve API keys for a Clarifai user (requires UserId)
Models: Retrieve a list of models for a Clarifai app (requires UserId and AppId)
Runners: Retrieve compute runners for a Clarifai user (requires UserId)
Tasks: Retrieve labeling tasks for a Clarifai app (requires UserId and AppId)
Users: Retrieve the authenticated Clarifai user profile
Vocabs: Retrieve vocabularies for a Clarifai app (requires UserId and AppId)
Workflows: Retrieve workflows for a Clarifai app, or a single workflow when WorkflowId is provided (requires UserId and AppId)

Important Notes

All resource endpoints require a UserId path parameter at minimum.
App-scoped tables additionally require an AppId path parameter.
Child or nested tables require parent identifiers to be specified as WHERE clause filters (e.g. WHERE UserId = 'user1' AND AppId = 'app1').
List endpoints use page-based pagination via the page and per_page query parameters with a default page size of 128.
Date fields use ISO 8601 format (yyyy-MM-dd'T'HH:mm:ssZ).
Authentication uses the Authorization: Key {PAT} header format.
Rate limiting applies - refer to Clarifai API documentation for current limits.

API Documentation

For more information about the Clarifai API, see the official Clarifai API documentation.

Usage Examples

Users:

SELECT * FROM Users

Apps:

SELECT * FROM Apps WHERE UserId = 'my-user-id'

Models:

SELECT * FROM Models WHERE UserId = 'my-user-id' AND AppId = 'my-app-id'

Concepts:

SELECT * FROM Concepts WHERE UserId = 'my-user-id' AND AppId = 'my-app-id'

Workflows (list):

SELECT * FROM Workflows WHERE UserId = 'my-user-id' AND AppId = 'my-app-id'

Workflows (single workflow by ID):

SELECT * FROM Workflows WHERE UserId = 'my-user-id' AND AppId = 'my-app-id' AND WorkflowId = 'my-workflow-id'

Datasets (list):

SELECT * FROM Datasets WHERE UserId = 'my-user-id' AND AppId = 'my-app-id'

Datasets (single dataset by ID):

SELECT * FROM Datasets WHERE UserId = 'my-user-id' AND AppId = 'my-app-id' AND DatasetId = 'my-dataset-id'

Inputs:

SELECT * FROM Inputs WHERE UserId = 'my-user-id' AND AppId = 'my-app-id'

Annotations:

SELECT * FROM Annotations WHERE UserId = 'my-user-id' AND AppId = 'my-app-id'

Annotations (filtered by input):

SELECT * FROM Annotations WHERE UserId = 'my-user-id' AND AppId = 'my-app-id' AND InputId = 'my-input-id'

AnnotationFilters:

SELECT * FROM AnnotationFilters WHERE UserId = 'my-user-id' AND AppId = 'my-app-id'

Tasks:

SELECT * FROM Tasks WHERE UserId = 'my-user-id' AND AppId = 'my-app-id'

Artifacts:

SELECT * FROM Artifacts WHERE UserId = 'my-user-id' AND AppId = 'my-app-id'

Vocabs:

SELECT * FROM Vocabs WHERE UserId = 'my-user-id' AND AppId = 'my-app-id'

Keys:

SELECT * FROM Keys WHERE UserId = 'my-user-id'

ComputeClusters:

SELECT * FROM ComputeClusters WHERE UserId = 'my-user-id'

Runners:

SELECT * FROM Runners WHERE UserId = 'my-user-id'

Deployments:

SELECT * FROM Deployments WHERE UserId = 'my-user-id'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	The Personal Access Token (PAT) used to authenticate to the Clarifai API.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD