> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.joytokens.ai/llms.txt.

# Responses

POST https://api.joytokens.ai/openai/v1/responses
Content-Type: application/json

Creates a model response using the OpenAI-compatible Responses format. JoyToken currently supports text input, message input items, instructions, sampling limits, and function tools. Provider-hosted built-in tools (e.g. web_search, file_search) and previous_response_id continuation are not available on this gateway contract. This is unrelated to the client SDKs' local default fallback tools, which run on the caller side.


Reference: https://docs.joytokens.ai/open-api/api-reference/compatible-model-ap-is/responses/create-response

## Authentication

- `Authorization` header (bearer token, required) — Use `Authorization: Bearer $JOY_TOKEN_API_KEY`.

## Request

### Headers

- `X-Request-ID` (string, optional) — Optional request identifier for log, billing, and debugging correlation.

### Body (application/json)

This endpoint expects a ResponseRequest.

- `model` (string, required) — Use `auto` to let the gateway pick the model, or pass a concrete `modelName` from the model catalog to pin that model. Both ways are available to every account. When a model is pinned, `tier` is ignored, orchestration is not used, and there is no fallback to another model.
- `input` (ResponseRequestInput, required) — Text input or an array of message input items.
- `instructions` (string, optional) — Optional system-level instructions.
- `stream` (boolean, optional, default: false)
- `max_output_tokens` (integer, optional)
- `temperature` (double, optional)
- `top_p` (double, optional)
- `tools` (list of ResponseTool, optional)

## Response

### 200

Successful Responses result.

- `id` (string, required)
- `object` (enum, required)
  - Allowed values: `response`
- `status` (string, required)
- `model` (string, required)
- `output` (list of ResponseOutputItem, required)
- `usage` (ResponseUsage, optional)
- `metadata` (map from string to any, optional)

## Errors

### 400 Bad Request Error

Invalid request parameters or malformed input.

- `error` (ErrorResponseError, required)

### 401 Unauthorized Error

Missing, invalid, revoked, or expired API key.

- `error` (ErrorResponseError, required)

### 402 Payment Required Error

Insufficient wallet balance or billing freeze failure.

- `error` (ErrorResponseError, required)

### 403 Forbidden Error

Request blocked by API key policy, IP policy, model blacklist, or route strategy.

- `error` (ErrorResponseError, required)

### 429 Too Many Requests Error

Rate limit exceeded.

- `error` (ErrorResponseError, required)

### 500 Internal Server Error

Internal gateway error.

- `error` (ErrorResponseError, required)

## Types

### ResponseRequestInput

Text input or an array of message input items.

- string
- list of ResponseInputItem

### ResponseTool

- `type` (enum, required)
  - Allowed values: `function`
- `name` (string, required)
- `description` (string, optional)
- `parameters` (map from string to any, optional)

### ResponseOutputItem

- `type` (string, required)
- `id` (string, optional)
- `role` (string, optional)
- `status` (string, optional)
- `content` (list of ResponseOutputContent, optional)

### ResponseUsage

- `input_tokens` (integer, optional)
- `output_tokens` (integer, optional)
- `total_tokens` (integer, optional)

### ErrorResponseError

- `message` (string, required)
- `type` (string, optional)
- `code` (ErrorResponseErrorCode, optional, nullable)

### ResponseInputItem

- `type` (string, required)
- `role` (enum, required)
  - Allowed values: `system`, `user`, `assistant`, `tool`
- `content` (ResponseInputItemContent, required)

### ResponseOutputContent

- `type` (string, required)
- `text` (string, optional)
- `annotations` (list of any, optional)

### ErrorResponseErrorCode

- string
- integer

### ResponseInputItemContent

- string
- list of ResponseInputContentPart

### ResponseInputContentPart

- `type` (enum, required)
  - Allowed values: `input_text`, `output_text`, `text`
- `text` (string, required)

## Examples

**Request**

```json
{
  "model": "auto",
  "input": "Explain JoyToken in one sentence.",
  "instructions": "Be concise.",
  "stream": false,
  "max_output_tokens": 256
}
```

**Response**

```json
{
  "id": "resp_xxx",
  "object": "response",
  "status": "completed",
  "model": "auto",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "text": "JoyToken is a governed model gateway."
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 24,
    "output_tokens": 14,
    "total_tokens": 38
  }
}
```

**SDK Code**

```python Responses_createResponse_example
import requests

url = "https://api.joytokens.ai/openai/v1/responses"

payload = {
    "model": "auto",
    "input": "Explain JoyToken in one sentence.",
    "instructions": "Be concise.",
    "stream": False,
    "max_output_tokens": 256
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Responses_createResponse_example
const url = 'https://api.joytokens.ai/openai/v1/responses';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"model":"auto","input":"Explain JoyToken in one sentence.","instructions":"Be concise.","stream":false,"max_output_tokens":256}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Responses_createResponse_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.joytokens.ai/openai/v1/responses"

	payload := strings.NewReader("{\n  \"model\": \"auto\",\n  \"input\": \"Explain JoyToken in one sentence.\",\n  \"instructions\": \"Be concise.\",\n  \"stream\": false,\n  \"max_output_tokens\": 256\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Responses_createResponse_example
require 'uri'
require 'net/http'

url = URI("https://api.joytokens.ai/openai/v1/responses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"auto\",\n  \"input\": \"Explain JoyToken in one sentence.\",\n  \"instructions\": \"Be concise.\",\n  \"stream\": false,\n  \"max_output_tokens\": 256\n}"

response = http.request(request)
puts response.read_body
```

```java Responses_createResponse_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.joytokens.ai/openai/v1/responses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"auto\",\n  \"input\": \"Explain JoyToken in one sentence.\",\n  \"instructions\": \"Be concise.\",\n  \"stream\": false,\n  \"max_output_tokens\": 256\n}")
  .asString();
```

```php Responses_createResponse_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.joytokens.ai/openai/v1/responses', [
  'body' => '{
  "model": "auto",
  "input": "Explain JoyToken in one sentence.",
  "instructions": "Be concise.",
  "stream": false,
  "max_output_tokens": 256
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Responses_createResponse_example
using RestSharp;

var client = new RestClient("https://api.joytokens.ai/openai/v1/responses");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"model\": \"auto\",\n  \"input\": \"Explain JoyToken in one sentence.\",\n  \"instructions\": \"Be concise.\",\n  \"stream\": false,\n  \"max_output_tokens\": 256\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Responses_createResponse_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "model": "auto",
  "input": "Explain JoyToken in one sentence.",
  "instructions": "Be concise.",
  "stream": false,
  "max_output_tokens": 256
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.joytokens.ai/openai/v1/responses")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```