Nano-GPT API Documentation

https://docs.nano-gpt.com
Admin
Nano-GPT provides an API for generating text, images, and video using various AI models, including...
Tokens:525,182
Snippets:3,586
Trust Score:7.4
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Start OpenCode

Source: https://docs.nano-gpt.com/integrations/opencode

After setup, run this command to start OpenCode.

```bash
opencode

```

--------------------------------

### Run the OAuth Local App Example

Source: https://docs.nano-gpt.com/api-reference/miscellaneous/oauth-pkce

Commands to run the local OAuth example. The example starts a localhost callback server, generates PKCE, sends the user to /auth, exchanges the code at /api/v1/auth/keys, calls /api/v1/models, and masks the key in terminal output.

```text
examples/oauth-local-app
```

```text
https://github.com/Nano-GPT-com/nanogpt/tree/main/examples/oauth-local-app
```

```bash
node examples/oauth-local-app/oauth-local-app.mjs
```

```bash
NANOGPT_BASE_URL=http://localhost:3000 node examples/oauth-local-app/oauth-local-app.mjs
```

--------------------------------

### Go example

Source: https://docs.nano-gpt.com/api-reference/endpoint/usage

Uses the net/http package to send a GET request to the usage endpoint. Prints the response body.

```go
package main

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

func main() {

	url := "https://api.nano-gpt.com/api/v1/usage?group_by=day%2Cmodel&scope=current_key"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
```

--------------------------------

### Install and Start Codex CLI

Source: https://docs.nano-gpt.com/integrations/codex-cli

Commands to install the Codex CLI globally via npm and initialize it in your project directory.

```bash
# Install Codex CLI
npm install -g @openai/codex

# Navigate to your project
cd your-awesome-project

# Start Codex
codex
```

--------------------------------

### Cursor Guided Installation Command

Source: https://docs.nano-gpt.com/integrations/claude-code

Enter this command in Cursor to guide you through the installation of Claude Code if you are not familiar with npm.

```text
https://docs.anthropic.com/en/docs/claude-code/overview Help me install Claude Code

```

--------------------------------

### Run NanoGPT MCP server with npx

Source: https://docs.nano-gpt.com/api-reference/miscellaneous/mcp-server

Starts the NanoGPT MCP server directly using npx. Requires Node.js to be installed.

```bash
npx @nanogpt/mcp
```

--------------------------------

### Run Python TEE Verification Example

Source: https://docs.nano-gpt.com/api-reference/tee-verification

Runs the Python TEE verification example script. Requires the script to be saved as test_tee.py and the eth_account package installed.

```bash
python3 test_tee.py --api-key YOUR_API_KEY --base-url https://nano-gpt.com --model TEE/llama-3.3-70b-instruct
```

--------------------------------

### Go example for TEE attestation

Source: https://docs.nano-gpt.com/api-reference/endpoint/tee-attestation

Uses the net/http package to send a GET request to the TEE attestation endpoint. Prints the response body.

```go
package main

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

func main() {

	url := "https://api.nano-gpt.com/v1/tee/attestation"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
```

--------------------------------

### Response from /api/cli-login/start

Source: https://docs.nano-gpt.com/integrations/cli-login

Example response from the start endpoint. The device_code is secret and must not be displayed; user_code is shown on the approval page. verification_uri_complete is the full URL to display to the user. expires_in is 600 seconds (10 minutes) and interval is the recommended polling interval in seconds.

```json
{
  "device_code": "0Reyai4sGnBE8em8lMLRxDhC-XtQMC2obf8hnVDUWws",
  "user_code": "VS8Q-ZY3Q",
  "verification_uri": "https://nano-gpt.com/cli-login/verify",
  "verification_uri_complete": "https://nano-gpt.com/cli-login/verify?code=VS8Q-ZY3Q",
  "expires_in": 600,
  "interval": 2
}

```

--------------------------------

### Run One-Click Setup Script

Source: https://docs.nano-gpt.com/integrations/codex-cli

Executes a shell script to automate API key entry, configuration file creation, and environment variable setup.

```bash
curl -O "https://nano-gpt.com/install/codex_nanogpt.sh" && bash ./codex_nanogpt.sh
```

--------------------------------

### Example GET response for provider preferences

Source: https://docs.nano-gpt.com/api-reference/miscellaneous/provider-selection

Example response from the GET endpoint showing the structure of saved provider preferences, including preferredProviders, excludedProviders, enableFallback, modelOverrides, and availableProviders.

```json
{
  "preferredProviders": ["provider-a", "provider-b"],
  "excludedProviders": ["provider-c"],
  "enableFallback": true,
  "modelOverrides": {
    "model-id": {
      "preferredProviders": ["provider-b"],
      "enableFallback": false
    }
  },
  "availableProviders": ["provider-a", "provider-b", "provider-c"]
}
```

--------------------------------

### GET /api/v1/images/models

Source: https://docs.nano-gpt.com/api-reference/endpoint/image-api-models

Documentation for the GET /api/v1/images/models endpoint, including authentication, response structure, and example.

```APIDOC
## GET /api/v1/images/models

### Description
Discovers image models for the dedicated Image API. The response includes model IDs, capabilities, supported parameters, streaming support, and a model-specific endpoint metadata URL. Model availability and supported parameters can change, so build clients from the returned metadata instead of hardcoding model capability tables.

### Method
GET

### Endpoint
/api/v1/images/models

### Authentication
Optional. Use either:
- `Authorization: Bearer YOUR_API_KEY`
- `x-api-key: YOUR_API_KEY`

### Response
#### Success Response (200)
- **object** (string) - Always `"list"`.
- **data** (array) - List of image model objects.
  - **id** (string) - Unique model identifier.
  - **name** (string) - Human-readable model name.
  - **description** (string) - Model description.
  - **created** (integer) - Unix timestamp of model creation.
  - **owned_by** (string) - Owner of the model.
  - **architecture** (object) - Model architecture details.
    - **input_modalities** (array of strings) - Supported input modalities (e.g., `"text"`, `"image"`).
    - **output_modalities** (array of strings) - Supported output modalities (e.g., `"image"`).
  - **supported_parameters** (object) - Supported generation parameters.
    - **resolution** (object) - Resolution parameter definition.
      - **type** (string) - Parameter type (e.g., `"enum"`).
      - **values** (array of strings) - Allowed values (e.g., `["1k", "2k", "4k"]`).
      - **default** (string) - Default value.
    - **n** (object) - Number of images parameter definition.
      - **type** (string) - Parameter type (e.g., `"range"`).
      - **min** (integer) - Minimum value.
      - **max** (integer) - Maximum value.
      - **default** (integer) - Default value.
  - **supports_streaming** (boolean) - Whether streaming is supported.
  - **endpoints** (string) - URL to model-specific endpoint metadata.
  - **capabilities** (object) - Model capabilities.
    - **image_generation** (boolean) - Whether image generation is supported.
    - **image_to_image** (boolean) - Whether image-to-image is supported.
    - **inpainting** (boolean) - Whether inpainting is supported.
    - **nsfw** (boolean) - Whether NSFW content is supported.
  - **category** (string) - Model category (e.g., `"image"`).
- **meta** (object) - Response metadata.
  - **count** (integer) - Number of models returned.
  - **generated_at** (string) - Timestamp of response generation.

#### Response Example
```json
{
  "object": "list",
  "data": [
    {
      "id": "openai/gpt-image-2.5/flare/text-to-image",
      "name": "GPT Image 2.5 Flare",
      "description": "Model description...",
      "created": 1760000000,
      "owned_by": "openai",
      "architecture": {
        "input_modalities": ["text", "image"],
        "output_modalities": ["image"]
      },
      "supported_parameters": {
        "resolution": {
          "type": "enum",
          "values": ["1k", "2k", "4k"],
          "default": "1k"
        },
        "n": {
          "type": "range",
          "min": 1,
          "max": 4,
          "default": 1
        }
      },
      "supports_streaming": false,
      "endpoints": "/api/v1/images/models/openai/gpt-image-2.5/flare/text-to-image/endpoints",
      "capabilities": {
        "image_generation": true,
        "image_to_image": true,
        "inpainting": false,
        "nsfw": false
      },
      "category": "image"
    }
  ],
  "meta": {
    "count": 201,
    "generated_at": "2026-06-25T00:00:00.000Z"
  }
}
```
```

--------------------------------

### GET /api/v1/moderation-models

Source: https://docs.nano-gpt.com/api-reference/endpoint/moderation-models

Documentation for the GET /api/v1/moderation-models endpoint, including authentication, query parameters, examples, and response schemas.

```APIDOC
## GET /api/v1/moderation-models

### Description
Lists the moderation models currently available to your account. The response includes model capabilities, context limits, and pricing. Model availability and capabilities can change over time. Use this endpoint as the source of truth before choosing a model for `POST /api/v1/moderations` or Inline Moderation.

### Method
GET

### Endpoint
`https://api.nano-gpt.com/api/v1/moderation-models`

### Authentication
An API key is required.
- `Authorization: Bearer YOUR_API_KEY`
- `x-api-key: YOUR_API_KEY`

### Query Parameters
- **detailed** (boolean) - Optional - Default: `true` - When `false`, returns a compact OpenAI-style model list.

### Request Example
```
curl https://api.nano-gpt.com/api/v1/moderation-models \
  -H "Authorization: Bearer $NANOGPT_API_KEY"
```

```
curl "https://api.nano-gpt.com/api/v1/moderation-models?detailed=false" \
  -H "Authorization: Bearer $NANOGPT_API_KEY"
```

### Response
#### Success Response (200)
- **object** (string) - The object type, e.g., `"list"`.
- **data** (array) - List of moderation model objects.
  - **id** (string) - The model identifier.
  - **object** (string) - The object type, e.g., `"model"`.
  - **created** (integer) - Unix timestamp of model creation.
  - **owned_by** (string) - The owner of the model.
  - **context_length** (integer) - The context length in tokens.
  - **capabilities** (object) - Model capabilities.
    - **text** (boolean) - Whether text input is supported.
    - **image** (boolean) - Whether image input is supported.
    - **batch** (boolean) - Whether batch processing is supported.
  - **pricing** (object) - Pricing information.
    - **prompt** (number) - Price per million tokens for prompt.
    - **completion** (number) - Price per million tokens for completion.
    - **currency** (string) - Currency code.
    - **unit** (string) - Pricing unit, e.g., `"per_million_tokens"`.

#### Response Example
```
{
  "object": "list",
  "data": [
    {
      "id": "moderation-model-id",
      "object": "model",
      "created": 1704067200,
      "owned_by": "model-owner",
      "context_length": 128000,
      "capabilities": {
        "text": true,
        "image": true,
        "batch": true
      },
      "pricing": {
        "prompt": 0.1,
        "completion": 0,
        "currency": "USD",
        "unit": "per_million_tokens"
      }
    }
  ]
}
```

#### Error Response (400)
- **error** (object) - Error details.
  - **message** (string) - Error message.
  - **type** (string) - Error type.
  - **code** (string) - Error code.
  - **param** (string) - The parameter that caused the error.

#### Error Response Example
```
{
  "error": {
    "message": "Invalid request parameters. Please check your input and try again.",
    "type": "invalid_request_error",
    "code": "unsupported_input_modality",
    "param": "input"
  }
}
```
```

--------------------------------

### One-Click Setup Command

Source: https://docs.nano-gpt.com/integrations/opencode

Run this command in your terminal to automatically set up OpenCode with NanoGPT. It opens your browser for authentication (or lets you paste an API key), configures OpenCode to use NanoGPT as the AI provider, and sets up popular models like Claude Sonnet 5, Claude Opus 5.5, GPT 5.6 Sol, Gemini Flash Latest, Gemini Pro Latest, and GLM 5.3.

```bash
curl -fsSL "https://nano-gpt.com/install/opencode_nanogpt.sh" | bash

```

--------------------------------

### OpenAI Models - Multiple Formats and Instructions (Python)

Source: https://docs.nano-gpt.com/api-reference/endpoint/tts

Demonstrates text_to_speech calls with different models, voices, instructions, and response formats. Includes high-definition, ultra-low cost, and format iteration examples.

```Python
# High-definition with voice instructions
text_to_speech(
    text="Welcome to customer service.",
    model="tts-1-hd",
    voice="nova",
    instructions="Speak warmly and professionally like a customer service representative",
    response_format="flac"
)

# Ultra-low cost option
text_to_speech(
    text="This is a cost-effective option.",
    model="gpt-4o-mini-tts",
    voice="alloy",
    instructions="Speak clearly and cheerfully",
    response_format="mp3"
)

# Different format examples
formats = ["mp3", "wav", "opus", "flac", "aac"]
for fmt in formats:
    text_to_speech(
        text=f"This is {fmt.upper()} format.",
        model="tts-1",
        voice="echo",
        response_format=fmt
    )

```

--------------------------------

### Install Codex CLI via Cursor

Source: https://docs.nano-gpt.com/integrations/codex-cli

Use this command within the Cursor editor to trigger the guided installation process.

```text
https://developers.openai.com/codex/cli/ Help me install Codex CLI
```

--------------------------------

### Set API key and launch LiteLLM

Source: https://docs.nano-gpt.com/integrations/litellm

Set the NANO_GPT_API_KEY environment variable and start the LiteLLM service using the configuration file.

```bash
export NANO_GPT_API_KEY='your-api-key-here'
litellm --config litellm.yaml
```

--------------------------------

### 200 Response Body for GET /api/generate-video/content

Source: https://docs.nano-gpt.com/api-reference/endpoint/video-content

Example of a successful response body (HTTP 200) for the GET /api/generate-video/content endpoint. The response is an empty JSON object.

```json
{}
```

--------------------------------

### One-Click Setup Script for NanoGPT

Source: https://docs.nano-gpt.com/integrations/claude-code

Downloads and runs the NanoGPT setup script for Claude Code. The script prompts for your API key and configures ~/.claude/settings.json.

```bash
curl -O "https://nano-gpt.com/install/claude_code_nanogpt.sh" && bash ./claude_code_nanogpt.sh

```

--------------------------------

### Install Claude Code via npm

Source: https://docs.nano-gpt.com/integrations/claude-code

Prerequisites: Node.js 18 or newer. Installs Claude Code globally, navigates to your project, and starts Claude Code.

```bash
# Install Claude Code
npm install -g @anthropic-ai/claude-code

# Navigate to your project
cd your-awesome-project

# Start Claude Code
claude

```

--------------------------------

### Install NanoGPT-client with yarn

Source: https://docs.nano-gpt.com/api-reference/miscellaneous/typescript

Install the package using yarn.

```bash
yarn add nanogpt-client

```

--------------------------------

### Install NanoGPT-client with npm

Source: https://docs.nano-gpt.com/api-reference/miscellaneous/typescript

Install the package via npm.

```bash
npm install nanogpt-client

```

--------------------------------

### GET /auth.md

Source: https://docs.nano-gpt.com/api-reference/miscellaneous/oauth-pkce

Fetches the machine-facing authentication guide for NanoGPT OAuth PKCE.

```APIDOC
## GET /auth.md

### Description
Retrieves the machine-facing authentication guide for NanoGPT OAuth PKCE.

### Method
GET

### Endpoint
/auth.md

### Host
nano-gpt.com

### Response
#### Success Response (200)
- **body** (string) - The authentication guide content in markdown format.
```

--------------------------------

### Go example for YouTube transcribe

Source: https://docs.nano-gpt.com/api-reference/endpoint/youtube-transcribe

Uses net/http to send a POST request with a JSON body containing YouTube URLs. Prints the response body.

```go
package main

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

func main() {

	url := "https://api.nano-gpt.com/api/youtube-transcribe"

	payload := strings.NewReader("{\n  \"urls\": [\n    \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\",\n    \"https://youtu.be/kJQP7kiw5Fk\"\n  ]\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
```

--------------------------------

### Start Gemini CLI

Source: https://docs.nano-gpt.com/integrations/gemini-cli

Launch the CLI from the gemini-cli directory.

```bash
npm start
```

--------------------------------

### Canonical Endpoint Examples

Source: https://docs.nano-gpt.com/api-reference/endpoint/models

Examples for the canonical endpoint GET /api/v1/models. The first fetches the default list; the second adds detailed metadata. Both use the Authorization header.

```bash
curl -H "Authorization: Bearer $NANOGPT_API_KEY" \
  https://api.nano-gpt.com/api/v1/models

```

```bash
curl -H "Authorization: Bearer $NANOGPT_API_KEY" \
  "https://api.nano-gpt.com/api/v1/models?detailed=true"

```

--------------------------------

### Go Request Example

Source: https://docs.nano-gpt.com/api-reference/endpoint/responses

Example of how to send a POST request to the responses endpoint using the Go standard library.

```go
package main

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

func main() {

	url := "https://api.nano-gpt.com/api/v1/responses"

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"input\": \"<string>\",\n  \"billing_mode\": \"<string>\",\n  \"billingMode\": \"<string>\",\n  \"instructions\": \"<string>\",\n  \"max_output_tokens\": 17,\n  \"temperature\": 1,\n  \"top_p\": 0.5,\n  \"tools\": [\n    {\n      \"max_results\": 5\n    }\n  ],\n  \"tool_choice\": \"<string>\",\n  \"parallel_tool_calls\": true,\n  \"stream\": false,\n  \"store\": false,\n  \"retention_days\": 182,\n  \"retentionDays\": 182,\n  \"previous_response_id\": \"<string>\",\n  \"reasoning\": {},\n  \"text\": {},\n  \"metadata\": {},\n  \"user\": \"<string>\",\n  \"seed\": 123,\n  \"background\": true\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(string(body))

}
```

--------------------------------

### Paid/Extras Endpoint Examples

Source: https://docs.nano-gpt.com/api-reference/endpoint/models

Examples for the paid/extras endpoint GET /api/paid/v1/models. Returns only models that are NOT part of the subscription. Supports ?detailed=true and API key–aware pricing metadata.

```bash
curl https://api.nano-gpt.com/api/paid/v1/models

```

```bash
curl -H "Authorization: Bearer $NANOGPT_API_KEY" \
  "https://api.nano-gpt.com/api/paid/v1/models?detailed=true"

```

--------------------------------

### Text and Format Configuration Example

Source: https://docs.nano-gpt.com/api-reference/endpoint/responses

Example of configuring the text format and verbosity level for a model response.

```json
{
  "model": "openai/gpt-5.6-sol",
  "input": "List 3 colors",
  "text": {
    "format": { "type": "json_object" },
    "verbosity": "medium"
  }
}
```

--------------------------------

### Create a dataset

Source: https://docs.nano-gpt.com/api-reference/evals

Initializes a new evaluation dataset with input-output pairs and metadata.

```bash
curl -X POST "https://api.nano-gpt.com/api/v1/evals/datasets" \
  -H "Authorization: Bearer $NANOGPT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Support QA",
    "items": [
      {
        "input": "Explain API rate limits to a non-technical founder.",
        "expected_output": "Mentions quotas, retry behavior, and practical next steps.",
        "metadata": { "topic": "api" }
      }
    ]
  }'
```

--------------------------------

### GET /tts/status

Source: https://docs.nano-gpt.com/api-reference/endpoint/tts-status

Documentation for the TTS status endpoint, including response examples for pending, completed, and error states.

```APIDOC
## GET /tts/status

### Description
Retrieves the status of a text-to-speech (TTS) generation job. Poll this endpoint until it returns `completed` for async models.

### Method
GET

### Endpoint
/tts/status

### Parameters
#### Query Parameters
- **runId** (string) - Required - The unique identifier of the TTS job.

### Response
#### Success Response (200)
- **status** (string) - The current status of the job: `pending`, `completed`, or `error`.
- **runId** (string) - The unique identifier of the job (present when status is `pending`).
- **queuePosition** (integer) - The position in the queue (present when status is `pending`).
- **audioUrl** (string) - The URL to download or play the generated audio (present when status is `completed`).
- **contentType** (string) - The MIME type of the audio file (present when status is `completed`).
- **model** (string) - The model used for generation (present when status is `completed`).
- **error** (string) - Error message (present when status is `error`).
- **code** (string) - Error code, e.g., `CONTENT_POLICY_VIOLATION` (present for content policy errors).

#### Response Example
```json
{
  "status": "pending",
  "runId": "98b0d593-fe8d-49b8-89c9-233022232297",
  "queuePosition": 3
}
```

### Notes
- For Elevenlabs-family async models (e.g., `Elevenlabs-Turbo-V2.5`, `Elevenlabs-V3`) you will always poll this endpoint until it returns `completed`.
- When the job completes, the response includes an `audioUrl` you can download or play in the browser.
- If available, include `cost`, `paymentSource`, and `isApiRequest` from the original ticket while polling to improve refund handling.
```

--------------------------------

### Final chunk with usage and x_nanogpt_pricing

Source: https://docs.nano-gpt.com/api-reference/miscellaneous/streaming-protocol

Example final chunk with usage and x_nanogpt_pricing. Clients must tolerate additional fields and ignore unknown keys.

```json
{
  "id": "chatcmpl_x",
  "object": "chat.completion.chunk",
  "created": 1772346058,
  "model": "gpt-5.1",
  "choices": [{ "index": 0, "delta": {}, "finish_reason": "stop" }],
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 20,
    "total_tokens": 143,
    "prompt_tokens_details": { "cached_tokens": 123, "audio_tokens": 0 },
    "completion_tokens_details": {
      "reasoning_tokens": 12,
      "audio_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    },
    "cache_creation_input_tokens": 123,
    "cache_read_input_tokens": 123
  },
  "x_nanogpt_pricing": {
    "cost": 0.000169,
    "inputTokens": 9,
    "outputTokens": 20,
    "cacheCost": 0,
    "paymentSource": "USD",
    "billedToTeam": false,
    "billedTeamId": null,
    "billedTeamName": null
  }
}

```

--------------------------------

### List Image Models with GET /api/v1/images/models

Source: https://docs.nano-gpt.com/api-reference/endpoint/image-api-models

Send a GET request to the List Image Models endpoint. The response contains the list of available image models. Each example uses the same endpoint and method, differing only in the client library or language.

```bash
curl --request GET \
  --url https://api.nano-gpt.com/api/v1/images/models
```

```python
import requests

url = "https://api.nano-gpt.com/api/v1/images/models"

response = requests.get(url)

print(response.text)
```

```javascript
const options = {method: 'GET'};

fetch('https://api.nano-gpt.com/api/v1/images/models', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nano-gpt.com/api/v1/images/models",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

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

func main() {

	url := "https://api.nano-gpt.com/api/v1/images/models"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("https://api.nano-gpt.com/api/v1/images/models")
  .asString();
```

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

url = URI("https://api.nano-gpt.com/api/v1/images/models")

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

request = Net::HTTP::Get.new(url)

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

--------------------------------

### Get Allowed Models Response (All Allowed)

Source: https://docs.nano-gpt.com/api-reference/teams

Example response when all models are allowed. The allowed_models field is null and all_allowed is true.

```json
{
  "allowed_models": null,
  "all_allowed": true
}
```

--------------------------------

### Binary Response Example (OpenAI Models)

Source: https://docs.nano-gpt.com/api-reference/endpoint/tts

OpenAI models return audio data directly as binary with appropriate headers, as shown in this example.

```http
Content-Type: audio/mp3
Content-Length: 123456
[Binary audio data]
```

--------------------------------

### High-Spend Text Discount Response

Source: https://docs.nano-gpt.com/api-reference/teams

Example response from GET /api/teams/{teamUuid} when a team qualifies for the high-spend text discount.

```json
{
  "team": {
    "high_spend_text_discount": true
  }
}

```

--------------------------------

### Create Memory with Go

Source: https://docs.nano-gpt.com/api-reference/endpoint/memory

Go example using net/http to POST a JSON payload to the memory endpoint. Sets Authorization and Content-Type headers and prints the response body.

```go
package main

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

func main() {

	url := "https://api.nano-gpt.com/api/v1/memory"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ],\n  \"expiration_days\": 30,\n  \"model_context_limit\": 128000\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(string(body))

}

```

--------------------------------

### Device login flow implementation

Source: https://docs.nano-gpt.com/integrations/cli-login

A Python example demonstrating the device login flow to authenticate a CLI application with NanoGPT.

```python
import time
import requests

def nanogpt_login(client_name="my-cli-app"):
    """Authenticate with NanoGPT using device login flow."""
    start_response = requests.post(
        "https://nano-gpt.com/api/cli-login/start",
        json={"client_name": client_name}
    )
    start_data = start_response.json()

    device_code = start_data["device_code"]
    verification_url = start_data["verification_uri_complete"]
    interval = start_data["interval"]

    print("\nTo authenticate, open this URL in your browser:\n")
    print(f"  {verification_url}\n")
    print("Waiting for approval...")

    while True:
        poll_response = requests.post(
            "https://nano-gpt.com/api/cli-login/poll",
            json={"device_code": device_code}
        )

        if poll_response.status_code == 200:
            poll_data = poll_response.json()
            if poll_data.get("status") == "approved":
                print("\nAuthentication successful!")
                return poll_data["key"]

        elif poll_response.status_code == 410:
            raise Exception("Login expired. Please try again.")

        time.sleep(interval)

api_key = nanogpt_login("my-awesome-cli")
print(f"API Key: {api_key}")
```

--------------------------------

### Start Codex CLI with a Specific Model

Source: https://docs.nano-gpt.com/integrations/codex-cli

Use the --model flag to specify a model directly, for example openai/gpt-5.6-sol.

```bash
codex --model openai/gpt-5.6-sol
```

--------------------------------

### Java Unirest example

Source: https://docs.nano-gpt.com/api-reference/endpoint/usage

Uses the Unirest library to send a GET request to the usage endpoint. Returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://api.nano-gpt.com/api/v1/usage?group_by=day%2Cmodel&scope=current_key")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### OpenAI with instructions

Source: https://docs.nano-gpt.com/api-reference/text-to-speech

Uses the tts-1-hd model with instructions and response_format set to flac.

```python
result = tts.synthesize(
    "Welcome to our premium service.",
    model="tts-1-hd",
    voice="nova",
    instructions="Speak like a luxury brand representative",
    response_format="flac",
    output_file="premium.flac"
)
```

--------------------------------

### Python requests example

Source: https://docs.nano-gpt.com/api-reference/endpoint/usage

Uses the requests library to perform a GET request to the usage endpoint. Prints the response text.

```python
import requests

url = "https://api.nano-gpt.com/api/v1/usage?group_by=day%2Cmodel&scope=current_key"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Go net/http POST to Direct Web Search API

Source: https://docs.nano-gpt.com/api-reference/endpoint/web-search

Go example using the standard net/http package to POST to the Direct Web Search API. It builds the JSON payload as a string, sets the Content-Type header, and prints the response body. Error handling is omitted for brevity.

```go
package main

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

func main() {

	url := "https://api.nano-gpt.com/api/web"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"operation\": \"<string>\",\n  \"depth\": \"<string>\",\n  \"outputType\": \"<string>\",\n  \"structuredOutputSchema\": \"<string>\",\n  \"includeImages\": true,\n  \"fromDate\": \"<string>\",\n  \"toDate\": \"<string>\",\n  \"includeDomains\": [\n    \"<string>\"\n  ],\n  \"excludeDomains\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
```

--------------------------------

### GET /api/get-nano-price response

Source: https://docs.nano-gpt.com/api-reference/endpoint/crypto-deposits

Example JSON response from the NANO price endpoint, showing the trading pair and latest price.

```json
// GET /api/get-nano-price
{
  "pair": "NANOUSD",
  "latestPrice": 1.23
}
```

--------------------------------

### GET /api/v1/images/models response

Source: https://docs.nano-gpt.com/api-reference/endpoint/image-api-models

Example response from GET /api/v1/images/models. Shows model metadata including ID, capabilities, supported parameters, streaming support, and endpoint URL. Note that model availability and parameters can change; build clients from this metadata.

```json
{
  "object": "list",
  "data": [
    {
      "id": "openai/gpt-image-2.5/flare/text-to-image",
      "name": "GPT Image 2.5 Flare",
      "description": "Model description...",
      "created": 1760000000,
          "owned_by": "openai",
      "architecture": {
        "input_modalities": ["text", "image"],
        "output_modalities": ["image"]
      },
      "supported_parameters": {
        "resolution": {
          "type": "enum",
          "values": ["1k", "2k", "4k"],
          "default": "1k"
        },
        "n": {
          "type": "range",
          "min": 1,
          "max": 4,
          "default": 1
        }
      },
      "supports_streaming": false,
      "endpoints": "/api/v1/images/models/openai/gpt-image-2.5/flare/text-to-image/endpoints",
      "capabilities": {
        "image_generation": true,
        "image_to_image": true,
        "inpainting": false,
        "nsfw": false
      },
      "category": "image"
    }
  ],
  "meta": {
    "count": 201,
    "generated_at": "2026-06-25T00:00:00.000Z"
  }
}
```

--------------------------------

### POST /api/cli-login/start

Source: https://docs.nano-gpt.com/integrations/cli-login

Starts the CLI login flow. Returns a `device_code` and a verification URL that the user must visit to approve the login.

```APIDOC
## POST /api/cli-login/start

### Description
Starts the CLI login flow. Returns a `device_code` and a verification URL that the user must visit to approve the login.

### Method
POST

### Endpoint
/api/cli-login/start

### Parameters
#### Request Body
- **client_name** (string) - Required - A name for the CLI client. Used to name the API key as `CLI (<client_name>)` in the user's account. If the same `client_name` is used multiple times, the existing key is reused.

### Response
#### Success Response (200)
- **device_code** (string) - The code the user must enter on the verification page.
- **verification_url** (string) - The URL the user must visit to approve the login.

### Response Example
{
  "device_code": "example-device-code",
  "verification_url": "https://nano-gpt.com/cli-login/verify?code=..."
}

### Error Handling
- **User does not approve in time**: Codes expire after 10 minutes. Restart the flow.
- **Invalid `device_code`**: Check you are using the exact code from `/start`.
- **Rate limited**: 10 requests per minute per IP. Use the recommended interval.
```

--------------------------------

### NanoGPT Authorization URL Example

Source: https://docs.nano-gpt.com/api-reference/miscellaneous/oauth-pkce

An example of a fully constructed authorization URL with query parameters.

```text
https://nano-gpt.com/auth?callback_url=http%3A%2F%2F127.0.0.1%3A8787%2Fcallback&code_challenge=...&code_challenge_method=S256&scope=api.use%20models.read&state=...&client_name=My%20Local%20App
```

--------------------------------

### Create ~/.codex/config.toml Configuration

Source: https://docs.nano-gpt.com/integrations/codex-cli

Manual configuration file setup for NanoGPT. Ensure wire_api is set to "responses" for current Codex CLI compatibility.

```toml
model_provider = "nanogpt"
model = "openai/gpt-5.6-sol"

[model_providers.nanogpt]
name = "NanoGPT"
base_url = "https://api.nano-gpt.com/api/v1"
env_key = "NANOGPT_API_KEY"
wire_api = "responses"
```

--------------------------------

### nanogpt_youtube_transcribe request example

Source: https://docs.nano-gpt.com/integrations/mcp

Get transcripts from YouTube videos. The `urls` array is required and limited to 10 URLs per request.

```json
{
  "urls": ["https://www.youtube.com/watch?v=dQw4w9WgXcQ"]
}
```

--------------------------------

### PHP cURL example

Source: https://docs.nano-gpt.com/api-reference/endpoint/usage

Uses PHP cURL to perform a GET request to the usage endpoint. Handles errors and prints the response.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nano-gpt.com/api/v1/usage?group_by=day%2Cmodel&scope=current_key",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Initialize NanoGPTTTS client

Source: https://docs.nano-gpt.com/api-reference/text-to-speech

Creates a NanoGPTTTS instance with your API key.

```python
tts = NanoGPTTTS("YOUR_API_KEY")
```
Tokens:
Raw