{"info":{"_postman_id":"cfda3cef-56fb-4151-975e-8a51cd332480","name":"Pincel API documentation","description":"

📄 Get started here

This is the document to provide information needed to start using Pincel's API endpoints.

Pincel currently provides API endpoints to the following tools:

Face Swap
\n
AI Background Generator
\n
NEW! Clothes Swap
\n

Coming soon:

Image Replicator
\n
Reference
\n
Relight
\n
AI Portrait
\n
Multi Face Swap
\n

Getting started guide

To start using the Pincel API, you need to:

You must use a valid API Key to send requests to the API endpoints. You can get your API key from your Pincel account settings page
\n
The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
\n
The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
\n

Pricing

Our API uses a credit-based system, where each tool or endpoint deducts credits from your account based on usage. Most endpoints consume 1 credit per image result.

To get credits or explore our subscription plans, visit our Pricing Page and choose the option that best fits your needs.

Certain endpoints may consume different amounts of credits, which will be listed below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Tool	Credits per Result
Face Swap	1 credit
Clothes Swap	4 credits
AI Background Generator	1 credit

Authentication

The Pincel API uses API-Key header for authentication.

You must include an API key in each request to the Postman API with the X-Api-Key request header.

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

503 response

An HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support.

Prediction Results & Expiry

The results of predictions are provided as URLs and expire 1 hour after creation.

Need some help?

Please contact hello@pincel.app for support.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📄 Get started here","slug":"get-started-here"}],"owner":"105325","collectionId":"cfda3cef-56fb-4151-975e-8a51cd332480","publishedId":"2sAXjSz92g","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"10b981"},"publishDate":"2024-09-10T05:30:03.000Z"},"item":[{"name":"Face Swap","item":[{"name":"Swap Face","id":"0331d412-cd6b-4fd0-bbd0-15209e48f431","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"target_image\": \"https://static.pincel.app/temp/target-2cx07a.jpg\",\n \"face\": \"https://static.pincel.app/temp/new-face-hfhtxs.jpg\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pincel.app/api/face-swap","urlObject":{"protocol":"https","path":["api","face-swap"],"host":["pincel","app"],"query":[],"variable":[]}},"response":[{"id":"952a4d67-9419-4136-acab-526e3f65b88c","name":"Succesful response","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"..."}],"body":{"mode":"raw","raw":"{\n \"target_image\": \"https://static.pincel.app/temp/target-2cx07a.jpg\",\n \"face\": \"https://static.pincel.app/temp/new-face-hfhtxs.jpg\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pincel.app/api/face-swap"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"public, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"br"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Sep 2024 09:54:47 GMT"},{"key":"Server","value":"Vercel"},{"key":"Strict-Transport-Security","value":"max-age=63072000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Vercel-Cache","value":"MISS"},{"key":"X-Vercel-Execution-Region","value":"iad1"},{"key":"X-Vercel-Id","value":"arn1::iad1::jtcdk-1725875684245-69646d7c4002"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"output\": \"https://replicate.delivery/pbxt/4bQ4V8Pm9V7QMhyme3Ebm81jWRXOxrvkhgC4ppNjjuzyvjtJA/1725875685.jpg\",\n \"trialExpired\": false\n}"}],"_postman_id":"0331d412-cd6b-4fd0-bbd0-15209e48f431"}],"id":"2391241f-6e64-49d9-93a8-0e5df0ed3274","_postman_id":"2391241f-6e64-49d9-93a8-0e5df0ed3274","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"26a15c28-c759-4bf0-aeb4-87a9f32e86e4"}]},"isInherited":true,"source":{"_postman_id":"cfda3cef-56fb-4151-975e-8a51cd332480","id":"cfda3cef-56fb-4151-975e-8a51cd332480","name":"Pincel API documentation","type":"collection"}}},{"name":"Background","item":[{"name":"Start prediction","id":"31eb5932-1048-4169-9efb-20cb398afbf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"..."}],"body":{"mode":"raw","raw":"{\n \"prompt\": \"studio photoshoot, water splash\",\n \"image\": \"https://static.pincel.app/temp/yqd8i6ym06r2qxwfcw1jn-j42cs.jpg\",\n \"size_preset\": \"square\",\n \"action\": \"startPrediction\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pincel.app/api/background","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"26a15c28-c759-4bf0-aeb4-87a9f32e86e4"}]},"isInherited":true,"source":{"_postman_id":"cfda3cef-56fb-4151-975e-8a51cd332480","id":"cfda3cef-56fb-4151-975e-8a51cd332480","name":"Pincel API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["api","background"],"host":["pincel","app"],"query":[],"variable":[]}},"response":[{"id":"0378491f-71d5-4e5f-8100-9cb319c13da8","name":"Successful response","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"..."}],"body":{"mode":"raw","raw":"{\n \"prompt\": \"studio photoshoot, water splash\",\n \"image\": \"https://static.pincel.app/temp/yqd8i6ym06r2qxwfcw1jn-j42cs.jpg\",\n \"size_preset\": \"square\",\n \"action\": \"startPrediction\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pincel.app/api/background"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"public, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"br"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 10 Sep 2024 05:40:14 GMT"},{"key":"Server","value":"Vercel"},{"key":"Strict-Transport-Security","value":"max-age=63072000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Vercel-Cache","value":"MISS"},{"key":"X-Vercel-Execution-Region","value":"iad1"},{"key":"X-Vercel-Id","value":"arn1::iad1::6v75d-1725946814018-7bafd56a7819"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"prediction\": \"vw8rga2ywdrgp0chv9s979te1m\"\n}"}],"_postman_id":"31eb5932-1048-4169-9efb-20cb398afbf6"},{"name":"Get prediction","id":"a87f8d6c-97cd-451d-a50b-51a26bfac768","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"..."}],"body":{"mode":"raw","raw":"{\n \"predictionId\": \"0z58zy5cpnrgm0chtrc9asgwbm\",\n \"action\": \"getPrediction\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pincel.app/api/background","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"26a15c28-c759-4bf0-aeb4-87a9f32e86e4"}]},"isInherited":true,"source":{"_postman_id":"cfda3cef-56fb-4151-975e-8a51cd332480","id":"cfda3cef-56fb-4151-975e-8a51cd332480","name":"Pincel API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["api","background"],"host":["pincel","app"],"query":[],"variable":[]}},"response":[{"id":"2d80b1f6-55ec-4157-adf7-a03a8b9bfd8e","name":"Successful response","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"..."}],"body":{"mode":"raw","raw":"{\n \"predictionId\": \"0z58zy5cpnrgm0chtrc9asgwbm\",\n \"action\": \"getPrediction\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pincel.app/api/background"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"public, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"br"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Sep 2024 09:24:12 GMT"},{"key":"Server","value":"Vercel"},{"key":"Strict-Transport-Security","value":"max-age=63072000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Vercel-Cache","value":"MISS"},{"key":"X-Vercel-Execution-Region","value":"iad1"},{"key":"X-Vercel-Id","value":"arn1::iad1::t5vs4-1725873852556-c5555b382e29"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"succeeded\",\n \"output\": [\n \"https://replicate.delivery/pbxt/yQzlVJjU3L7DK1uOVu87F84OV9XgOc92dDDfM9GRwsTUhjtJA/generated_0.jpeg\"\n ]\n}"}],"_postman_id":"a87f8d6c-97cd-451d-a50b-51a26bfac768"}],"id":"206455de-42e3-40c7-83ab-817096852da4","_postman_id":"206455de-42e3-40c7-83ab-817096852da4","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"26a15c28-c759-4bf0-aeb4-87a9f32e86e4"}]},"isInherited":true,"source":{"_postman_id":"cfda3cef-56fb-4151-975e-8a51cd332480","id":"cfda3cef-56fb-4151-975e-8a51cd332480","name":"Pincel API documentation","type":"collection"}}},{"name":"Clothes Swap","item":[{"name":"Start prediction","id":"5783c4c1-c6d5-429c-9695-dd860b2d0dd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"..."}],"body":{"mode":"raw","raw":"{\n \"model_image\": \"https://pincel.app/assets/images/clothes/model-2.jpeg\",\n \"garment_image\": \"https://pincel.app/assets/images/clothes/garment-5.jpeg\",\n \"category\": \"upper_body\",\n \"action\": \"startPrediction\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pincel.app/api/clothes-swap","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"26a15c28-c759-4bf0-aeb4-87a9f32e86e4"}]},"isInherited":true,"source":{"_postman_id":"cfda3cef-56fb-4151-975e-8a51cd332480","id":"cfda3cef-56fb-4151-975e-8a51cd332480","name":"Pincel API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["api","clothes-swap"],"host":["pincel","app"],"query":[],"variable":[]}},"response":[{"id":"82070b73-cba3-485a-a4e1-69bdf0f886ee","name":"Successful response","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"..."}],"body":{"mode":"raw","raw":"{\n \"model_image\": \"https://pincel.app/assets/images/clothes/model-2.jpeg\",\n \"garment_image\": \"https://pincel.app/assets/images/clothes/garment-5.jpeg\",\n \"category\": \"upper_body\",\n \"action\": \"startPrediction\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pincel.app/api/clothes-swap"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"public, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"br"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 10 Sep 2024 05:40:14 GMT"},{"key":"Server","value":"Vercel"},{"key":"Strict-Transport-Security","value":"max-age=63072000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Vercel-Cache","value":"MISS"},{"key":"X-Vercel-Execution-Region","value":"iad1"},{"key":"X-Vercel-Id","value":"arn1::iad1::6v75d-1725946814018-7bafd56a7819"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"prediction\": \"vw8rga2ywdrgp0chv9s979te1m\"\n}"}],"_postman_id":"5783c4c1-c6d5-429c-9695-dd860b2d0dd2"},{"name":"Get prediction","id":"24fc18ec-e815-4b7d-8d4e-eb1dcb05428c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"..."}],"body":{"mode":"raw","raw":"{\n \"predictionId\": \"fp3rvf63a5rj40cmpvav7tp154\",\n \"action\": \"getPrediction\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pincel.app/api/clothes-swap","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"26a15c28-c759-4bf0-aeb4-87a9f32e86e4"}]},"isInherited":true,"source":{"_postman_id":"cfda3cef-56fb-4151-975e-8a51cd332480","id":"cfda3cef-56fb-4151-975e-8a51cd332480","name":"Pincel API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["api","clothes-swap"],"host":["pincel","app"],"query":[],"variable":[]}},"response":[{"id":"f9b688d5-af8e-4ed1-a7d3-4972464c528a","name":"Successful response","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"..."}],"body":{"mode":"raw","raw":"{\n \"predictionId\": \"fp3rvf63a5rj40cmpvav7tp154\",\n \"action\": \"getPrediction\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pincel.app/api/clothes-swap"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"public, max-age=0, must-revalidate"},{"key":"Content-Encoding","value":"br"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Sep 2024 09:24:12 GMT"},{"key":"Server","value":"Vercel"},{"key":"Strict-Transport-Security","value":"max-age=63072000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Vercel-Cache","value":"MISS"},{"key":"X-Vercel-Execution-Region","value":"iad1"},{"key":"X-Vercel-Id","value":"arn1::iad1::t5vs4-1725873852556-c5555b382e29"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"succeeded\",\n \"output\": [\n \"https://replicate.delivery/pbxt/yQzlVJjU3L7DK1uOVu87F84OV9XgOc92dDDfM9GRwsTUhjtJA/generated_0.jpeg\"\n ]\n}"}],"_postman_id":"24fc18ec-e815-4b7d-8d4e-eb1dcb05428c"}],"id":"d3342d7c-0fce-47b5-8ff3-14c5d7c397f5","description":"

Category possible values: \"upper_body\", \"lower_body\", \"dresses\"

\n","_postman_id":"d3342d7c-0fce-47b5-8ff3-14c5d7c397f5","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"26a15c28-c759-4bf0-aeb4-87a9f32e86e4"}]},"isInherited":true,"source":{"_postman_id":"cfda3cef-56fb-4151-975e-8a51cd332480","id":"cfda3cef-56fb-4151-975e-8a51cd332480","name":"Pincel API documentation","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"26a15c28-c759-4bf0-aeb4-87a9f32e86e4"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e7cb86a8-c7ba-4d6e-a566-566ee8ec1fd6"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"89f59f76-c586-4c4e-8368-d61ec9f08516"}}],"variable":[{"key":"baseUrl","value":"https://farming-simulator.pstmn.io","disabled":true},{"key":"token","value":"26a15c28-c759-4bf0-aeb4-87a9f32e86e4"}]}