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

# Anthropic Messages

POST https://api-staging.joytokens.ai/anthropic/v1/messages
Content-Type: application/json

Creates a model response using an Anthropic-compatible Messages request.

Reference: https://docs-staging.joytokens.ai/open-api/api-reference/compatible-model-ap-is/messages/create-anthropic-message

## Authentication

- `X-API-Key` header (required) — Use `X-API-Key: $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 an AnthropicMessageRequest.

- `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.
- `max_tokens` (integer, required) — Maximum number of output tokens.
- `messages` (list of AnthropicMessage, required)
- `system` (AnthropicMessageRequestSystem, optional)
- `stream` (boolean, optional, default: false) — Return an Anthropic-compatible SSE stream when true.
- `temperature` (double, optional) — Sampling temperature forwarded to the selected provider when supported.
- `tools` (list of map from string to any, optional)

## Response

### 200

Successful Anthropic-compatible message response.

- `id` (string, required)
- `type` (enum, required)
  - Allowed values: `message`
- `role` (enum, required)
  - Allowed values: `assistant`
- `model` (string, required)
- `content` (list of map from string to any, required)
- `stop_reason` (string, optional, nullable)
- `stop_sequence` (string, optional, nullable)
- `usage` (AnthropicMessageResponseUsage, optional)
- `metadata` (JoyTokenMetadata, optional) — JoyToken routing and billing metadata appended by the gateway when available. In orchestration (multi-task planning) mode this object also carries per-task identifiers, and the response returns one metadata object per task.

## Errors

### 400 Bad Request Error

Invalid request parameters or malformed input.

- `type` (enum, required)
  - Allowed values: `error`
- `error` (AnthropicErrorResponseError, required)

### 401 Unauthorized Error

Missing API key.

- `type` (enum, required)
  - Allowed values: `error`
- `error` (AnthropicErrorResponseError, required)

### 402 Payment Required Error

Insufficient wallet balance or billing freeze failure.

- `type` (enum, required)
  - Allowed values: `error`
- `error` (AnthropicErrorResponseError, required)

### 403 Forbidden Error

Invalid API key or request blocked by policy.

- `type` (enum, required)
  - Allowed values: `error`
- `error` (AnthropicErrorResponseError, required)

### 429 Too Many Requests Error

Rate limit exceeded.

- `type` (enum, required)
  - Allowed values: `error`
- `error` (AnthropicErrorResponseError, required)

### 500 Internal Server Error

Internal gateway error.

- `type` (enum, required)
  - Allowed values: `error`
- `error` (AnthropicErrorResponseError, required)

## Types

### AnthropicMessage

- `role` (enum, required)
  - Allowed values: `user`, `assistant`
- `content` (AnthropicMessageContent, required)

### AnthropicMessageRequestSystem

- string
- list of map from string to any

### AnthropicMessageResponseUsage

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

### JoyTokenMetadata

JoyToken routing and billing metadata appended by the gateway when available. In orchestration (multi-task planning) mode this object also carries per-task identifiers, and the response returns one metadata object per task.

- `model` (string, optional) — Final model used. May be `auto` for aggregation tasks, or a concrete sub-model (for example `Gemini-3-Flash-Preview`, `gpt-5.6-luna`) that executed a specific task.
- `tier` (enum, optional) — JoyToken model tier.
  - Allowed values: `economy`, `standard`, `premium`
- `score` (double, optional)
- `billing_id` (string, optional) — Billing account identifier. Present in orchestration metadata events.
- `tag` (list of string, optional) — Role tags describing what a task did. Present in orchestration mode. Common values include orchestration, search, reasoning, writing, and aggregation.
- `task_id` (string, optional) — Task identifier. Reserved values are `__planner__` and `__final__`.
- `task_seq` (integer, optional) — Execution sequence of the task. `0` is the planner.
- `task_status` (enum, optional) — Task lifecycle status.
  - Allowed values: `DONE`
- `title` (string, optional) — Human-readable task title from the plan.
- `billing` (JoyTokenMetadataBilling, optional)
- `usage` (map from string to any, optional) — Provider usage plus JoyToken credits_used when available.
- `latency` (JoyTokenMetadataLatency, optional) — Latency breakdown. Orchestration tasks report first_token_ms and stream_ms.
- `request_id` (string, optional) — Gateway request identifier for log, billing, and debugging correlation. Present on non-streaming top-level metadata.
- `model_recommendation` (JoyTokenMetadataModelRecommendation, optional) — Router's model recommendation for this request, including candidate models and their scores.
- `task_score` (JoyTokenMetadataTaskScore, optional) — Router scoring breakdown used to select the model.

### AnthropicErrorResponseError

- `type` (string, required)
- `message` (string, required)

### AnthropicMessageContent

- string
- list of map from string to any

### JoyTokenMetadataBilling

- `credits_used` (string, optional)
- `input_tokens` (integer, optional)
- `output_tokens` (integer, optional)
- `cached_input_tokens` (integer, optional)
- `cached_output_tokens` (integer, optional)

### JoyTokenMetadataLatency

Latency breakdown. Orchestration tasks report first_token_ms and stream_ms.

- `routing_ms` (integer, optional)
- `first_token_ms` (integer, optional)
- `stream_ms` (integer, optional)

### JoyTokenMetadataModelRecommendation

Router's model recommendation for this request, including candidate models and their scores.

- `models` (list of JoyTokenMetadataModelRecommendationModelsItems, optional)

### JoyTokenMetadataTaskScore

Router scoring breakdown used to select the model.

- `history_score` (double, optional)
- `latest_conversation_score` (double, optional)
- `multimodal_score` (double, optional)
- `system_score` (double, optional)
- `tool_score` (double, optional)
- `total_score` (double, optional)

### JoyTokenMetadataModelRecommendationModelsItems

- `model_id` (string, optional)
- `probability` (double, optional)
- `selected` (boolean, optional)
- `feature_tags` (list of string, optional)

## Examples

**Request**

```json
{
  "model": "auto",
  "max_tokens": 1024,
  "messages": [
    {
      "role": "user",
      "content": "Please test the gateway connectivity for me."
    }
  ],
  "stream": false,
  "temperature": 0.7
}
```

**Response**

```json
{
  "id": "msg_xxx",
  "type": "message",
  "role": "assistant",
  "model": "auto",
  "content": [
    {
      "text": "JoyToken is a governed model gateway.",
      "type": "text"
    }
  ],
  "stop_reason": "end_turn",
  "stop_sequence": null,
  "usage": {
    "input_tokens": 24,
    "output_tokens": 14
  },
  "metadata": {
    "model": "auto",
    "tier": "standard",
    "billing": {
      "credits_used": "0.2288",
      "input_tokens": 24,
      "output_tokens": 14
    }
  }
}
```

**SDK Code**

```python Messages_createAnthropicMessage_example
import requests

url = "https://api-staging.joytokens.ai/anthropic/v1/messages"

payload = {
    "model": "auto",
    "max_tokens": 1024,
    "messages": [
        {
            "role": "user",
            "content": "Please test the gateway connectivity for me."
        }
    ],
    "stream": False,
    "temperature": 0.7
}
headers = {
    "X-API-Key": "<apiKey>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Messages_createAnthropicMessage_example
const url = 'https://api-staging.joytokens.ai/anthropic/v1/messages';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"model":"auto","max_tokens":1024,"messages":[{"role":"user","content":"Please test the gateway connectivity for me."}],"stream":false,"temperature":0.7}'
};

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

```go Messages_createAnthropicMessage_example
package main

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

func main() {

	url := "https://api-staging.joytokens.ai/anthropic/v1/messages"

	payload := strings.NewReader("{\n  \"model\": \"auto\",\n  \"max_tokens\": 1024,\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"content\": \"Please test the gateway connectivity for me.\"\n    }\n  ],\n  \"stream\": false,\n  \"temperature\": 0.7\n}")

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

	req.Header.Add("X-API-Key", "<apiKey>")
	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 Messages_createAnthropicMessage_example
require 'uri'
require 'net/http'

url = URI("https://api-staging.joytokens.ai/anthropic/v1/messages")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"auto\",\n  \"max_tokens\": 1024,\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"content\": \"Please test the gateway connectivity for me.\"\n    }\n  ],\n  \"stream\": false,\n  \"temperature\": 0.7\n}"

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

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

HttpResponse<String> response = Unirest.post("https://api-staging.joytokens.ai/anthropic/v1/messages")
  .header("X-API-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"auto\",\n  \"max_tokens\": 1024,\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"content\": \"Please test the gateway connectivity for me.\"\n    }\n  ],\n  \"stream\": false,\n  \"temperature\": 0.7\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-staging.joytokens.ai/anthropic/v1/messages', [
  'body' => '{
  "model": "auto",
  "max_tokens": 1024,
  "messages": [
    {
      "role": "user",
      "content": "Please test the gateway connectivity for me."
    }
  ],
  "stream": false,
  "temperature": 0.7
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-Key' => '<apiKey>',
  ],
]);

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

```csharp Messages_createAnthropicMessage_example
using RestSharp;

var client = new RestClient("https://api-staging.joytokens.ai/anthropic/v1/messages");
var request = new RestRequest(Method.POST);
request.AddHeader("X-API-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"model\": \"auto\",\n  \"max_tokens\": 1024,\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"content\": \"Please test the gateway connectivity for me.\"\n    }\n  ],\n  \"stream\": false,\n  \"temperature\": 0.7\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Messages_createAnthropicMessage_example
import Foundation

let headers = [
  "X-API-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "model": "auto",
  "max_tokens": 1024,
  "messages": [
    [
      "role": "user",
      "content": "Please test the gateway connectivity for me."
    ]
  ],
  "stream": false,
  "temperature": 0.7
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api-staging.joytokens.ai/anthropic/v1/messages")! 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()
```