API Referencecredentials

Get Credential

Beta

Fetch one credential by id, scoped to the caller’s workspace. config is returned decrypted. Returns 404 for missing, soft-deleted, or foreign-workspace credentials — credential existence is never leaked across workspaces.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

idstringRequired

Credential id (prefixed external id, cred_...).

Headers

Speechify-VersionstringOptional

Response

The credential.
idstring

Workspace-scoped credential identifier (prefixed external id).

namestring

Human-readable label, unique per workspace among active credentials.

kindenum

Discriminates the auth flow a credential carries. The matching config.<kind> block is the one that must be populated.

configobject

Kind-specific credential payload. Exactly one block is populated — the one named by the credential’s kind. The block IS the secret; it is echoed back decrypted on reads.

created_atdatetime
updated_atdatetime

Errors

401
Unauthorized Error
404
Not Found Error