API Reference

Pets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create

POST/pets

Body ParametersJSONExpand Collapse

name: string

photoUrls: array of string

category: optional Category { id, name }

id: optional number

name: optional string

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

Accepts one of the following:

"available"

"pending"

"sold"

tags: optional array of Tag { id, name }

id: optional number

name: optional string

ReturnsExpand Collapse

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

name: string

photoUrls: array of string

id: optional number

category: optional Category { id, name }

id: optional number

name: optional string

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

Accepts one of the following:

"available"

"pending"

"sold"

tags: optional array of Tag { id, name }

id: optional number

name: optional string

Create

HTTP

HTTP

TypeScript

Python

Go

Ruby

curl http://localhost:4000/api/v3/pets \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BARKEND_BEARER_TOKEN" \
    -d '{
          "name": "name",
          "photoUrls": [
            "string"
          ]
        }'

200 example

{
  "name": "name",
  "photoUrls": [
    "string"
  ],
  "id": 0,
  "category": {
    "id": 0,
    "name": "name"
  },
  "status": "available",
  "tags": [
    {
      "id": 0,
      "name": "name"
    }
  ]
}

Returns Examples

200 example

{
  "name": "name",
  "photoUrls": [
    "string"
  ],
  "id": 0,
  "category": {
    "id": 0,
    "name": "name"
  },
  "status": "available",
  "tags": [
    {
      "id": 0,
      "name": "name"
    }
  ]
}