Suggest names

GET

/api/names/suggestions

curl --request GET \
  --url 'https://app.nurseshark.org/api/names/suggestions?long_names=skip' \
  --header 'Authorization: Bearer <token>'

Random names from one theme, or from every theme, leaving out names the account’s projects already use. Unlike taking the next name, this reserves nothing.

Same as the suggest_names MCP tool.

Authorizations

• token

Parameters

Query Parameters

theme

string

<= 200 characters

Theme key from list_name_themes, e.g. sharks.

count

integer

>= 1 <= 50

How many names to return. Defaults to 10.

max_length

integer

>= 3 <= 64

Longest name to hand out, in characters, before any suffix. Defaults to the user’s account setting, if any.

long_names

string

Allowed values: skip truncate

What to do with names over max_length: skip them, or truncate them to fit. Defaults to the user’s account setting.

Responses

200

OK

Media typeapplication/json

object

names

required

Array<object>

object

name

required

Lowercase with hyphens between words, with any suffix or truncation applied.

string

slug

required

string

theme

required

The key of the theme it came from.

string

remaining_in_pool

required

How many more unused names the theme (or themes) has.

integer

Example ^generated

{
  "names": [
    {
      "name": "example",
      "slug": "example",
      "theme": "example"
    }
  ],
  "remaining_in_pool": 1
}

401

The token is missing, invalid or expired.

Media typeapplication/json

object

error

required

What went wrong and what to change.

string

errors

For validation failures, the messages for each field.

object

key

additional properties

Array<string>

Example ^generated

{
  "error": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

422

The request was understood but can’t be done, for example a value over its limit or a name already in use. error says what to change.

Media typeapplication/json

object

error

required

What went wrong and what to change.

string

errors

For validation failures, the messages for each field.

object

key

additional properties

Array<string>

Example ^generated

{
  "error": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

429

Over the rate limit. Try again in a minute.

Media typeapplication/json

object

error

required

What went wrong and what to change.

string

errors

For validation failures, the messages for each field.

object

key

additional properties

Array<string>

Example ^generated

{
  "error": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}