{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3e62d3a2-b935-4021-beb2-84c1bbbf6414","name":"Globaledit API Documentation","description":"Reach out to your account manager or [support@globaledit.com](mailto:support@globaledit.com) to receive an API key for your organization.\n\nThe globaledit API can be used to automate repetitive tasks or integrate with external services. Globaledit can also work with your team to build custom integrations and automations.\n\n---\n\n# Authorization\n\nGlobaledit customers can authenticate requests with a provided globaledit API key. The `x-globaledit-api-key` header is used to authenticate requests. Each API key is paired with a \"user ID\". An API key \"user ID\" does not represent an actual globaledit user, but is instead used to define the scope for the API key. The \"user ID\" can be passed in the `x-globaledit-userid` header to act with the scope of the API key.\n\nThe `x-globaledit-userid` header can also be used to perform actions on behalf of a user. For example: _Get Collections_ will not return results unless paired with an `x-globaledit-userid` header corresponding to an actual globaledit user ID, since collections are unique for each user. For some actions, (e.g. Upload Asset) a user ID header corresponding to an actual globaledit user is required.\n\n---\n\n# Entities and Library Structure\n\n## Library\n\nEach globaledit customer is considered an **Organization.** The separate sections within an organization are called **Accounts.** Accounts contain **Workspaces**, and workspaces contain a hierarchical structure of **Folders.** Each folder can contain up to 5000 **Assets.**\n\n## **Collections**\n\n**Collections** are a group of assets from a specific account. Assets can be added and removed from collections without deleting them from the library. Collections are only visible to the owner of the collection or to users with whom the collection is shared.\n\n**Projects** are a type of collection with some additional features. Projects can contain assets from only one folder, according to the project's rules (e.g. only assets rated Select). Projects can also be assigned to specific users and marked complete by those users.\n\n---\n\n# Permissions and Scope\n\nGlobaledit provides granular access controls for each user, in relation to each resource. Many API endpoints require **scopeType** and **scopeId** query parameters to define the context the action is being performed from.\n\nA specific user or a specific API key may have different permissions in different scopes. For example: a user may not be able to edit metadata for Library assets, but might be able to edit metadata for those same assets if shared with the user in a collection with elevated permissions.\n\nThe [Update Metadata Values](#0fc1ae69-2213-47e4-b83a-c3f43cd3b27a) endpoint can be used with `\"scopeType\": \"workspace\"` and `\"scopeId\": 12373` (the ID of the asset's workspace) to update an assets metadata from the library. Or the [Update Metadata Values](#0fc1ae69-2213-47e4-b83a-c3f43cd3b27a) endpoint could be used with `\"scopeType\": \"collection\"` and `\"scopeId\": \"816e3f92-cb1b-11ec-9d64-0242ac120002\"` (the ID of a collection the asset is in).\n\n---\n\n# Rate Limits\n\nBy default, each Organization's API keys share the following rate limits:\n\n| **Interval** | **Limit** |\n| --- | --- |\n| Per Second | 30 Requests (20 Burst Requests) |\n| Per Day | 10,000 Requests |\n\n---\n\n# Asset Uploads\n\nUploading Assets to globaledit is a multi-step process, and differs depending on if you are uploading an original asset, or a new version of an asset.\n\n## Upload an Original Asset:\n\n1. The [Initiate Asset Upload](#0b43c429-cfd8-49a9-8ee9-29597b8ddb30) endpoint registers the asset in globaledit and returns temporary security credentials from AWS STS that can be used to upload the asset to S3.\n2. Given the S3 STS credentials: initiate, upload and finish the upload to S3 with the AWS S3 API. This can be done as a multipart upload.\n3. Optionally, the [Get Asset Upload Status](#cfc9b3ed-7fc3-4a69-a7e6-30eecdacc692) endpoint can be used to confirm the upload is complete.\n    \n\n## Upload a New Version of an Asset:\n\n1. The [Initiate Asset Version Upload](#ea0e9203-c5d7-4c1b-b332-9bf141a9f84b) endpoint registers the asset in globaledit and returns an AWS S3 presigned URL. If the asset is over 150MB then a series of multipart presigned URLs will be returned to perform a multipart upload.\n2. If performing a multipart upload then _Finish Asset Version Upload_ must be called after uploading each part. The eTags for the partsData can be found in the headers of the responses from S3 when uploading each part.\n3. Optionally, the [Get Asset Upload Status](#cfc9b3ed-7fc3-4a69-a7e6-30eecdacc692) endpoint can be used to confirm the upload is complete.\n    \n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"16561413","collectionId":"3e62d3a2-b935-4021-beb2-84c1bbbf6414","publishedId":"UzkTWvup","public":true,"publicUrl":"https://api-docs.globaledit.com","privateUrl":"https://go.postman.co/documentation/16561413-3e62d3a2-b935-4021-beb2-84c1bbbf6414","customColor":{"top-bar":"000","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"000","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"000","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-06-14T21:00:05.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://globaledit.com/favicon.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://api-docs.globaledit.com/view/metadata/UzkTWvup"}