Documentation

API Reference

These public API endpoints will allow external tools to fetch shared agents programmatically without coupling to the UI routes. Write operations will require personal access tokens (coming soon).

GET/api/v1/agents

List public published agents.

tagstringquery

Filter by agent tag (e.g., Persona)

authorstringquery

Filter by author handle

kindstringquery

Filter by kind ('base' or 'checkpoint')

featuredbooleanquery

Show only featured agents

limitnumberquery

Pagination limit

cursorstringquery

Pagination cursor

Array of agent items

idstring

Unique identifier for the agent

slugstring

URL-friendly agent identifier

namestring

Display name of the agent

kindstring

Either 'base' or 'checkpoint'

authorHandlestring

Handle of the creator

oneLinerstring

Short description

descriptionstring

Full markdown description

baseModelstring

The underlying foundation model

modelRefstring

Model reference string

checkpointPathstring | null

Tinker checkpoint path

tagsstring[]

Array of classification tags

featuredboolean

Whether the agent is featured

sharedboolean

Whether the agent is public

avatarStylestring

DiceBear style avatar

avatarSeedstring

Avatar generation seed

nextCursorstring | null
GET/api/v1/agents/:slug

Retrieve detailed information about a specific published agent.

slugstringpathrequired

The agent's unique slug

idstring

Unique identifier for the agent

slugstring

URL-friendly agent identifier

namestring

Display name of the agent

kindstring

Either 'base' or 'checkpoint'

authorHandlestring

Handle of the creator

oneLinerstring

Short description

descriptionstring

Full markdown description

baseModelstring

The underlying foundation model

modelRefstring

Model reference string

checkpointPathstring | null

Tinker checkpoint path

tagsstring[]

Array of classification tags

featuredboolean

Whether the agent is featured

sharedboolean

Whether the agent is public

avatarStylestring

DiceBear style avatar

avatarSeedstring

Avatar generation seed

systemPromptstring

The agent's system prompt instructions

promptstring
responsestring
helpfulnumber
notForMenumber