List Credentials

Beta

GET

https://api.speechify.ai/v1/credentials

GET

/v1/credentials

$ curl https://api.speechify.ai/v1/credentials \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "credentials": [
3     {
4       "id": "cred_01arz3ndektsv4rrffq69g5fav",
5       "name": "Acme Inc OAuth Client Credentials",
6       "kind": "oauth2_client_credentials",
7       "config": {
8         "oauth2_client_credentials": {
9           "token_url": "https://auth.acme-inc.com/oauth2/token",
10           "client_id": "acme-client-12345",
11           "client_secret": "s3cr3tAcmeClientKey!",
12           "scopes": [
13             "read:documents",
14             "write:documents"
15           ],
16           "audience": "https://api.acme-inc.com/"
17         }
18       },
19       "created_at": "2024-01-15T09:30:00Z",
20       "updated_at": "2024-01-15T09:30:00Z"
21     },
22     {
23       "id": "cred_01arz3ndektsv4rrffq69g5fb",
24       "name": "Acme Inc Service Account JWT",
25       "kind": "oauth2_jwt",
26       "config": {
27         "oauth2_jwt": {
28           "token_url": "https://auth.acme-inc.com/oauth2/token",
29           "issuer": "service-account@acme-inc.iam.gserviceaccount.com",
30           "audience": "https://api.acme-inc.com/",
31           "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASC...\n-----END PRIVATE KEY-----",
32           "subject": "service-account@acme-inc.iam.gserviceaccount.com",
33           "scopes": [
34             "https://www.googleapis.com/auth/cloud-platform"
35           ],
36           "key_id": "acme-key-2024"
37         }
38       },
39       "created_at": "2024-02-20T11:00:00Z",
40       "updated_at": "2024-03-01T08:45:00Z"
41     },
42     {
43       "id": "cred_01arz3ndektsv4rrffq69g5fc",
44       "name": "Acme Inc Basic Auth",
45       "kind": "basic",
46       "config": {
47         "basic": {
48           "username": "cliff.weitzman",
49           "password": "P@ssw0rd123!"
50         }
51       },
52       "created_at": "2024-04-10T14:15:00Z",
53       "updated_at": "2024-04-10T14:15:00Z"
54     },
55     {
56       "id": "cred_01arz3ndektsv4rrffq69g5fd",
57       "name": "Acme Inc Static Bearer Token",
58       "kind": "bearer",
59       "config": {
60         "bearer": {
61           "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
62         }
63       },
64       "created_at": "2024-05-05T10:00:00Z",
65       "updated_at": "2024-05-05T10:00:00Z"
66     },
67     {
68       "id": "cred_01arz3ndektsv4rrffq69g5fe",
69       "name": "Acme Inc Custom Headers",
70       "kind": "custom_headers",
71       "config": {
72         "custom_headers": {
73           "headers": {
74             "X-Api-Key": "acme-custom-header-key-98765",
75             "X-Custom-Signature": "sha256=abcdef1234567890"
76           }
77         }
78       },
79       "created_at": "2024-06-01T09:00:00Z",
80       "updated_at": "2024-06-01T09:00:00Z"
81     }
82   ]
83 }

List every active credential in the caller’s workspace, newest first. Each credential’s config is returned decrypted — the config IS the user-supplied secret, and the console relies on reading it back to pre-fill the edit form. Soft-deleted credentials are omitted.

Authentication

AuthorizationBearer

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

Response

All active credentials in the workspace.

credentialslist of objects

Errors

401

Unauthorized Error