For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://modelgates.ai/docs/_mcp/server.

Chat - TypeScript SDK

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Overview

Available Operations

  • send - Create a chat completion

send

Sends a request for a model response for the given chat conversation. Supports both streaming and non-streaming modes.

Example Usage: guardrail-blocked

typescript
import { ModelGates } from "@modelgates/sdk"; const modelgates = new ModelGates({  httpReferer: "<value>",  appTitle: "<value>",  appCategories: "<value>",  apiKey: process.env["MODELGATES_API_KEY"] ?? "",}); async function run() {  const result = await modelgates.chat.send({    chatRequest: {      messages: [        {          content: "You are a helpful assistant.",          role: "system",        },        {          content: "What is the capital of France?",          role: "user",        },      ],    },  });   console.log(result);} run();

Standalone function

The standalone function version of this method:

typescript
import { ModelGatesCore } from "@modelgates/sdk/core.js";import { chatSend } from "@modelgates/sdk/funcs/chatSend.js"; // Use `ModelGatesCore` for best tree-shaking performance.// You can create one instance of it to use across an application.const modelgates = new ModelGatesCore({  httpReferer: "<value>",  appTitle: "<value>",  appCategories: "<value>",  apiKey: process.env["MODELGATES_API_KEY"] ?? "",}); async function run() {  const res = await chatSend(modelgates, {    chatRequest: {      messages: [        {          content: "You are a helpful assistant.",          role: "system",        },        {          content: "What is the capital of France?",          role: "user",        },      ],    },  });  if (res.ok) {    const { value: result } = res;    console.log(result);  } else {    console.log("chatSend failed:", res.error);  }} run();

Example Usage: insufficient-permissions

typescript
import { ModelGates } from "@modelgates/sdk"; const modelgates = new ModelGates({  httpReferer: "<value>",  appTitle: "<value>",  appCategories: "<value>",  apiKey: process.env["MODELGATES_API_KEY"] ?? "",}); async function run() {  const result = await modelgates.chat.send({    chatRequest: {      messages: [        {          content: "You are a helpful assistant.",          role: "system",        },        {          content: "What is the capital of France?",          role: "user",        },      ],    },  });   console.log(result);} run();

Standalone function

The standalone function version of this method:

typescript
import { ModelGatesCore } from "@modelgates/sdk/core.js";import { chatSend } from "@modelgates/sdk/funcs/chatSend.js"; // Use `ModelGatesCore` for best tree-shaking performance.// You can create one instance of it to use across an application.const modelgates = new ModelGatesCore({  httpReferer: "<value>",  appTitle: "<value>",  appCategories: "<value>",  apiKey: process.env["MODELGATES_API_KEY"] ?? "",}); async function run() {  const res = await chatSend(modelgates, {    chatRequest: {      messages: [        {          content: "You are a helpful assistant.",          role: "system",        },        {          content: "What is the capital of France?",          role: "user",        },      ],    },  });  if (res.ok) {    const { value: result } = res;    console.log(result);  } else {    console.log("chatSend failed:", res.error);  }} run();

Parameters

ParameterTypeRequiredDescription
requestoperations.SendChatCompletionRequestRequest:heavy_check_mark:The request object to use for the request.
optionsRequestOptions:heavy_minus_sign:Used to set various options for making HTTP requests.
options.fetchOptionsRequestInit:heavy_minus_sign:Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retriesRetryConfig:heavy_minus_sign:Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.SendChatCompletionRequestResponse>

Errors

Error TypeStatus CodeContent Type
errors.BadRequestResponseError400application/json
errors.UnauthorizedResponseError401application/json
errors.PaymentRequiredResponseError402application/json
errors.ForbiddenResponseError403application/json
errors.NotFoundResponseError404application/json
errors.RequestTimeoutResponseError408application/json
errors.PayloadTooLargeResponseError413application/json
errors.UnprocessableEntityResponseError422application/json
errors.TooManyRequestsResponseError429application/json
errors.InternalServerResponseError500application/json
errors.BadGatewayResponseError502application/json
errors.ServiceUnavailableResponseError503application/json
errors.EdgeNetworkTimeoutResponseError524application/json
errors.ProviderOverloadedResponseError529application/json
errors.ModelGatesDefaultError4XX, 5XX*/*