API Referencecredentials

Create Credential

Beta

Create a credential in the caller’s workspace. config must carry exactly the one kind-specific block named by kind (e.g. kind=bearer requires config.bearer). Names are unique per workspace among active credentials.

Authentication

AuthorizationBearer

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

Headers

Speechify-VersionstringOptional

Request

This endpoint expects an object.
namestringRequired

Human-readable label, unique per workspace.

kindenumRequired

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

configobjectRequired

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.

Response

The created 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

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error