Skip to main content
POST
Create a credential

Authorizations

Authorization
string
header
required

User API key: Authorization: Bearer mx_live_*. The X-API-KEY: mx_live_* header is also accepted.

X-Organization-ID
string
header
required

Required organization context for org-scoped endpoints.

Body

application/json

Auth method is inferred from auth_data keys or set explicitly via auth_type.

integration_name
string
required

Integration this credential is for (e.g. openai, slack).

display_name
string | null
auth_type
enum<string> | null

Explicit auth type for the modulex_key / custom paths.

Available options:
modulex_key,
custom
auth_data
object

Secret material. Inferred type: api_key → API key; token/bearer_token → bearer; access_token (with oauth_config) → OAuth2.

oauth_config
object

OAuth2 client config (required for OAuth2 credentials).

metadata
object
make_default
boolean
default:false
expires_at
string<date-time> | null

Response

The created credential.

An integration credential (no sensitive data).

credential_id
string<uuid>
integration_name
string
integration_type
string | null
display_name
string
auth_type
string
is_default
boolean
created_at
string<date-time> | null
updated_at
string<date-time> | null
last_used_at
string<date-time> | null
expires_at
string<date-time> | null
credentials_metadata
object | null