Regex’s to validate API Key and Org ID format?

API
1

Hi,

Are there any ‘official’ regular expressions for the API key string and the Organisation ID string formats?

To save pointless usage of the api endpoint, I would like to do some simple pre-validation in my functions before attempting a connection/authentication.

I can’t find this mentioned in the documentation.

Any help will be appreciated.

Thanks
M

(‘Moved’ from ‘API Feedback’)…

2

Hey! We don’t have anything official to do this right now but it’s a good suggestion. Can’t promise we will have anything soon but you can ask ChatGPT to write the regex for you and it should be pretty close to what you need for something like this.

2 Likes
3

Thanks @logankilpatrick

I did ask ChatGPT first :grinning:

But not knowing the official specification/format for each; I wasn’t sure I could 100% trust it’s responses.

I’ll keep an eye out in the documentation in the coming months.

Thanks.
M

4

For reference, this is the output ChatGPT gave me:

function isValidFormat(apiKey) {
    // Check if it's a string, has some length, and starts with 'sk'
    return typeof apiKey === 'string' && apiKey.length > 0 && apiKey.startsWith('sk');
}

var apiKey = 'YOUR_API_KEY_HERE'; // Replace with your OpenAI key
console.log(isValidFormat(apiKey) ? 'Key format looks good' : 'Key format is incorrect');

PS: I asked for the starts with “sk” check.

5

Found a thread that appears to stand true. Can’t share links, but the format is sk-[20 characters]T3BlbkFJ[20 characters].

6

I am encountering issues where some APIs, like the File APIs, accept the “sk-” prefix while others, such as the Image APIs, reject the prefix. It seems like a kluge to have to manipulate the API keys.

if(token->StartsWith("sk-")) {
	token := token->SubString((3), token->Size() - 3);
};

image := Image->Create("Create an image of two old steel gears with a transparent background", token);
if(image <> Nil) {
	urls := image->GetUrls();
	each(url in urls) {
		url->ToString()->PrintLine();
	};
};
7

You should never have to inspect or modify a key, and it is bizarre that you even came up with that solution.

The images endpoint fails as expected chopping off the “sk-”

"Authorization": f"Bearer {os.environ.get('OPENAI_API_KEY')[3:]}"

→ “message”: "Incorrect API key provided: xxxxxx

8

Using the key ‘sk-proj-dSUxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxY8cM’ and calling ‘https://api.openai.com/v1/images/generations’ without chopping off the “sk-” prefix generates the error message below.

The call works fine when the prefix is removed.

Suggestions?

{
  "error": {
    "code": "invalid_api_key",
    "message": "Incorrect API key provided: sk-sk-pr***********************************************Y8cM. You can find your API key at https://platform.openai.com/account/api-keys.",
    "param": null,
    "type": "invalid_request_error"
  }
}
9

Thanks! There was a bug in my older code that prepended “sk—” to two API calls, one of which was the File create API call. Appreciate the feedback!