/organizations/{org_id}/api_keysCreate organization API key
Creates an API key for the specified organization.
The key_name is a user-specified name for the key.
Returns an id and key; the key is a randomly generated, 64-bit token required to access the OptiTech API.
Store the key securely — it is only returned once.
API keys can also be managed in the OptiTech Console.
See Manage API keys.
Quick start
curl "https://api.optitech.com/v1/organizations/$ORG_ID/api_keys" \
-X POST \
-H "Authorization: Bearer $OPTITECH_API_KEY" \
-H "Content-Type: application/json" \
-d '{"key_name":"orgkey"}'import { createOptiTechClient, raw } from '@optitech/sdk';
const optitech = createOptiTechClient({ apiKey: process.env.OPTITECH_API_KEY });
const { data } = await raw.createOrgApiKey({
client: optitech.client,
path: {
org_id: process.env.ORG_ID
},
body: {
key_name: "orgkey"
}
});Parameters
org_idThe OptiTech organization ID
Request body
1 required Required: key_name.
key_nameA user-specified API key name. This value is required when creating an API key.
≤64 chars
program_idIf set, the API key can access only this program
Response
200Created an organization API key
Errors
General error
This endpoint can return the standard OptiTech API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.