Skip to content
Nurseshark

Create a project

POST
/api/projects
curl --request POST \
  --url https://app.nurseshark.org/api/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "name_theme": "example", "summary": "example", "description": "example", "status": "idea", "tags": [ "example" ], "repo_url": "example", "url": "example" }'

Records a new project. It gets a random color, and favicon_svg is a square in that color. Fails with 422 if the name is taken or the account is at its project limit.

Same as the create_project MCP tool.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required

Display name, e.g. “Hammerhead”. Stored lowercase with hyphens between words. Must be unique among the user’s projects.

string
<= 64 characters
name_theme

Theme the name came from, if it came from suggest_names.

string
<= 100 characters
summary

One line saying what the project does, e.g. “CLI that renames photos by EXIF date”.

string
<= 280 characters
description

A few paragraphs of plain text: purpose, how it works, stack, how to run it.

string
<= 4096 characters
status

Defaults to active.

string
Allowed values: idea active paused shipped archived
tags

Short lowercase labels such as language, framework, or area (e.g. rails, cli, home-automation).

Array<string>
<= 20 items
repo_url

Http(s) URL of the source repository.

string
<= 2000 characters
url

Http(s) URL where the project is deployed or documented.

string
<= 2000 characters

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
project
required
object
uuid
required

Globally unique and never changes, even when the project is renamed.

string format: uuid
name
required

Lowercase with hyphens between words, e.g. whale-shark.

string
slug
required

Unique among the account’s projects. Use it, the name or the UUID to look the project up.

string
summary

One line saying what the project does, e.g. “CLI that renames photos by EXIF date”.

string
<= 280 characters
description

A few paragraphs of plain text: purpose, how it works, stack, how to run it.

string
<= 4096 characters
status
required

Defaults to active.

string
Allowed values: idea active paused shipped archived
tags
required

Short lowercase labels such as language, framework, or area (e.g. rails, cli, home-automation).

Array<string>
<= 20 items
repo_url

Http(s) URL of the source repository.

string
<= 2000 characters
url

Http(s) URL where the project is deployed or documented.

string
<= 2000 characters
name_theme

The theme the name came from, if one was given when the project was created.

string
color
required

Picked at random when the project is created.

string
/^#[0-9a-f]{6}$/
favicon_svg
required

An SVG square in the project’s color, to use as its favicon.

string
created_at
required
string format: date-time
updated_at
required
string format: date-time
recent_notes

Newest first. Only from getting one project, which includes 10 unless notes says otherwise.

Array<object>
object
body
required
string
created_at
required
string format: date-time

Example 

{
  "project": {
    "status": "idea"
  }
}

401

Section titled “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

Section titled “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

Section titled “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"
    ]
  }
}