API Reference

Pets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Add a new pet to the store.

post/pet

Add a new pet to the store.

Body ParametersExpand Collapse

name: string

photoUrls: array of string

id: optional number

formatint64

category: optional object { id, name }

id: optional number

formatint64

name: optional string

status: optional "available" or "pending" or "sold"

pet status in the store

Accepts one of the following:

"available"

"pending"

"sold"

tags: optional array of object { id, name }

id: optional number

formatint64

name: optional string

ReturnsExpand Collapse

Pet = object { name, photoUrls, id, 3 more }

name: string

photoUrls: array of string

id: optional number

formatint64

category: optional object { id, name }

id: optional number

formatint64

name: optional string

status: optional "available" or "pending" or "sold"

pet status in the store

Accepts one of the following:

"available"

"pending"

"sold"

tags: optional array of object { id, name }

id: optional number

formatint64

name: optional string

Add a new pet to the store.

HTTP

HTTP

TypeScript

Go

curl /api/v3/pet \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BARKEND_API_KEY" \
    -d '{
          "name": "doggie",
          "photoUrls": [
            "string"
          ],
          "id": 10
        }'

200 example

422 example

{
  "id": 10,
  "name": "doggie",
  "photoUrls": [
    "https://example.com/dog.jpg"
  ],
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "tags": [
    {
      "id": 1,
      "name": "friendly"
    }
  ],
  "status": "available"
}

{
  "error": {
    "id": "invalid_input",
    "message": "Invalid input - name and photoUrls required"
  }
}

Returns Examples

200 example

422 example

{
  "id": 10,
  "name": "doggie",
  "photoUrls": [
    "https://example.com/dog.jpg"
  ],
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "tags": [
    {
      "id": 1,
      "name": "friendly"
    }
  ],
  "status": "available"
}

{
  "error": {
    "id": "invalid_input",
    "message": "Invalid input - name and photoUrls required"
  }
}