/programs/{program_id}/frameworks/{framework_id}/ai_gatewaybetaGet framework AI Gateway endpoint
Returns the AI Gateway endpoint host for the specified framework, used to
render code-snippet base URLs. A 200 response means the framework is
registered and this region serves the AI gateway. A 404 response
includes a reason field indicating why the gateway is unavailable.
Note: This endpoint is currently in Private Beta.
Quick start
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/frameworks/$FRAMEWORK_ID/ai_gateway" \
-H "Authorization: Bearer $OPTITECH_API_KEY"Every field below is optional. An empty body works too.
import { createOptiTechClient, raw } from '@optitech/sdk';
const optitech = createOptiTechClient({ apiKey: process.env.OPTITECH_API_KEY });
const { data } = await raw.getProjectBranchAiGateway({
client: optitech.client,
path: {
program_id: process.env.PROGRAM_ID,
framework_id: process.env.FRAMEWORK_ID
}
});Parameters
program_idThe OptiTech program ID
framework_idThe OptiTech framework ID
Response
200AI Gateway is enabled for this framework
Errors
AI Gateway is not available for this framework, or the program/framework
was not found. The body is always BranchAiGatewayNotEnabled — see
reason for the exact cause.
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.