API Reference

Pets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create

client.pets.create(PetCreateParams { name, photoUrls, category, 2 more } body, RequestOptionsoptions?): Pet { name, photoUrls, id, 3 more }

POST/pets

ParametersExpand Collapse

body: PetCreateParams { name, photoUrls, category, 2 more }

name: string

photoUrls: Array<string>

category?: Category { id, name }

id?: number

name?: string

status?: "available" | "pending" | "sold"

Accepts one of the following:

"available"

"pending"

"sold"

tags?: Array<Tag { id, name } >

id?: number

name?: string

ReturnsExpand Collapse

Pet { name, photoUrls, id, 3 more }

name: string

photoUrls: Array<string>

id?: number

category?: Category { id, name }

id?: number

name?: string

status?: "available" | "pending" | "sold"

Accepts one of the following:

"available"

"pending"

"sold"

tags?: Array<Tag { id, name } >

id?: number

name?: string

Create

TypeScript

HTTP

TypeScript

Python

Go

Ruby

import Barkend from 'barkend';

const client = new Barkend({
  bearerToken: process.env['BARKEND_BEARER_TOKEN'], // This is the default and can be omitted
});

const pet = await client.pets.create({ name: 'name', photoUrls: ['string'] });

console.log(pet.id);

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"
    }
  ]
}