Create an OpenAI-compatible response

Create a response using Telnyx’s OpenAI-compatible Responses API. This endpoint is compatible with the OpenAI Responses API and may be used with the OpenAI JS or Python SDK by setting the base URL to https://api.telnyx.com/v2/ai/openai.

The conversation parameter refers to a Telnyx Conversation rather than an OpenAI-hosted conversation object. To persist a thread across turns, first create a conversation with POST /ai/conversations, then pass that conversation’s id in the Responses request as conversation. The endpoint appends the new input, assistant output, reasoning, and tool-call messages to that conversation. Reuse the same conversation id on subsequent Responses requests, including tool-result followups, so the model receives the prior context.

If conversation is omitted, the request is processed without persisting messages to a Telnyx conversation. Use the Conversations API to manage history: list conversations (optionally filtered by metadata), fetch messages for a conversation, and optionally add messages outside the Responses flow.

You can attach arbitrary metadata when creating a conversation (for example to tag the conversation’s source, channel, or user) and later filter by it when listing conversations.

POST

openai

responses

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.ai.openai.createResponse({
  conversation: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
  input: [{ role: 'user', content: [{ type: 'input_text', text: 'Hello, world!' }] }],
  instructions: 'You are a friendly chatbot.',
  model: 'zai-org/GLM-5.1-FP8',
  stream: true,
});

console.log(response);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.ai.openai.create_response(
    conversation="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    input=[{
        "role": "user",
        "content": [{
            "type": "input_text",
            "text": "Hello, world!",
        }],
    }],
    instructions="You are a friendly chatbot.",
    model="zai-org/GLM-5.1-FP8",
    stream=True,
)
print(response)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.AI.OpenAI.NewResponse(context.TODO(), telnyx.AIOpenAINewResponseParams{
		Conversation: telnyx.String("6a09cdc3-8948-47f0-aa62-74ac943d6c58"),
		Input: []any{
			map[string]any{
				"role": "user",
				"content": []any{
					map[string]any{
						"type": "input_text",
						"text": "Hello, world!",
					},
				},
			},
		},
		Instructions: telnyx.String("You are a friendly chatbot."),
		Model:        telnyx.String("zai-org/GLM-5.1-FP8"),
		Stream:       telnyx.Bool(true),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.ai.openai.OpenAICreateResponseParams;
import com.telnyx.sdk.models.ai.openai.OpenAICreateResponseResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        OpenAICreateResponseResponse response = client.ai().openai().createResponse();
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->ai->openai->createResponse(
    conversation: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
    input: [
      [
        'role' => 'user',
        'content' => [['type' => 'input_text', 'text' => 'Hello, world!']],
      ],
    ],
    instructions: 'You are a friendly chatbot.',
    model: 'zai-org/GLM-5.1-FP8',
    stream: true,
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request POST \
  --url https://api.telnyx.com/v2/ai/openai/responses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "zai-org/GLM-5.1-FP8",
  "conversation": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "instructions": "You are a friendly chatbot.",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Hello, world!"
        }
      ]
    }
  ],
  "stream": false
}
'

{
  "id": "resp_8b1f2a3c9d4e5f6a",
  "object": "response",
  "created_at": 1706011802,
  "status": "completed",
  "model": "zai-org/GLM-5.1-FP8",
  "output": [
    {
      "type": "message",
      "id": "msg_8b1f2a3c9d4e5f6a",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "Telnyx provides carrier-grade voice, messaging, and AI inference through one API."
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 24,
    "output_tokens": 18,
    "total_tokens": 42
  }
}

{
  "detail": [
    {
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

model

string

Model identifier to use for the response, for example zai-org/GLM-5.1-FP8 or another model available from the Telnyx OpenAI-compatible models endpoint.

service_tier

string

The service tier to use for this request. Supported values vary by model; use GET /v2/ai/openai/models and inspect the model's service_tiers field. If omitted, Telnyx-hosted models use default.

region

enum<string>

Optional data-residency region the request should be served from, using the same vocabulary as your account's Data Locality setting. Behavior depends on mode. Supported for Telnyx-hosted models only: a request routed to an external provider never passes through Telnyx model routing, so a region cannot be enforced for it. Omit for today's latency-based routing.

Available options:

USA,

EU,

AUS,

UAE

mode

enum<string>

default:preferred

How strictly region is applied. preferred (the default when region is set) tries that region first and falls back to another when the model cannot be served there, so a request that would have succeeded still succeeds. strict pins the request: it is served from that region or it fails with a 422, never redirected to another region. Requires region.

Available options:

preferred,

strict

input

any

The input items for this turn, using the OpenAI Responses API input format.

conversation

string<uuid>

Optional Telnyx Conversation ID from POST /ai/conversations. When provided, Telnyx stores this turn on that conversation and uses the conversation's prior messages as context. Reuse the same ID for subsequent turns and tool-result followups. Omit it for a non-persisted, stateless response.

instructions

string

Optional system/developer instructions for the model. When used with a persisted conversation, send these on the first request that creates the thread; subsequent turns can rely on the stored history.

stream

boolean

Set to true to stream Server-Sent Events, matching OpenAI's Responses streaming format.

reasoning

object

Show child attributes

Response

Successful Response

The response is of type object.

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.ai.openai.createResponse({
  conversation: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
  input: [{ role: 'user', content: [{ type: 'input_text', text: 'Hello, world!' }] }],
  instructions: 'You are a friendly chatbot.',
  model: 'zai-org/GLM-5.1-FP8',
  stream: true,
});

console.log(response);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.ai.openai.create_response(
    conversation="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    input=[{
        "role": "user",
        "content": [{
            "type": "input_text",
            "text": "Hello, world!",
        }],
    }],
    instructions="You are a friendly chatbot.",
    model="zai-org/GLM-5.1-FP8",
    stream=True,
)
print(response)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.AI.OpenAI.NewResponse(context.TODO(), telnyx.AIOpenAINewResponseParams{
		Conversation: telnyx.String("6a09cdc3-8948-47f0-aa62-74ac943d6c58"),
		Input: []any{
			map[string]any{
				"role": "user",
				"content": []any{
					map[string]any{
						"type": "input_text",
						"text": "Hello, world!",
					},
				},
			},
		},
		Instructions: telnyx.String("You are a friendly chatbot."),
		Model:        telnyx.String("zai-org/GLM-5.1-FP8"),
		Stream:       telnyx.Bool(true),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.ai.openai.OpenAICreateResponseParams;
import com.telnyx.sdk.models.ai.openai.OpenAICreateResponseResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        OpenAICreateResponseResponse response = client.ai().openai().createResponse();
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->ai->openai->createResponse(
    conversation: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
    input: [
      [
        'role' => 'user',
        'content' => [['type' => 'input_text', 'text' => 'Hello, world!']],
      ],
    ],
    instructions: 'You are a friendly chatbot.',
    model: 'zai-org/GLM-5.1-FP8',
    stream: true,
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request POST \
  --url https://api.telnyx.com/v2/ai/openai/responses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "zai-org/GLM-5.1-FP8",
  "conversation": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "instructions": "You are a friendly chatbot.",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Hello, world!"
        }
      ]
    }
  ],
  "stream": false
}
'

{
  "id": "resp_8b1f2a3c9d4e5f6a",
  "object": "response",
  "created_at": 1706011802,
  "status": "completed",
  "model": "zai-org/GLM-5.1-FP8",
  "output": [
    {
      "type": "message",
      "id": "msg_8b1f2a3c9d4e5f6a",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "Telnyx provides carrier-grade voice, messaging, and AI inference through one API."
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 24,
    "output_tokens": 18,
    "total_tokens": 42
  }
}

{
  "detail": [
    {
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

Inference

Data Residency

Integrations

Tutorials

API Reference

For AI Agents

Create an OpenAI-compatible response

Authorizations

Body

Response