Platform & API

An API key lets your own apps and scripts use the project's assets through the Assets REST API. To create one, open a project in Assets, choose Platform → API → API Keys in the sidebar, then Create key.

1. Type a Key name, such as the app that will use it. It's required.
2. Under Permissions, pick Read and Write for each resource, or use Read only (the default), Full access or Clear. A key needs at least one permission.
3. Optional: pick an Expires date in the future. Left empty, the key never expires.
4. Choose Create key.

Assets then shows the key's secret, which starts with gk_live_, in Save your secret key. Copy it with Copy secret, or copy the whole Authorization: Bearer … header. Assets shows the secret only once and keeps no readable copy; if you lose it, rotate the key.

Each API key works only in the project it was created in, and only for what its permissions allow:

• Assets: read lists, searches and fetches assets; write creates, updates and deletes them.
• Collections and Folders: read lists and fetches them; write creates, updates and deletes them.
• Tags: read lists the project's tags.
• Upload: write prepares uploads and commits the files.
• Delivery: read gets an asset's delivery status and signed addresses; write turns delivery on or off.

Write permission includes read for the same resource. A request with a revoked, expired or deleted key, or one without the permission it needs, is refused.

The figures across the top of API Keys count the project's API keys (and how many have been used), and how many are Active, Expired and Revoked. Each row shows the key's name and the start of its secret, its permissions, its status (Active, Expired or Revoked), when it was last used and when it expires. Filter by status, or search by name.

Each row's ⋯ menu has these actions:

• Rotate secret: makes a new secret, shown once, and stops the old one immediately. Update your app before you rotate.
• Revoke: Assets asks first, then apps using the key lose access immediately. The key stays in the list as Revoked.
• Delete: Assets asks first, then removes the key, which stops working.

Platform → API → API Reference lists every endpoint, each with a cURL command you can copy and run. Its Getting started panel shows the base URL, which is your Assets address followed by /api/v1, and the header every request needs: Authorization: Bearer and your key's secret.

• Assets: list, create, get, update and delete assets, and download an original.
• Upload: presign an upload, then commit it.
• Collections, Folders and Tags: list them.
• Delivery: turn delivery on or off for an asset, and get a delivery address for it, signed when the project requires signed addresses.

Each endpoint names the permission it needs, and a key without it gets an error.

Platform → API → Delivery Settings is the policy every public delivery address follows in the project. Changes wait for Save Changes; Discard drops them.

• Output limits: Max width and Max height (4000 px each to start) and Max area (25 MP to start). Addresses asking for more are refused.
• Formats & effects: the Output formats and Effects addresses can use. All are allowed to start; All and None select or clear a group. At least one format is required.
• Require signed URLs: every address then needs a signature from the API's delivery endpoint. Existing unsigned links stop working once you save it on.
• Referrer allowlist: one website per line. Only pages on those sites can load the files; left empty, every site can.

Whether addresses can transform images at all is the URL transforms setting under Settings → General. See Delivery.

Platform → Integrations lists the tools Assets works with, by category. Google Drive is the account you connect here: under Your connections, choose Connect on Google Drive and sign in to Google. Once it's connected, Import files opens External Uploads and Disconnect unlinks it. The connection belongs to you, so it's the same one External Uploads uses, in every project.

The API keys button at the top opens API Keys. Importing from Drive is covered in Uploads and requests.

To take data out of a project, choose Platform → Data Export and set up the export under Configure export.

• Scope: the whole Project, one Collection, one Folder, or a Search filter that matches name, format, type and tags.
• Format: CSV for spreadsheet rows, JSON for full records, or ZIP for the original files with their metadata.
• Fields: the columns to include, all of them to start: name, type, format, folder, status, tags, description, size, dimensions, created and modified.
• Includes: add Versions, Comments and Rights records. A ZIP also keeps the Folder structure unless you turn it off.

Choose Run export. The file downloads straight away, and the Summary shows what's in scope first. A ZIP can hold up to 1,000 files and 500 MB.

Export history lists every run, newest first, with failed ones. Use these settings in a run's menu loads its setup again.