{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"83bab89c-a68a-4fb1-83b7-0e3c20e2d96a","name":"Clarifai Public API","description":"<img src=\"https://github.com/user-attachments/assets/3c6a3f36-652d-4d7c-8866-3f9bf7ff1fab\">\n\nThe **Clarifai Public API** collection gives you direct access to the full Clarifai REST API — various endpoints across different resource areas. Use it to manage applications, upload inputs, train models, build workflows, search your data, run inference, and orchestrate compute infrastructure — all from Postman.\n\n---\n\n## What's in this Collection\n\n| Folder | Description |\n| --- | --- |\n| **Applications** | Create and manage apps — the top-level container for all resources |\n| **Annotations** | Label inputs, manage annotation filters, and detect duplicates |\n| **Collectors** | Auto-capture inputs from external model calls into an app |\n| **Concepts** | Manage labels, vocabularies, translations, and concept graphs |\n| **Datasets** | Create datasets, add inputs, and version snapshots for training |\n| **Inputs** | Upload images, video, text, and audio; stream and manage at scale |\n| **Models** | Create, train, evaluate, predict, and export custom models |\n| **Search** | Rank by visual similarity and filter by concept, task, or region |\n| **Workflows** | Chain models into multi-step inference pipelines |\n| **Pipelines** | Orchestrate multi-step data processing runs |\n| **Artifacts** | Store and version model weights and configuration files |\n| **Secrets** | Manage credentials for compute infrastructure |\n| **Runners** | Register agents for on-premises model inference |\n| **Compute Orchestration** | Provision clusters, nodepools, and model deployments |\n| **Walkthroughs** | End-to-end guides (RAG, visual classifier, and more) |\n\n---\n\n## Prerequisites\n\n### 1\\. Personal Access Token (PAT)\n\nAll requests authenticate using your PAT in the `Authorization` header:\n\n```\nAuthorization: Key <YOUR_PAT>\n\n ```\n\nThe collection uses **collection-level auth** — your PAT is applied automatically to every request once set. Generate a PAT from your [Clarifai account security settings](https://clarifai.com/settings/security).\n\n📖 [Authentication Documentation](https://docs.clarifai.com/control/authentication/pat)\n\n### 2\\. Set Your Variables\n\nOpen the collection → **Variables** tab and replace the placeholder values with your own:\n\n| Variable | Placeholder | Description |\n| --- | --- | --- |\n| `key` | `YOUR_PAT` | Your Personal Access Token |\n| `user_id` | `YOUR_USER_ID` | Your Clarifai username |\n| `app_id` | `YOUR_APP_ID` | The app to run requests against |\n| `model_id` | `YOUR_MODEL_ID` | Model ID for model endpoints |\n| `version_id` | `YOUR_VERSION_ID` | Model version ID |\n| `workflow_id` | `YOUR_WORKFLOW_ID` | Workflow ID |\n\nAll other variables (`concept_id`, `input_id`, `dataset_id`, etc.) follow the same pattern and are used by their respective endpoint groups.\n\n---\n\n## Authentication Setup\n\n1. Click the collection name in the sidebar\n    \n2. Go to the **Variables** tab\n    \n3. Set `key` to your PAT, `user_id` to your username, and `app_id` to your target app\n    \n4. All 235 requests will automatically use these values\n    \n\nAlternatively, create a **Postman Environment** with the same variable names to switch between accounts or apps without editing the collection directly.\n\n---\n\n## API Reference\n\n- **Base URL:** `https://api.clarifai.com`\n    \n- **Protocol:** HTTPS only\n    \n- **Auth header:** `Authorization: Key {{key}}`\n    \n- **Content-Type:** `application/json` (all POST / PATCH / PUT requests)\n    \n- **SDKs:** [Python](https://docs.clarifai.com/resources/api-overview/python-sdk) | [Node.js](https://docs.clarifai.com/resources/api-overview/nodejs-sdk) | [gRPC Clients](https://docs.clarifai.com/resources/api-overview/grpc-clients)\n    \n- **Pagination:** `page` and `per_page` query parameters on all list endpoints — [Pagination Docs](https://docs.clarifai.com/resources/api-overview/pagination)\n    \n- **Rate Limits:** [Rate Limits Documentation](https://docs.clarifai.com/resources/api-overview/rate-limits)\n    \n- **Status Codes:** [Status Codes Reference](https://docs.clarifai.com/resources/api-overview/status-codes)\n    \n\n---\n\n## Useful Links\n\n- [Documentation](https://docs.clarifai.com/)\n    \n- [Clarifai Platform](https://clarifai.com/explore)\n    \n- [Using Clarifai with Postman](https://docs.clarifai.com/resources/api-references/postman/)\n    \n- [API Status](https://status.clarifai.com/)\n    \n- [Discord Community](https://discord.gg/XAPE3Vtg)\n    \n- [API Overview](https://docs.clarifai.com/resources/api-overview/)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"24309294","team":15106,"collectionId":"83bab89c-a68a-4fb1-83b7-0e3c20e2d96a","publishedId":"2sBXijHWuM","public":true,"publicUrl":"https://documenter-api.postman.tech/view/24309294/2sBXijHWuM","privateUrl":"https://go.postman.co/documentation/24309294-83bab89c-a68a-4fb1-83b7-0e3c20e2d96a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":" The complete Postman collection for the Clarifai REST API — several endpoints covering applications, inputs, models, workflows, datasets, search, compute orchestration, and more. Includes ready-to-use requests with collection-level authentication, pre-configured variables, and links to the official documentation. "},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-03-20T12:29:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":" The complete Postman collection for the Clarifai REST API — several endpoints covering applications, inputs, models, workflows, datasets, search, compute orchestration, and more. Includes ready-to-use requests with collection-level authentication, pre-configured variables, and links to the official documentation. "},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/d3689f7bdd9013ed905a3d5f64b036418de512f4f5a09954408c738ea82174c7","favicon":"https://res.cloudinary.com/postman/image/upload/v1552070637/team/fud0n5ut4lo4vuqnbdis.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXijHWuM"}