Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nano-gpt.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Characters are reusable AI personas with a base model, system prompt, optional first message, tags, content rating, and visibility controls. The website uses these same endpoints for importing, publishing, browsing, rating, and adapting character cards.

​
Authentication

Use either header for private writes:
  • Authorization: Bearer YOUR_API_KEY
  • x-api-key: YOUR_API_KEY
Public catalog reads do not require authentication. Private reads and writes require the owning session or API key.

​
List Public Characters

GET https://nano-gpt.com/api/v1/characters
Query parameters:
FieldTypeDescription
qstringSearch name, summary, and description
tagsstring or repeated stringFilter by one or more tag slugs
content_rating_maxstringsfw, suggestive, nsfw, or explicit
sortstringnew, top_rated, or trending_simple
cursorstringPagination cursor from the previous response
limitnumberPage size
Only approved public characters are returned.

​
Create Character

POST https://nano-gpt.com/api/v1/characters

{
  "name": "Helpful Guide",
  "summary": "A concise assistant for technical writing",
  "description": "Helps plan, edit, and tighten technical docs.",
  "base_model_id": "deepseek-ai/DeepSeek-V3-0324",
  "system_prompt": "You are a concise technical writing assistant.",
  "first_message": "What are we editing today?",
  "visibility": "private",
  "allow_api": false,
  "creator_content_rating": "sfw",
  "tags": ["writing", "productivity"]
}
Visibility values:
ValueBehavior
privateOnly the owner can see and use it
unlistedUsable by direct ID or slug when permitted, not listed publicly
publicSubmitted to moderation before public discovery
Public submissions are created with moderation_status: pending and become discoverable only after approval.

​
Manage Your Characters

GET /api/v1/characters/mine
GET /api/v1/characters/{idOrSlug}
PATCH /api/v1/characters/{idOrSlug}
DELETE /api/v1/characters/{idOrSlug}
DELETE archives the character instead of hard-deleting it. PATCH accepts the same core fields as create. Editing an approved public character sends it back to pending moderation.

​
Reviews And Reports

PUT /api/v1/characters/{idOrSlug}/review
POST /api/v1/characters/{idOrSlug}/report
Review body: 
{
  "rating": 5,
  "review_text": "Optional review text with at least 10 characters."
}
Reviews require an authenticated account with either an active subscription or more than $1 in account balance. USD balance and Nano balance converted to USD both count toward this threshold. Report body: 
{
  "reason": "Policy concern",
  "details": "Optional extra context."
}

​
Runtime Usage

The Responses API accepts character_id: 
{
  "character_id": "character-uuid-or-slug",
  "input": "Introduce yourself"
}
When character_id is supplied, NanoGPT applies the character’s base model, instructions, and sampler defaults unless explicitly overridden by the request. For non-owner API usage, the character must be public, approved, and have API access enabled.