Please head over to developer.air.inc to find the new home for all things development on Air. These docs are no longer being maintained and may not represent the most up-to-date information.
\nWelcome to our API documentation! We are currently in the process of building our documentation to make it as helpful as possible for developers looking to start using our API.β¨β¨
\nOur API is organized around the REST architectural style. This API supports calling the Air platform for managing a variety of creative ops workflows with the content in your Air workspace.
\nAuthentication is managed by passing an API key through the x-api-key header. Please contact your account manager for access to an api key
Requests are contextualized to a specific workpsace. When making a request, provide your workspace's workspace id through the x-air-workspace-id header.
Below is a list of commont HTTP response status codes that will be returned from the API.
\nAll request made under a given API key will be limited to 15 requests per second with a total of 10 concurrent requests allowed at a given time. If either of these limitations are exceeded the API will respond with a 429 status code and response body containing \"Too Many Requests\". When this encountered leverage exponential backoff starting at 1 second to try requests again.
\nAdditionally, several endpoints support support paging, including a limit request parameter indicating the maximum amount of items to include in a response (up to maximum 500).
Webhooks will be considered in future iterations of the API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"π π π Docs have moved π π π","slug":"docs-have-moved"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Response Status Codes","slug":"response-status-codes"},{"content":"Rate limits","slug":"rate-limits"},{"content":"Webhooks","slug":"webhooks"}],"owner":"14122528","collectionId":"3e6b7f8e-c377-4914-814c-2c5e680c2f36","publishedId":"2s8YekQaDo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-11-11T23:08:38.000Z"},"item":[{"name":"Assets","item":[{"name":"/assets","id":"3ab9cc45-ca8d-48ab-b846-6d2e12b1102f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.air.inc/v1/assets?limit=&cursor=&parentBoardId=&tag=&customField=:customField","description":"Get a list of assets.
\n","urlObject":{"protocol":"https","path":["v1","assets"],"host":["api","air","inc"],"query":[{"description":{"content":"The max number of assets to return in the response
\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"Cursor to the next page of assets
\n","type":"text/plain"},"key":"cursor","value":""},{"description":{"content":"The parent board ID of the assets to return
\n","type":"text/plain"},"key":"parentBoardId","value":""},{"description":{"content":"Filter assets by attached tags. If multiple tag=value pairs are provided, only assets with all specified tags will be included.
For single- and multi-select custom fields, filter for entities matching specific values. This query parameter can be supplied multiple times, as custom field ID UUID and custom field value ID UUID pairs, separated by a colon :, e.g. &customField=fb9e852c-eb2a-4dd0-81f4-7af266c335d1:7b6e39bb-28bb-46ae-be8a-5c01bbacf78c. Supplying multiple custom field UUID's matches all (AND), and mutliple custom field value UUID's per the same repeated custom field matches any (OR).
Get an asset
\n","urlObject":{"protocol":"https","path":["v1","assets",":assetId"],"host":["api","air","inc"],"query":[],"variable":[{"description":{"content":"the id of the asset
\n","type":"text/plain"},"type":"any","value":"","key":"assetId"}]}},"response":[{"id":"e81171ef-ba4c-4864-baac-d07336946259","name":"Default","originalRequest":{"method":"GET","header":[],"url":"https://api.air.inc/v1/assets/733215a5-3c60-408b-bf10-95761389d50a"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7b6e39bb-28bb-46ae-be8a-5c01bbacf78c\",\n \"customFields\": [\n {\n \"id\": \"fb9e852c-eb2a-4dd0-81f4-7af266c335d1\",\n \"name\": \"Status\",\n \"type\": \"single-select\",\n \"values\": [\n {\n \"id\": \"7b6e39bb-28bb-46ae-be8a-5c01bbacf78c\",\n \"name\": \"Approved\"\n }\n ]\n },\n {\n \"id\": \"6ae9cbdf-357e-4431-acea-152ad5821a97\",\n \"name\": \"SKU\",\n \"type\": \"plain-text\",\n \"value\": \"ABC123\"\n }\n ],\n \"coverVersion\": {\n \"id\": \"3857116d-b5ce-4f7f-987f-0854b474c459\",\n \"fileName\": \"ford-gt\",\n \"description\": \"A ford GT\",\n \"ext\": \"jpg\",\n \"title\": \"Ford GT\",\n \"type\": \"photo\",\n \"createdAt\": \"2020-10-27 22:17:08.263+00\",\n \"uploadedAt\": \"2022-11-10 19:45:44.248454+00\",\n \"fileCreatedAt\": \"2019-05-21 22:17:08.263+00\",\n \"width\": 1870,\n \"height\": 2970,\n \"size\": 656439,\n \"tags\": [{\n \"id\": \"3857116d-b5ce-4f7f-987f-0854b474c459\",\n \"label\": \"outdoors\"\n }],\n \"urls\": {\n \"thumbnail\": \"https://air-prod.imgix.net/3857116d-b5ce-4f7f-987f-0854b474c459.jpg\",\n \"preview\": \"https://air-prod.imgix.net/3857116d-b5ce-4f7f-987f-0854b474c459.jpg\"\n }\n }\n}"}],"_postman_id":"78495dba-a0be-48db-846c-8b02ee1ba703"},{"name":"/assets/:assetId","id":"cedf2f3e-cf87-4a11-b15f-c13014e1b366","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.air.inc/v1/assets/:assetId","description":"Delete an asset
\n","urlObject":{"protocol":"https","path":["v1","assets",":assetId"],"host":["api","air","inc"],"query":[],"variable":[{"type":"any","value":null,"key":"assetId"}]}},"response":[{"id":"0577e44a-e078-47a7-a5a9-1b335adc8105","name":"Default","originalRequest":{"method":"DELETE","header":[],"url":"https://api.air.inc/v1/assets/9721a774-763b-483c-beb7-58222a5033cf"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"cedf2f3e-cf87-4a11-b15f-c13014e1b366"},{"name":"/assets/:assetId/customfields/:customFieldId","id":"f5405956-5a5d-4eae-9c20-a524435a2625","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.air.inc/v1/assets/:assetId/customfields/:customFieldId","description":"Set custom field value(s) on an asset
\nBody
\nsingle-select and multi-select)plain-text and date)To unset a custom field on an asset, set the relavant property above to null
the id of the asset
\n","type":"text/plain"},"type":"any","value":null,"key":"assetId"},{"description":{"content":"the id of the custom field
\n","type":"text/plain"},"type":"any","value":null,"key":"customFieldId"}]}},"response":[{"id":"f451a343-0780-4e39-b54b-a6f10b7a5a9f","name":"single-select","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"values\": [{\n \"id\": \"6e3f5f08-ab88-421b-867b-ed1a22cac88b\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/boards/7a2b9e34-bb38-4747-a838-3ffc32fdf43d/customfields/f6d3c43f-ba6e-48fa-bb6b-39fb7fda9448"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"c6784429-9b9d-4d1a-9f1d-dfcd040232e6","name":"multi-select","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"values\": [{\n \"id\": \"6e3f5f08-ab88-421b-867b-ed1a22cac88b\"\n }, {\n \"id\": \"b69ea197-dd29-4e03-968d-ef1e336e1d09\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/boards/7a2b9e34-bb38-4747-a838-3ffc32fdf43d/customfields/f6d3c43f-ba6e-48fa-bb6b-39fb7fda9448"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"9dd58f29-f504-493e-b7c6-9ab4cca87f4d","name":"plain-text","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"value\": \"abc123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/boards/7a2b9e34-bb38-4747-a838-3ffc32fdf43d/customfields/f6d3c43f-ba6e-48fa-bb6b-39fb7fda9448"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"f7e65e7e-61e7-40a4-99a1-da2e4e529bdf","name":"date","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"value\": \"2022-10-14 23:04:21.507866+00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/boards/7a2b9e34-bb38-4747-a838-3ffc32fdf43d/customfields/f6d3c43f-ba6e-48fa-bb6b-39fb7fda9448"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f5405956-5a5d-4eae-9c20-a524435a2625"},{"name":"/assets/:assetId/versions","id":"e6f96309-b2cd-4b51-8ade-ad8712becc8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.air.inc/v1/assets/:assetId/versions","description":"Get a list of asset versions associated with an asset.
\n","urlObject":{"protocol":"https","path":["v1","assets",":assetId","versions"],"host":["api","air","inc"],"query":[],"variable":[{"description":{"content":"The id of the asset
\n","type":"text/plain"},"type":"any","value":"","key":"assetId"}]}},"response":[{"id":"642d66d4-edb9-461e-8eeb-cce94481f33f","name":"Default","originalRequest":{"method":"GET","header":[],"url":"https://api.air.inc/v1/assets/733215a5-3c60-408b-bf10-95761389d50a/versions"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [{\n \"id\": \"3857116d-b5ce-4f7f-987f-0854b474c459\",\n \"fileName\": \"ford-gt\",\n \"description\": \"A ford GT\",\n \"ext\": \"jpg\",\n \"title\": \"Ford GT\",\n \"type\": \"photo\",\n \"createdAt\": \"2020-10-27 22:17:08.263+00\",\n \"uploadedAt\": \"2022-11-10 19:45:44.248454+00\",\n \"width\": 1870,\n \"height\": 2970,\n \"size\": 656439,\n \"urls\": {\n \"thumbnail\": \"https://air-prod.imgix.net/3857116d-b5ce-4f7f-987f-0854b474c459.jpg\",\n \"preview\": \"https://air-prod.imgix.net/3857116d-b5ce-4f7f-987f-0854b474c459.jpg\"\n }\n }],\n \"total\": 1\n}"}],"_postman_id":"e6f96309-b2cd-4b51-8ade-ad8712becc8c"},{"name":"/assets/:assetId/versions/:versionId","id":"25193106-0d30-470a-aeb9-17ce264c5534","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.air.inc/v1/assets/:assetId/versions/:versionId","description":"Get an asset version associated with an asset, including metadata fields like IPTC and EXIF.
the id of the asset
\n","type":"text/plain"},"type":"any","value":"","key":"assetId"},{"description":{"content":"the id of the version
\n","type":"text/plain"},"type":"any","value":"","key":"versionId"}]}},"response":[{"id":"06d9d704-63f6-4b7b-b691-6783a91c3b70","name":"Default","originalRequest":{"method":"GET","header":[],"url":"https://api.air.inc/v1/assets/3990627a-b055-461c-9590-09bc70315862/versions/ac5eae85-7c54-40f0-a65b-39e32a209254"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ac5eae85-7c54-40f0-a65b-39e32a209254\",\n \"fileName\": \"ford-gt\",\n \"description\": \"A ford GT\",\n \"ext\": \"jpg\",\n \"title\": \"Ford GT\",\n \"type\": \"photo\",\n \"createdAt\": \"2020-10-27 22:17:08.263+00\",\n \"uploadedAt\": \"2022-11-10 19:45:44.248454+00\",\n \"width\": 1870,\n \"height\": 2970,\n \"size\": 656439,\n \"tags\": [{\n \"id\": \"3857116d-b5ce-4f7f-987f-0854b474c459\",\n \"name\": \"outdoors\"\n }],\n \"urls\": {\n \"thumbnail\": \"https://air-prod.imgix.net/3857116d-b5ce-4f7f-987f-0854b474c459.jpg\",\n \"preview\": \"https://air-prod.imgix.net/3857116d-b5ce-4f7f-987f-0854b474c459.jpg\"\n },\n \"metadata\": [\n {\n \"category\": \"Rights\",\n \"fieldName\": \"CopyrightNotice\",\n \"label\": \"Copyright Notice\",\n \"type\": \"string\",\n \"data\": \"Β© Copyright 2020 IPTC (Test Images) - www.iptc.org\"\n },\n {\n \"category\": \"Rights\",\n \"fieldName\": \"UsageTerms\",\n \"label\": \"Usage Terms\",\n \"type\": \"string\",\n \"data\": \"All rights reserved. To use this image an explicit license granted by IPTC is required.\"\n }\n ]\n}"}],"_postman_id":"25193106-0d30-470a-aeb9-17ce264c5534"},{"name":"/assets/:assetId/versions/:versionId","id":"e3ed25b5-dbc1-45a9-a04e-0682150a4b40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"this is a testing\", \"description\": \"this is a description\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/assets/:assetId/versions/:versionId","description":"Update an asset version
\nBody
\nthe id of the asset
\n","type":"text/plain"},"type":"any","value":"","key":"assetId"},{"description":{"content":"the id of the version
\n","type":"text/plain"},"type":"any","value":"","key":"versionId"}]}},"response":[{"id":"90521ee8-ca7f-4d19-9884-50a65de49d25","name":"Default","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\n \"title\": \"Ford GT\",\n \"description\": \"A ford GT\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/assets/9721a774-763b-483c-beb7-58222a5033cf/versions/19134d50-e37a-4944-b1a2-b2605e44acdc"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e3ed25b5-dbc1-45a9-a04e-0682150a4b40"},{"name":"/assets/:assetId/versions/:versionId/download","id":"8fd7259e-169d-4960-be4b-a866eed0bcf4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.air.inc/v1/assets/:assetId/versions/:versionId/download","description":"Get the download URL of an asset version
\n","urlObject":{"protocol":"https","path":["v1","assets",":assetId","versions",":versionId","download"],"host":["api","air","inc"],"query":[],"variable":[{"id":"ae8e1fff-ba29-4626-93a9-7285ff750033","description":{"content":"the id of the asset
\n","type":"text/plain"},"type":"any","value":"","key":"assetId"},{"id":"056c6aa0-2170-4f5e-a182-0a7f7e57ad6f","description":{"content":"the id of the version
\n","type":"text/plain"},"type":"any","value":"","key":"versionId"}]}},"response":[{"id":"693a3e64-3b02-456a-8b68-636174ccd94b","name":"Default","originalRequest":{"method":"GET","header":[],"url":"https://api.air.inc/v1/assets/3990627a-b055-461c-9590-09bc70315862/versions/ac5eae85-7c54-40f0-a65b-39e32a209254/download"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://air-original.s3-accelerate.amazonaws.com/ac5eae85-7c54-40f0-a65b-39e32a209254.JPG?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAYQ5YBJZBWW5UZHX6%2F20240425%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240425T183247Z&X-Amz-Expires=86400&X-Amz-Signature=9142a94d00750c885a6192924f8f3d85e8a27ff99db377c73f40c7dce8bea2d9&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3Bfilename%3D%22ford-gt.JPG%22%3B%20filename%2A%3Dutf-8%27%27ford-gt.JPG\",\n \"expiresAt\": \"2024-04-26T18:32:47.359Z\"\n}"}],"_postman_id":"8fd7259e-169d-4960-be4b-a866eed0bcf4"},{"name":"/assets/:assetId/versions/:versionId/tags","id":"8d8c605a-0377-4a9c-a97a-242e8628475b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.air.inc/v1/assets/:assetId/versions/:versionId/tags","description":"Add one or more tags to an asset version
\nBody
\nthe id of the asset
\n","type":"text/plain"},"type":"any","value":null,"key":"assetId"},{"description":{"content":"the id of the version
\n","type":"text/plain"},"type":"any","value":null,"key":"versionId"}]}},"response":[{"id":"0f5de567-68a5-445b-9a11-04da16ef5304","name":"Default","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"0ecb3be0-12ab-4b63-9a65-5ed2d3c119a8\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/assets/9721a774-763b-483c-beb7-58222a5033cf/versions/19134d50-e37a-4944-b1a2-b2605e44acdc/tags"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8d8c605a-0377-4a9c-a97a-242e8628475b"},{"name":"/assets/:assetId/versions/:versionId/tags/:tagId","id":"50d41507-43d8-4914-ad27-937d7e59e89b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.air.inc/v1/assets/:assetId/versions/:versionId/tags/:tagId","description":"Delete a tag from an asset version
\n","urlObject":{"protocol":"https","path":["v1","assets",":assetId","versions",":versionId","tags",":tagId"],"host":["api","air","inc"],"query":[],"variable":[{"description":{"content":"the id of the asset
\n","type":"text/plain"},"type":"any","value":null,"key":"assetId"},{"description":{"content":"the id of the version
\n","type":"text/plain"},"type":"any","value":null,"key":"versionId"},{"description":{"content":"the id of the tag
\n","type":"text/plain"},"type":"any","value":null,"key":"tagId"}]}},"response":[{"id":"e42e7f87-6883-40ed-9571-59266e9627f4","name":"Default","originalRequest":{"method":"DELETE","header":[],"url":"https://api.air.inc/v1/assets/9721a774-763b-483c-beb7-58222a5033cf/versions/19134d50-e37a-4944-b1a2-b2605e44acdc/tags/74589af6-b056-42d5-8e26-17c00ccdb3d2"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"50d41507-43d8-4914-ad27-937d7e59e89b"},{"name":"/assets/:assetId/boards","id":"4ac8f44f-c7f1-46c3-ac3d-ec01a06414ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.air.inc/v1/assets/:assetId/boards?limit=&cursor=&includeCustomFields=","description":"Get the list of parent boards of an asset
\n","urlObject":{"protocol":"https","path":["v1","assets",":assetId","boards"],"host":["api","air","inc"],"query":[{"description":{"content":"The max number of parent boards to return in the response
\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"Cursor to the next page of parent boards
\n","type":"text/plain"},"key":"cursor","value":""},{"description":{"content":"A boolean flag to include custom fields with the results (default: false)
the id of the asset
\n","type":"text/plain"},"type":"any","value":null,"key":"assetId"}]}},"response":[{"id":"f1f8c4c8-31ef-46ae-9ab9-abbcbbfaa5cc","name":"Default","originalRequest":{"method":"GET","header":[],"url":"https://api.air.inc/v1/assets/9721a774-763b-483c-beb7-58222a5033cf/boards"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"a6702468-4845-4d21-b968-c3311663a145\",\n \"parentBoardId\": \"27b57204-1e88-448a-a745-828e1925074e\",\n \"title\": \"Cars\",\n \"description\": \"A collection of cars\",\n \"createdAt\": \"2024-05-28 16:01:28.049443+00\",\n \"updatedAt\": \"2024-05-28 16:01:28.049443+00\"\n }\n ],\n \"pagination\": {\n \"hasMore\": false,\n \"cursor\": null\n },\n \"total\": 1\n}"},{"id":"e62822e0-7c3b-4860-b193-ecf034071da8","name":"With custom fields","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.air.inc/v1/assets/9721a774-763b-483c-beb7-58222a5033cf/boards?includeCustomFields=true","protocol":"https","host":["api","air","inc"],"path":["v1","assets","9721a774-763b-483c-beb7-58222a5033cf","boards"],"query":[{"key":"includeCustomFields","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"a6702468-4845-4d21-b968-c3311663a145\",\n \"parentBoardId\": \"27b57204-1e88-448a-a745-828e1925074e\",\n \"title\": \"Cars\",\n \"description\": \"A collection of cars\",\n \"createdAt\": \"2024-05-28 16:01:28.049443+00\",\n \"updatedAt\": \"2024-05-28 16:01:28.049443+00\",\n \"customFields\": [\n {\n \"id\": \"ed93fc0b-e2cb-41d1-9acb-0ed6107e8bfa\",\n \"name\": \"Status\",\n \"type\": \"single-select\",\n \"value\": null,\n \"values\": [\n {\n \"id\": \"5374d1e7-f218-44d8-95d9-a97dde211f2f\",\n \"name\": \"Approved\"\n }\n ]\n }\n ]\n }\n ],\n \"pagination\": {\n \"hasMore\": false,\n \"cursor\": null\n },\n \"total\": 1\n}"}],"_postman_id":"4ac8f44f-c7f1-46c3-ac3d-ec01a06414ab"}],"id":"aadf9871-6010-4ec5-be79-ce8bb63dbc89","description":"In the context of Air, \"asset\" refers to any piece of digital content or material for use in the production of creative work. β¨These typically include things like photos, videos, design files, and any other materials used in the creative process. β¨β¨Air assets can hold multiple files in individual versions, are organized into boards (an asset can live in one or more boards) and can be assigned metadata like custom fields and tags.
\n","_postman_id":"aadf9871-6010-4ec5-be79-ce8bb63dbc89"},{"name":"Boards","item":[{"name":"/boards","id":"f18c4313-446d-4412-87f2-fe536ebeccf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.air.inc/v1/boards?name=:boardName&limit=:limit&cursor=:cursor&parentBoardId=:parentBoardId&customField=:customField","description":"Get the list of boards defined in an Air workspace.
\n","urlObject":{"protocol":"https","path":["v1","boards"],"host":["api","air","inc"],"query":[{"description":{"content":"Free text board name search filter
\n","type":"text/plain"},"key":"name","value":":boardName"},{"description":{"content":"Limits the number of boards items to return in the response
\n","type":"text/plain"},"key":"limit","value":":limit"},{"description":{"content":"Cursor returned in the previous page of responses used to get the next page of results
\n","type":"text/plain"},"key":"cursor","value":":cursor"},{"description":{"content":"Used when navigating immediate child sub boards in a board hierarchy
\n","type":"text/plain"},"key":"parentBoardId","value":":parentBoardId"},{"description":{"content":"For single- and multi-select custom fields, filter for entities matching specific values. This query parameter can be supplied multiple times, as custom field ID UUID and custom field value ID UUID pairs, separated by a colon :, e.g. &customField=fb9e852c-eb2a-4dd0-81f4-7af266c335d1:7b6e39bb-28bb-46ae-be8a-5c01bbacf78c. Supplying multiple custom field UUID's matches all (AND), and mutliple custom field value UUID's per the same repeated custom field matches any (OR).
Create a board at the top-level of the workspace or as a child of another board
\nBody
\nGet a board
\n","urlObject":{"protocol":"https","path":["v1","boards",":boardId"],"host":["api","air","inc"],"query":[],"variable":[{"description":{"content":"the id of the board
\n","type":"text/plain"},"type":"any","value":null,"key":"boardId"}]}},"response":[{"id":"de2eee90-3ddd-46b4-9db2-99bf668fad52","name":"Default","originalRequest":{"method":"GET","header":[],"url":"https://api.air.inc/v1/boards/3990627a-b055-461c-9590-09bc70315862"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7a2b9e34-bb38-4747-a838-3ffc32fdf43d\",\n \"title\": \"Cars\",\n \"description\": \"A collection of cars\",\n \"parentBoardId\": \"1178535e-b041-4b4f-9cf5-ae5d90894306\",\n \"createdAt\": \"2022-10-14 23:04:21.507866+00\",\n \"updatedAt\": \"2022-10-14 23:04:21.507866+00\",\n \"customFields\": [\n {\n \"id\": \"fb9e852c-eb2a-4dd0-81f4-7af266c335d1\",\n \"name\": \"Status\",\n \"type\": \"single-select\",\n \"values\": [\n {\n \"id\": \"7b6e39bb-28bb-46ae-be8a-5c01bbacf78c\",\n \"name\": \"Approved\"\n }\n ]\n },\n {\n \"id\": \"6ae9cbdf-357e-4431-acea-152ad5821a97\",\n \"name\": \"SKU\",\n \"type\": \"plain-text\",\n \"value\": \"ABC123\"\n }\n ]\n}"}],"_postman_id":"c68ff75a-226f-4922-9726-c6b355c24ca6"},{"name":"/boards/:boardId","id":"08a0bf73-527f-4dd0-8ce0-67ce4e87486e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://api.air.inc/v1/boards/:boardId","description":"Update one or more properties on a board
\nBody
\ntitle - the title of the board
\ndescription - the description of the board
\nparentBoardId - the parent board this board is a child of. null will move the board to the root.
the id of the board
\n","type":"text/plain"},"type":"any","value":null,"key":"boardId"}]}},"response":[{"id":"c243c0a5-b60f-482e-a352-1e4873062553","name":"Default","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Cars\",\n \"description\": \"A collection of cars\",\n \"parentBoardId\": \"1178535e-b041-4b4f-9cf5-ae5d90894306\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/boards/3990627a-b055-461c-9590-09bc70315862"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"08a0bf73-527f-4dd0-8ce0-67ce4e87486e"},{"name":"/boards/:boardId","id":"1506f529-22b2-4a8d-9839-f26fb87ba97e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.air.inc/v1/boards/:boardId","description":"Delete a board and any assets that are only contained in this board or its direct descendant boards.
\n","urlObject":{"protocol":"https","path":["v1","boards",":boardId"],"host":["api","air","inc"],"query":[],"variable":[{"description":{"content":"the id of the board
\n","type":"text/plain"},"type":"any","value":null,"key":"boardId"}]}},"response":[{"id":"6d8649ee-26dc-4ecd-b14a-36fa761f80e3","name":"Default","originalRequest":{"method":"DELETE","header":[],"url":"https://api.air.inc/v1/boards/3990627a-b055-461c-9590-09bc70315862"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1506f529-22b2-4a8d-9839-f26fb87ba97e"},{"name":"/boards/:boardId/customfields/:customFieldId","id":"11e3f6bb-3dae-4811-ad00-941fe1f172e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.air.inc/v1/boards/:boardId/customfields/:customFieldId","description":"Assign value(s) for a custom field on a board
\nBody
\nsingle-select and multi-select custom fields)plain-text and date custom fields)To clear
\n","urlObject":{"protocol":"https","path":["v1","boards",":boardId","customfields",":customFieldId"],"host":["api","air","inc"],"query":[],"variable":[{"description":{"content":"the id of the board
\n","type":"text/plain"},"type":"any","value":null,"key":"boardId"},{"description":{"content":"the id of the custom field
\n","type":"text/plain"},"type":"any","value":null,"key":"customFieldId"}]}},"response":[{"id":"e70cef70-09a2-4106-91c1-9b38535fa3b9","name":"single-select","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"values\": [{\n \"id\": \"6e3f5f08-ab88-421b-867b-ed1a22cac88b\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/boards/7a2b9e34-bb38-4747-a838-3ffc32fdf43d/customfields/f6d3c43f-ba6e-48fa-bb6b-39fb7fda9448"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"844a1446-b251-46e3-a68b-6e5f4dacbc0e","name":"multi-select","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"values\": [{\n \"id\": \"6e3f5f08-ab88-421b-867b-ed1a22cac88b\"\n }, {\n \"id\": \"b69ea197-dd29-4e03-968d-ef1e336e1d09\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/boards/7a2b9e34-bb38-4747-a838-3ffc32fdf43d/customfields/f6d3c43f-ba6e-48fa-bb6b-39fb7fda9448"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"7dcd53a7-630b-42dd-8eab-f7f2cfc04e36","name":"plain-text","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"value\": \"abc123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/boards/7a2b9e34-bb38-4747-a838-3ffc32fdf43d/customfields/f6d3c43f-ba6e-48fa-bb6b-39fb7fda9448"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"9ef83f8d-de0e-40b7-93ee-92649eba77dd","name":"date","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"value\": \"2022-10-14 23:04:21.507866+00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/boards/7a2b9e34-bb38-4747-a838-3ffc32fdf43d/customfields/f6d3c43f-ba6e-48fa-bb6b-39fb7fda9448"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"11e3f6bb-3dae-4811-ad00-941fe1f172e9"},{"name":"/boards/:boardId/assets","id":"034c22ab-d2fd-42f5-9c15-bef63d43e9ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.air.inc/v1/boards/:boardId/assets","description":"Associates one or more assets to a board
\nBody
\nRemoves an asset from a board
\n","urlObject":{"protocol":"https","path":["v1","boards",":boardId","assets",":assetId"],"host":["api","air","inc"],"query":[],"variable":[{"description":{"content":"the id of the board
\n","type":"text/plain"},"type":"any","value":null,"key":"boardId"},{"description":{"content":"the id of the asset
\n","type":"text/plain"},"type":"any","value":null,"key":"assetId"}]}},"response":[{"id":"625c8625-9da8-4d64-b5f4-fdaaaf0e0e94","name":"Default","originalRequest":{"method":"DELETE","header":[],"url":"https://api.air.inc/v1/boards/74589af6-b056-42d5-8e26-17c00ccdb3d2/assets/9721a774-763b-483c-beb7-58222a5033cf"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ddb23d9c-a44d-44c8-b4dc-c9acc41076e7"},{"name":"/boards/:boardId/guests","id":"64d929e8-45e6-4ce9-94b3-d936489d058b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.air.inc/v1/boards/:boardId/guests?email=","description":"Get the list of guests of the board.
\n","urlObject":{"protocol":"https","path":["v1","boards",":boardId","guests"],"host":["api","air","inc"],"query":[{"description":{"content":"(optional) to filter with email
\n","type":"text/plain"},"key":"email","value":""}],"variable":[{"id":"35781637-d180-4048-8c47-da1dcd0e5b5a","description":{"content":"the id of the board
\n","type":"text/plain"},"type":"any","value":"","key":"boardId"}]}},"response":[{"id":"e0727604-a868-4477-b934-ffded9fade63","name":"Default","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.air.inc/v1/boards/:boardId/guests","protocol":"https","host":["api","air","inc"],"path":["v1","boards",":boardId","guests"],"variable":[{"key":"boardId","value":"","description":"the id of the board"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"1b8ffb73-5923-4d69-ad00-c0e26269f2e0\",\n \"email\": \"user@example.com\",\n \"roleId\": \"323c98fe-8676-4a06-ac17-23880d1883ef\",\n \"boardId\": \"21c79469-545e-4264-8e74-5557b72945d0\"\n }\n ]\n}"},{"id":"206b210b-0241-4a47-840b-7ff042b8a798","name":"Filter by email","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.air.inc/v1/boards/:boardId/guests?email=user@example.com","protocol":"https","host":["api","air","inc"],"path":["v1","boards",":boardId","guests"],"query":[{"key":"email","value":"user@example.com","description":"(optional) to filter guest by email"}],"variable":[{"key":"boardId","value":"","description":"the id of the board"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"1b8ffb73-5923-4d69-ad00-c0e26269f2e0\",\n \"email\": \"user@example.com\",\n \"roleId\": \"323c98fe-8676-4a06-ac17-23880d1883ef\",\n \"boardId\": \"21c79469-545e-4264-8e74-5557b72945d0\"\n }\n ]\n}"}],"_postman_id":"64d929e8-45e6-4ce9-94b3-d936489d058b"},{"name":"/boards/:boardId/guests","id":"8ba190aa-9fee-4891-9801-2d09443b71fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.air.inc/v1/boards/:boardId/guests","description":"Add a guest to the board.
\nBody
\nthe id of the board
\n","type":"text/plain"},"type":"any","value":"","key":"boardId"}]}},"response":[{"id":"768db550-8e5f-4869-a669-8be36d5975fb","name":"Default","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"user@example.com\",\n \"roleId\": \"323c98fe-8676-4a06-ac17-23880d1883ef\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.air.inc/v1/boards/:boardId/guests","protocol":"https","host":["api","air","inc"],"path":["v1","boards",":boardId","guests"],"variable":[{"key":"boardId","value":"","description":"the id of the board"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1b8ffb73-5923-4d69-ad00-c0e26269f2e0\",\n \"email\": \"user@example.com\",\n \"roleId\": \"323c98fe-8676-4a06-ac17-23880d1883ef\",\n \"boardId\": \"21c79469-545e-4264-8e74-5557b72945d0\"\n}"}],"_postman_id":"8ba190aa-9fee-4891-9801-2d09443b71fc"},{"name":"/boards/:boardId/guests/:guestId","id":"037b053d-cd71-400a-9fa8-cdf6b3fd10d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/boards/:boardId/guests/:guestId","description":"Change the role of a guest.
\nBody
\nthe id of the board
\n","type":"text/plain"},"type":"any","value":"","key":"boardId"},{"description":{"content":"the id of the guest
\n","type":"text/plain"},"type":"any","value":"","key":"guestId"}]}},"response":[{"id":"cafcdfa6-3549-4e1e-bac2-6fbe901ab0e9","name":"Default","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"roleId\": \"721a09f8-8aa8-4938-919f-07a3ccab7fd5\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.air.inc/v1/boards/:boardId/guests/:guestId","protocol":"https","host":["api","air","inc"],"path":["v1","boards",":boardId","guests",":guestId"],"variable":[{"key":"boardId","value":"","description":"the id of the board"},{"key":"guestId","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"037b053d-cd71-400a-9fa8-cdf6b3fd10d6"},{"name":"/boards/:boardId/guests/:guestId","id":"229100fd-2365-4383-87d5-533960140771","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.air.inc/v1/boards/:boardId/guests/:guestId","description":"Remove a guest from the board.
\n","urlObject":{"protocol":"https","path":["v1","boards",":boardId","guests",":guestId"],"host":["api","air","inc"],"query":[],"variable":[{"id":"596773c1-fdcb-4445-ba0f-c0ddfe74d06a","description":{"content":"the id of the board
\n","type":"text/plain"},"type":"any","value":"","key":"boardId"},{"id":"e0a1d16d-6192-4716-b1a8-671868f7e6cc","description":{"content":"the id of the guest
\n","type":"text/plain"},"type":"any","value":"","key":"guestId"}]}},"response":[{"id":"5bb61e60-743f-4d59-b1dd-44dadf5cfcfa","name":"Default","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.air.inc/v1/boards/:boardId/guests/:guestId","protocol":"https","host":["api","air","inc"],"path":["v1","boards",":boardId","guests",":guestId"],"variable":[{"key":"boardId","value":"","description":"the id of the board"},{"key":"guestId","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"229100fd-2365-4383-87d5-533960140771"}],"id":"2db4e08d-2279-4dca-8763-176f822dd8dc","description":"Boards are how assets are collected and organized in Air. They provide teams the ability to organize content visually, similarly to how folders provide structure to your computer's filesystem.
\nβ¨β¨One key difference between folders and boards is that Air supports an asset being located inside multiple boards without duplication of the asset. Organizational structures can also be created within boards via sub-boards for deeper asset organization.
\n","_postman_id":"2db4e08d-2279-4dca-8763-176f822dd8dc"},{"name":"Custom Fields","item":[{"name":"/customfields","id":"d4598ddd-dabe-45d8-9119-15e9efb9d22c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.air.inc/v1/customfields?name=:customFieldName&limit=:limit&cursor=:cursor","description":"List custom fields
\n","urlObject":{"protocol":"https","path":["v1","customfields"],"host":["api","air","inc"],"query":[{"description":{"content":"Free text search for custom field names matching criteria
\n","type":"text/plain"},"key":"name","value":":customFieldName"},{"description":{"content":"The number of records returned
\n","type":"text/plain"},"key":"limit","value":":limit"},{"description":{"content":"The cursor returned to from previous page of results
\n","type":"text/plain"},"key":"cursor","value":":cursor"}],"variable":[]}},"response":[{"id":"16035178-c6f8-4aa5-8f06-926b2cbb7873","name":"Default","originalRequest":{"method":"GET","header":[],"url":"https://api.air.inc/v1/customfields"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"7a2b9e34-bb38-4747-a838-3ffc32fdf43d\",\n \"name\": \"Status\",\n \"description\": \"The status of an asset\",\n \"createdAt\": \"2022-10-14 23:04:21.507866+00\",\n \"updatedAt\": \"2022-10-14 23:04:21.507866+00\",\n \"type\": \"single-select\"\n }\n ],\n \"pagination\": {\n \"hasMore\": false,\n \"cursor\": null\n },\n \"total\": 1\n}"}],"_postman_id":"d4598ddd-dabe-45d8-9119-15e9efb9d22c"},{"name":"/customfields/:customFieldId","id":"0bccd55c-62dc-42ea-9654-db92d461a2f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.air.inc/v1/customfields/:customFieldId","description":"Get a custom field
\n","urlObject":{"protocol":"https","path":["v1","customfields",":customFieldId"],"host":["api","air","inc"],"query":[],"variable":[{"description":{"content":"The id of the custom field
\n","type":"text/plain"},"type":"any","value":null,"key":"customFieldId"}]}},"response":[{"id":"d2709515-67cf-4aff-b5dd-da8cad0f9a0e","name":"Default","originalRequest":{"method":"GET","header":[],"url":"https://api.air.inc/v1/customfields/7a2b9e34-bb38-4747-a838-3ffc32fdf43d"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7a2b9e34-bb38-4747-a838-3ffc32fdf43d\",\n \"name\": \"Status\",\n \"description\": \"The status of an asset\",\n \"createdAt\": \"2022-10-14 23:04:21.507866+00\",\n \"updatedAt\": \"2022-10-14 23:04:21.507866+00\",\n \"type\": \"single-select\",\n \"values\": [\n {\n \"id\": \"883046ea-7beb-4830-bd01-e74bcd71faab\",\n \"name\": \"Pending\"\n },\n {\n \"id\": \"0e1e5725-393d-46d4-8e94-2e81031d1353\",\n \"name\": \"Approved\"\n },\n {\n \"id\": \"d5bf11d5-a093-401e-abac-0c77cc492d51\",\n \"name\": \"Rejected\"\n }\n ]\n}"}],"_postman_id":"0bccd55c-62dc-42ea-9654-db92d461a2f0"},{"name":"/customfields","id":"11a642fb-f5ff-4451-b12b-a3e353520427","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.air.inc/v1/customfields","description":"Create a custom field (maximum total allowed per workspace: 100)
Body
\nname - the name of the custom field
\ndescription - the description of the custom field
\ntype - the type of the custom field
\nvalues - the values of a single-select or multi-select custom field
Update one or more properties on a custom field
\nBody
\n*type is immutable due to workflows being built on top of custom fields
The id of the custom field to update
\n","type":"text/plain"},"type":"any","value":null,"key":"customFieldId"}]}},"response":[{"id":"f1ae2c30-e839-4f7b-8e80-f63f33774c65","name":"Default","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Publishable To\",\n \"description\": \"Where the asset can be published\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/customfields/fb9e852c-eb2a-4dd0-81f4-7af266c335d1"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"dfeb65af-ddc0-49a2-8e2d-a7ad4398e7b3"},{"name":"/customfields/:customFieldId:","id":"b33d95c4-8ddc-4417-94ae-f01f10126aac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.air.inc/v1/customfields/:customFieldId","description":"Delete a custom field
\n","urlObject":{"protocol":"https","path":["v1","customfields",":customFieldId"],"host":["api","air","inc"],"query":[],"variable":[{"id":"e0baf34e-2085-467e-a860-f7c72187a40f","description":{"content":"The id of the custom field to update
\n","type":"text/plain"},"type":"any","value":null,"key":"customFieldId"}]}},"response":[{"id":"8797971a-7c3a-45df-b576-6820325394bb","name":"Default","originalRequest":{"method":"DELETE","header":[],"url":"https://api.air.inc/v1/customfields/fb9e852c-eb2a-4dd0-81f4-7af266c335d1"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b33d95c4-8ddc-4417-94ae-f01f10126aac"},{"name":"/customfields/:customFieldId:/values","id":"d2ad162b-68c0-4f94-88e9-20bbfd48ecac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.air.inc/v1/customfields/:customFieldId/values","description":"Add a new value to a single-select or multi-select custom field.
Body
\nthe id of the custom field
\n","type":"text/plain"},"type":"any","value":null,"key":"customFieldId"}]}},"response":[{"id":"fc09fabb-0a75-4593-a437-aa8de6d4f0b6","name":"Default","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Twitter\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/customfields/fb9e852c-eb2a-4dd0-81f4-7af266c335d1/values"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6cb9809d-47da-4a5c-b4ee-1095beb22ada\",\n \"name\": \"Twitter\"\n}"}],"_postman_id":"d2ad162b-68c0-4f94-88e9-20bbfd48ecac"},{"name":"/customfields/:customFieldId:/values/:valueId","id":"55f15d22-ec8b-415e-af88-19250e73464e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://api.air.inc/v1/customfields/:customFieldId/values/:valueId","description":"Update one or more properties on a value
\n","urlObject":{"protocol":"https","path":["v1","customfields",":customFieldId","values",":valueId"],"host":["api","air","inc"],"query":[],"variable":[{"description":{"content":"the id of the custom field
\n","type":"text/plain"},"type":"any","value":null,"key":"customFieldId"},{"description":{"content":"the id of the custom field value
\n","type":"text/plain"},"type":"any","value":null,"key":"valueId"}]}},"response":[{"id":"31ad4e2c-d538-40b1-b371-a4e3bb4637d0","name":"Default","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Twitter\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/customfields/fb9e852c-eb2a-4dd0-81f4-7af266c335d1/values/6cb9809d-47da-4a5c-b4ee-1095beb22ada"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6cb9809d-47da-4a5c-b4ee-1095beb22ada\",\n \"name\": \"Twitter\"\n}"}],"_postman_id":"55f15d22-ec8b-415e-af88-19250e73464e"},{"name":"/customfields/:customFieldId:/values/:valueId","id":"c357b585-7a85-4595-aea7-254b2e162135","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.air.inc/v1/customfields/:customFieldId/values/:valueId","description":"Delete a value off of a custom field
\n","urlObject":{"protocol":"https","path":["v1","customfields",":customFieldId","values",":valueId"],"host":["api","air","inc"],"query":[],"variable":[{"description":{"content":"the id of the custom field
\n","type":"text/plain"},"type":"any","value":null,"key":"customFieldId"},{"description":{"content":"the id of the custom field value to delete
\n","type":"text/plain"},"type":"any","value":null,"key":"valueId"}]}},"response":[{"id":"269c879b-d68e-486c-affb-966c822a7a19","name":"Default","originalRequest":{"method":"PATCH","header":[],"url":"https://api.air.inc/v1/customfields/fb9e852c-eb2a-4dd0-81f4-7af266c335d1/values/6cb9809d-47da-4a5c-b4ee-1095beb22ada"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c357b585-7a85-4595-aea7-254b2e162135"}],"id":"1120fd82-c3e1-4e9f-acdf-078a33bd34fa","description":"Custom fields allow you to categorize your workspace content however makes most sense for you. Custom fields consist of a Title and a set of Values - once you create a custom field in your workspace, one or more of the values can be applied to any asset or board inside your workspace. Status, rating, usage rights, and assignee are default custom fields on each workspace, but these can also be customized to fit your teamsβ needs. Workspace's are limited to a total maxium of 100 custom fields.
Custom fields can be one of the following types:
\nsingle-select - one value can be selected
multi-select - multiple values can be selected
plain-text - free form text input (for more descriptive data)
date - date value (format: yyyy-mm-dd HH:mm:ss.SSS+00)
List tags in the workspace
\n","urlObject":{"protocol":"https","path":["v1","tags"],"host":["api","air","inc"],"query":[{"description":{"content":"Free text search for tag names matching criteria
\n","type":"text/plain"},"key":"name","value":":name"},{"description":{"content":"The number of records returned
\n","type":"text/plain"},"key":"limit","value":":limit"},{"description":{"content":"The cursor returned to from previous page of results
\n","type":"text/plain"},"key":"cursor","value":":cursor"}],"variable":[]}},"response":[{"id":"9a4a8493-a859-43d3-9c4d-b0a41d3f62da","name":"Default","originalRequest":{"method":"GET","header":[],"url":"https://api.air.inc/v1/tags"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"0ecb3be0-12ab-4b63-9a65-5ed2d3c119a8\",\n \"name\": \"Dog\"\n },\n {\n \"id\": \"fb9e852c-eb2a-4dd0-81f4-7af266c335d1\",\n \"name\": \"Cat\"\n },\n {\n \"id\": \"6cb9809d-47da-4a5c-b4ee-1095beb22ada\",\n \"name\": \"Mouse\"\n }\n ],\n \"pagination\": {\n \"hasMore\": false,\n \"cursor\": null\n },\n \"total\": 3\n}"}],"_postman_id":"3396f2aa-5bc0-4966-a4d1-b6e75ae4fd25"},{"name":"/tags","id":"0feeff50-10b1-4001-b59c-6e98ee712f00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.air.inc/v1/tags","description":"Create a new tag
\nBody
\nUpdate one or more properties on a tag
\n","urlObject":{"protocol":"https","path":["v1","tags",":tagId"],"host":["api","air","inc"],"query":[],"variable":[{"description":{"content":"the id of the tag
\n","type":"text/plain"},"type":"any","value":null,"key":"tagId"}]}},"response":[{"id":"87eb33e9-2380-4f0c-ad97-57abfebae2cd","name":"Default","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Dog\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.air.inc/v1/tags/6cb9809d-47da-4a5c-b4ee-1095beb22ada"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6cb9809d-47da-4a5c-b4ee-1095beb22ada\",\n \"name\": \"Dog\"\n}"}],"_postman_id":"0b98c18b-0307-4f63-a312-a0bcf36c0271"},{"name":"/tags/:tagId","id":"5c88f4e7-7776-41e3-99c2-281cbf44a2b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.air.inc/v1/tags/:tagId","description":"Delete a tag
\n","urlObject":{"protocol":"https","path":["v1","tags",":tagId"],"host":["api","air","inc"],"query":[],"variable":[{"description":{"content":"the id of the tag
\n","type":"text/plain"},"type":"any","value":null,"key":"tagId"}]}},"response":[{"id":"a40833dd-b349-4920-9edd-dfd047a2c962","name":"Default","originalRequest":{"method":"PATCH","header":[],"url":"https://api.air.inc/v1/tags/6cb9809d-47da-4a5c-b4ee-1095beb22ada"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5c88f4e7-7776-41e3-99c2-281cbf44a2b1"}],"id":"54941790-ac7b-4ae0-941b-4799df632088","description":"Tags allow you to set arbitrary values on assets to make organizing and searching easier. They are typically words or a phrase that are assigned to content. A single asset version can have multiple tags and that asset can live within multiple boards in the workspace. This differs from custom fields where values are assigned at the asset level.
\n","_postman_id":"54941790-ac7b-4ae0-941b-4799df632088"},{"name":"Uploads","item":[{"name":"/uploads","id":"54d85ed5-d342-4d8f-95f8-faff7676a94e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.air.inc/v1/uploads","description":"Upload an asset to a workspace
\nBody
\nCreate a part upload url
\nBody
\nPOST /uploadsPOST /uploadsComplete a large file upload
\nBody
\nPOST /uploadsPOST /uploadsThe upload endpoints allow you to add content into your Air workspace. For smaller files (<5GB) a signed url will be returned where the file can be uploaded to. For files >= 5GB in size they must be broken into 5GB chunks or less in a multipart upload workflow that consists of the following:
\nPOST /uploadsPOST uploads/uploadpartPOST uploads/completeMultipartCreate an import of an asset or asset version from a public URL.
\nsourceUrl - the URL to get the file content. The URL needs to be publicly accessible.
fileName (optional) - the name of the file. If not provided then it will be determined from the URL.
ext (optional) - the extension of the file. If not provided then the ext will be pulled from the URL or defaulted to .file
recordedAt (optional) - when the file was created. If not provided the servers current time will be used.
assetId (optional) - the parent asset to create a new version for this file under.
parentBoardId (optional) - the parent board to create the asset under.
customFields (optional) - the list of custom fields and values to assign to the asset.
tags (optional) - the list of tags to assign to the asset version.
title (optional) - the title to assign to the asset version.
description (optional) - the description to assign to the asset version.
Retrieve the status of a specific import by providing the import ID in the URL.
\nhttps://api.air.inc/v1/imports/:importId/statusThe body of the response will contain a JSON object with \"status\" and also \"error\" if the import is failed.
\nThe imports endpoints allow you to add content to your Air workspace from a publicly available URL and check on the import status.
\nUse the POST /imports endopint to create an import from a URL
Use the GET /imports/:importId/status endpoint to get the status of an import
Get the list of guest roles available in a workspace.
\n","urlObject":{"protocol":"https","path":["v1","roles"],"host":["api","air","inc"],"query":[{"description":{"content":"(required) to filter the roles by type
\n","type":"text/plain"},"key":"type","value":"guest"}],"variable":[]}},"response":[{"id":"37bed8cf-6e43-4cec-bff9-242323b2890c","name":"Default","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.air.inc/v1/roles?type=guest","protocol":"https","host":["api","air","inc"],"path":["v1","roles"],"query":[{"key":"type","value":"guest"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"721a09f8-8aa8-4938-919f-07a3ccab7fd5\",\n \"name\": \"Editor\",\n \"description\": \"Can edit all content on this board, but cannot delete the board itself\",\n \"billable\": true,\n \"type\": \"guest\"\n },\n {\n \"id\": \"323c98fe-8676-4a06-ac17-23880d1883ef\",\n \"name\": \"Commenter\",\n \"description\": \"Can view and comment, but cannot add, edit, or delete any content\",\n \"billable\": true,\n \"type\": \"guest\"\n },\n {\n \"id\": \"81d62292-2405-4533-a303-a1a4dc27721d\",\n \"name\": \"Viewer\",\n \"description\": \"Can view all content, but cannot view or contribute to discussions\",\n \"billable\": false,\n \"type\": \"guest\"\n }\n ]\n}"}],"_postman_id":"b274c753-5f50-474d-9600-d817639aaa2e"}],"id":"3191f7f5-0a9a-4f96-85c2-2636ebae9e39","description":"Roles are used to control access to various resources in Air. The roles endpoint allow you to retrieve the list of availalbe roles.
\nGET /roles endpoint to get the list of available roles