Skip to main content
POST
/
api
/
v1
/
credentials
{
  "label": "<string>",
  "description": "<string>",
  "auth_type": "api_key",
  "credential_type": "integration",
  "credential_scope": "<string>",
  "provider": "<string>",
  "user_id": "<string>",
  "id": "<string>",
  "workspace_id": "<string>",
  "created_by": "<string>",
  "status": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Workspace-Id
string | null

The workspace ID

Body

application/json

Schema for creating a new credential.

​
label
string
required

Human-readable label for the credential

Required string length: 1 - 100
​
auth_type
enum<string>
required

Type of authentication (API_KEY, OAUTH2, etc.)

Available options:
api_key,
oauth_token,
oauth_token_refresh,
oauth_token_refresh_rotation,
basic_auth,
access_token,
access_token_refresh,
public_key_secret,
connection_string,
custom
​
credential_scope
string
required

Who is the credential for (workspace, user, workspace_member)

Maximum length: 255
​
credentials
object
required

Raw credential data to be encrypted

​
description
string | null

Optional description of the credential

Maximum length: 255
​
credential_type
enum<string> | null

Category of credential (INTEGRATION, MODEL, etc.)

Available options:
integration,
llm,
storage,
vector_store,
auth_provider,
custom
​
provider
string | null
default:custom

Provider of the credential

Maximum length: 255
​
user_id
string | null

User ID of the credential

Maximum length: 255

Response

Successful Response

Schema for reading credential data (without sensitive info).

​
label
string
required

Human-readable label for the credential

Required string length: 1 - 100
​
auth_type
enum<string>
required

Type of authentication (API_KEY, OAUTH2, etc.)

Available options:
api_key,
oauth_token,
oauth_token_refresh,
oauth_token_refresh_rotation,
basic_auth,
access_token,
access_token_refresh,
public_key_secret,
connection_string,
custom
​
credential_scope
string
required

Who is the credential for (workspace, user, workspace_member)

Maximum length: 255
​
provider
string
required
​
id
string
required
​
workspace_id
string
required
​
created_by
string
required
​
status
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null

Optional description of the credential

Maximum length: 255
​
credential_type
enum<string> | null

Category of credential (INTEGRATION, MODEL, etc.)

Available options:
integration,
llm,
storage,
vector_store,
auth_provider,
custom
​
user_id
string | null

User ID of the credential

Maximum length: 255
​
expires_at
string<date-time> | null
​
last_used_at
string<date-time> | null