--- title: Create a Pet record slug: import-test-pdf/create-a-pet-record createdAt: 2025-10-28T16:28:34.263Z --- { "id": "mVBDHEOCN5Szly7A7E9ON", "type": "api-oas-v2", "data": { "method": "POST", "url": "/api/v1/pets", "servers": [], "name": "Create a Pet record", "description": "Create a pet", "contentType": "multipart/form-data", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [ { "name": "clinic_id", "kind": "required", "type": "integer", "description": "Clinic id.", "example": 1 }, { "name": "vet_id", "kind": "required", "type": "integer", "description": "Vet id.", "example": 1 }, { "name": "owner_id", "kind": "required", "type": "integer", "description": "Owner Id.", "example": 1 }, { "name": "nickname", "kind": "required", "type": "string", "description": "Nickname", "example": "Fluffy" }, { "name": "birthday", "kind": "required", "type": "string", "description": "Birthday (Y-m-d)", "example": "2017-11-28" }, { "name": "avatar", "kind": "optional", "type": "file", "description": "Profile picture.", "example": "avatar.jpg" }, { "name": "species_id", "kind": "required", "type": "integer", "description": "Species Id.", "example": 1 }, { "name": "breed_id", "kind": "required", "type": "integer", "description": "Breed ID.", "example": 1 }, { "name": "crossbreed", "kind": "optional", "type": "boolean", "description": "Set to true if crossbreed. Do not send empty value, omit the key completely", "example": "" }, { "name": "crossbreed_details", "kind": "optional", "type": "string", "description": "Crossbreed id (see breeds endpoint) Do not send empty value, omit the key completely", "example": "" }, { "name": "color", "kind": "optional", "type": "string", "description": "Color", "example": "Pink" }, { "name": "color_mask", "kind": "optional", "type": "array", "description": "Color mask", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": 1, "itemDefault": "" }, { "name": "distinctive_marks", "kind": "optional", "type": "string", "description": "Distinctive marks", "example": "One spot on right year" }, { "name": "gender", "kind": "required", "type": "string", "description": "Gender", "example": "" }, { "name": "observations", "kind": "optional", "type": "string", "description": "Observations (Pet notes)", "example": "" }, { "name": "chip_number", "kind": "optional", "type": "string", "description": "Chip number", "example": "123456789" }, { "name": "microchip_location", "kind": "optional", "type": "string", "description": "Microchip Location", "example": "Neck" }, { "name": "insurance_number", "kind": "optional", "type": "string", "description": "Insurance Number", "example": "123456789" }, { "name": "passport", "kind": "optional", "type": "string", "description": "Passport", "example": "123456789" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description", "example": "" }, { "name": "constitution", "kind": "optional", "type": "string", "description": "Constitution", "example": "" }, { "name": "conformation", "kind": "optional", "type": "string", "description": "Conformation", "example": "" }, { "name": "allergies", "kind": "optional", "type": "string", "description": "Allergies", "example": "" }, { "name": "blood_type_id", "kind": "optional", "type": "integer", "description": "Blood Type Id (see blood-types endpoint) Do not send empty value, omit the key completely", "example": 0 }, { "name": "hormonal_status", "kind": "required", "type": "integer]", "description": "Hormonal Status (0=neutered,1=normal,2=unkown)", "example": "" } ], "oAuthParameters": [] }, "responses": [ { "statusCode": "201", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Pet", "customType": "Pet", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "nickname", "kind": "optional", "type": "string", "description": "", "example": "Fritz" }, { "name": "species_id", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "breed_id", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "observations", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "gender", "kind": "optional", "type": "string", "description": "", "example": "male" }, { "name": "microchip", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "crossbreed", "kind": "optional", "type": "string<0 | 1>", "description": "", "example": "0" }, { "name": "crossbreed_details_id", "kind": "optional", "type": "integer", "description": "", "example": "" }, { "name": "color", "kind": "optional", "type": "string", "description": "", "example": "NavajoWhite" }, { "name": "distinctive_marks", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "birthday", "kind": "optional", "type": "string", "description": "", "example": "1983-03-29" }, { "name": "gender_string", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "chip_number", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "microchip_location", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "insurance_number", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "passport", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "profile_picture", "kind": "optional", "type": "string", "description": "", "example": "https://dev-1-public-digitail.s3.eu-central-1.amazonaws.com/ionut/uploads/KXy8Rlv2vluiZYqwRCy2" }, { "name": "description", "kind": "optional", "type": "string", "description": "", "example": "Lorem ipsum" }, { "name": "constitution", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "conformation", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "weight", "kind": "optional", "type": "number", "description": "", "example": "" }, { "name": "allergies", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "nr_recs", "kind": "optional", "type": "integer", "description": "", "example": "" }, { "name": "blood_type", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "hormonal_status", "kind": "optional", "type": "integer", "description": "0: 'Unknown' 1: 'Intact' 2: 'Neutered'\n", "example": 0 }, { "name": "age", "kind": "optional", "type": "string", "description": "", "example": "38 Years, 3 Months, 19 Days" }, { "name": "patientNumber", "kind": "optional", "type": "string", "description": "", "example": "mxc-1 #jwq-1" }, { "name": "is_verified", "kind": "optional", "type": "string<0 | 1>", "description": "", "example": "1" }, { "name": "breeder", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "archive", "kind": "optional", "type": "object", "description": "Slim resource for archive, usually attached to other resources", "modelRef": "#/components/schemas/Archive", "customType": "Archive", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "reason", "kind": "optional", "type": "string", "description": "", "example": "The patient was archived because..." }, { "name": "type", "kind": "optional", "type": "string", "description": "", "example": "Deceased" } ] }, { "name": "birthday_estimated", "kind": "optional", "type": "boolean", "description": "", "example": false }, { "name": "rabic_tag_number", "kind": "optional", "type": "string", "description": "", "example": "12109384" }, { "name": "updated_at", "kind": "optional", "type": "string", "description": "", "example": "2020-06-12 15:45:43" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url /api/v1/pets \\\n --header 'accept: application/json' \\\n --header 'content-type: multipart/form-data' \\\n --form 'clinic_id=\"1\"' \\\n --form 'vet_id=\"1\"' \\\n --form 'owner_id=\"1\"' \\\n --form 'nickname=\"Fluffy\"' \\\n --form 'birthday=\"2017-11-28\"' \\\n --form 'species_id=\"1\"' \\\n --form 'breed_id=\"1\"' \\\n --form 'gender=\"string\"' \\\n --form 'hormonal_status=\"integer]\"'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"multipart/form-data\");\n\nvar formdata = new FormData();\nformdata.append(\"clinic_id\", \"1\");\nformdata.append(\"vet_id\", \"1\");\nformdata.append(\"owner_id\", \"1\");\nformdata.append(\"nickname\", \"Fluffy\");\nformdata.append(\"birthday\", \"2017-11-28\");\nformdata.append(\"species_id\", \"1\");\nformdata.append(\"breed_id\", \"1\");\nformdata.append(\"gender\", \"string\");\nformdata.append(\"hormonal_status\", \"integer]\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: formdata,\n redirect: 'follow'\n};\n\nfetch(\"/api/v1/pets\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"/api/v1/pets\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"multipart/form-data\"\nform_data = [['clinic_id', File.open('undefined')],['vet_id', File.open('undefined')],['owner_id', File.open('undefined')],['nickname', File.open('undefined')],['birthday', File.open('undefined')],['species_id', File.open('undefined')],['breed_id', File.open('undefined')],['gender', File.open('undefined')],['hormonal_status', File.open('undefined')]]\nrequest.set_form form_data, 'multipart/form-data'\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\n\nurl = \"/api/v1/pets\"\n\npayload = {}\nfiles=[\n\n]\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'multipart/form-data'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload, files=files)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-201", "language": "201", "code": "// Successful operation\n{\n \"data\": {\n \"id\": 1,\n \"nickname\": \"Fritz\",\n \"species_id\": \"1\",\n \"breed_id\": \"1\",\n \"observations\": \"\",\n \"gender\": \"male\",\n \"microchip\": \"\",\n \"crossbreed\": \"0\",\n \"crossbreed_details_id\": 0,\n \"color\": \"NavajoWhite\",\n \"distinctive_marks\": \"\",\n \"birthday\": \"1983-03-29\",\n \"gender_string\": \"\",\n \"chip_number\": \"\",\n \"microchip_location\": \"\",\n \"insurance_number\": \"\",\n \"passport\": \"\",\n \"profile_picture\": \"https://dev-1-public-digitail.s3.eu-central-1.amazonaws.com/ionut/uploads/KXy8Rlv2vluiZYqwRCy2\",\n \"description\": \"Lorem ipsum\",\n \"constitution\": \"\",\n \"conformation\": \"\",\n \"weight\": 0,\n \"allergies\": \"\",\n \"nr_recs\": 0,\n \"blood_type\": \"\",\n \"hormonal_status\": 0,\n \"age\": \"38 Years, 3 Months, 19 Days\",\n \"patientNumber\": \"mxc-1 #jwq-1\",\n \"is_verified\": \"1\",\n \"breeder\": \"\",\n \"archive\": {\n \"id\": 1,\n \"reason\": \"The patient was archived because...\",\n \"type\": \"Deceased\"\n },\n \"birthday_estimated\": false,\n \"rabic_tag_number\": \"12109384\",\n \"updated_at\": \"2020-06-12 15:45:43\"\n }\n}" } ], "selectedLanguageId": "response-0-201" } }, "children": [ { "text": "" } ] }