From c90df620f3f348e132c6015d42a15c2aa34ad7d4 Mon Sep 17 00:00:00 2001 From: Stuart Wood <87521783+stuartw843@users.noreply.github.com> Date: Fri, 10 Oct 2025 11:42:29 +0100 Subject: [PATCH] Update temporary tokens to provide the returned JSON format It's not obvious what the JSON is that is returned and it often trips up LLMs and as a user you'd need to log the response to figure out. --- docs/get-started/authentication.mdx | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/get-started/authentication.mdx b/docs/get-started/authentication.mdx index e5e71b7..aeaf1c9 100644 --- a/docs/get-started/authentication.mdx +++ b/docs/get-started/authentication.mdx @@ -117,6 +117,15 @@ curl -L -X POST "https://mp.speechmatics.com/v1/api_keys?type=batch" \ -d '{"ttl": 60, "client_ref": "USER123"}' ``` +The response JSON looks like this: + +```json +{ + "apikey_id": null, + "key_value": "eyJhbG..." +} +``` + To authorize a request using a temporary key, simply use it in place of the API key in the Authorization header. For example, if you created a temporary key associated with a given `client_ref` you can retrieve those jobs as follows: