Skip to main content

86 docs tagged with "API"

View all tags

Administration

API reference for administration endpoints. Covers access control, permissions management, and feature module enablement.

API Playground

How to use the Amplience GraphQL Management API playground at api.amplience.net/graphql to build and test queries and mutations interactively.

APIs

Welcome section for the Amplience API documentation, linking to further information on the APIs that you can use to help build your apps with Amplience.

Asset search conventions

Conventions for the assetSearch query in the Amplience GraphQL Management API, including keyword rules, phrase matching and query examples.

Authorization

How to authorize access to the Content Management API and GraphQL Management API using OAuth2 tokens generated from an API key and secret.

Concepts

Core concepts for the Amplience GraphQL Management API, including the viewer, media hubs, asset repositories, folders and assets, plus organizations, CMS hubs and repositories.

Content delivery

Overview of Amplience content delivery APIs, including HTTP and GraphQL options for retrieving published content for websites and applications.

Content items

API reference for content item endpoints. Covers creating, updating, publishing, archiving, localizing, and searching content items.

Content management

Overview of the Amplience Content Management API for building back office applications, automations and webhook-based integrations.

Content repositories

API reference for content repository endpoints. Covers repository management, feature assignment, content type assignment, and sharing.

Content sync

API reference for content sync endpoints. Covers deep sync jobs, job status, cross-hub content repository mapping, and sync balance usage.

Content types

API reference for content type endpoints. Covers content type registration, updating, archiving, and assignment to repositories.

Conventions

GraphQL conventions for the Amplience GraphQL Management API, including connections, edges, nodes, pagination and the Relay cursor connections specification.

Cropping and rotation

Crop, edge crop, pre-crop, rotate, pre-rotate, and flip images with Amplience Dynamic Media using the Media Delivery API.

Directives

Reference for all GraphQL directives in the Amplience GraphQL Management API, including @deprecated, @skip, @include, and @specifiedBy.

Enums

Reference for all GraphQL enum types in the Amplience GraphQL Management API, including AssetType, AssetStatus, AssetPublishStatus, and all other enumerated values used in queries and mutations.

Events and editions

API reference for event and edition endpoints. Covers campaign events, scheduled editions, slots, and conflict resolution.

Examples

Query and mutation examples for the Amplience GraphQL Management API, including getting assets by ID, listing repositories and folders, and more.

Extensions and integrations

API reference for extension and integration endpoints. Covers UI extensions and Salesforce SFCC and SFMC integrations.

Filter

Developer guide for how to use the Amplience GraphQL Content Delivery API filter functionality, including how to list, sort and filter content, with examples.

Filter API

Guide to Amplience Content Delivery Filter API, including how to use the filter API, examples of listing, sorting and filtering content, and cURL examples.

Folders and hierarchy

API reference for folder and hierarchy endpoints. Covers folder management within repositories and hierarchy node operations.

Format and quality

Control Dynamic Media output format and compression with the Amplience Media Delivery API, including fmt, fmt=auto, quality settings, DPI, metadata stripping, and JPEG and PNG options.

Fresh API

The Fresh API retrieves content from Amplience CMS with no cache. It's specifically for use with static site generators, such as Next.js, NuxtJS and Gatsby.

Getting started

Getting started with the Amplience GraphQL Management API, with an example query to retrieve assets using the API playground.

GraphQL Management API

Overview of the Amplience GraphQL Management API for integrating back end systems with Amplience DAM and managing assets programmatically.

Hierarchy API

Guide to Amplience Content Delivery Hierarchy API that allows you to get all descendants of a hierarchy node

Hubs

API reference for hub endpoints. Covers hub management, settings, bulk operations, and sharing.

Image adjustments

Adjust images with Amplience Dynamic Media using the Media Delivery API - colour space, sharpening, composite modes, background colour, blur, noise reduction, gamma, hue, saturation, and brightness.

Inputs

Reference for all GraphQL input types in the Amplience GraphQL Management API. Input types define the arguments passed to mutations and queries, including asset creation, update, and filter inputs.

Inputs: Assets

GraphQL input types for asset creation, update, deletion, folders, repositories, and publishing in the Amplience GraphQL Management API.

Inputs: Commerce

GraphQL input types for commerce repository integrations in the Amplience GraphQL Management API.

Inputs: Content generation

GraphQL input types for content generation, content flow, content review, video transcoding, and AI image tools in the Amplience GraphQL Management API.

Inputs: Teams & users

GraphQL input types for teams, users, organizations, extensions, webhooks, transformation templates, preview keys, personal access tokens, and temp file upload in the Amplience GraphQL Management API.

Interfaces

Reference for all GraphQL interface types in the Amplience GraphQL Management API. Interfaces define shared fields across multiple implementing object types.

Introduction

Introduction to the GraphQL Management API, designed for building back-office applications and automating processes, use to query and report on assets.

Layers and text

Composite image and text layers onto an image with Amplience Dynamic Media, using Media Delivery API parameters for layer positioning, anchors, opacity, visibility, and canvas layers.

Legacy Content Delivery API

Reference for the original Amplience Content Delivery API (v1), now superseded by the HTTP Content Delivery API and GraphQL Content Delivery API.

Limits

Rate limits, mutation limits and complexity limits for the Amplience GraphQL Management API, including how complexity scores are calculated.

Limits

Usage limits for Amplience products and API, including limits for content and management APIs, Amplience CMS, Amplience DAM and Workforce.

Media delivery

Manipulate images on the fly with the features of Amplience Dynamic Media. Use the Dynamic Media playground to try out the features on the media delivery API.

Media Delivery API Guide

Reference guide to every parameter in the Amplience Media Delivery API, the URL-based API for Dynamic Media, covering image sizing, scaling, cropping, format and quality, adjustments, layers, metadata, sets, and video.

Media delivery API overview

Introduction to the Amplience Media Delivery API and Dynamic Media - transform, optimize, and deliver images, sets, and video from a single master asset using URL parameters.

Metadata

Retrieve and filter Amplience Dynamic Media asset metadata with the Media Delivery API, and reference metadata values in image queries.

Mutations

Full reference for all GraphQL mutations in the Amplience GraphQL Management API, including asset creation, publishing, video transcoding, AI image tools, content generation, organization and user management, commerce repositories, and media tools.

Mutations: AI image tools

GraphQL mutations for AI-powered image generation, background removal, magic erase, caption generation, and shoppable image detection in the Amplience GraphQL Management API.

Mutations: Assets

GraphQL mutations for creating, updating, deleting, and publishing assets, folders, and repositories in the Amplience GraphQL Management API.

Mutations: Commerce

GraphQL mutations for creating and managing commerce repository integrations in the Amplience GraphQL Management API.

Mutations: Content generation

GraphQL mutations for content generation sessions, jobs, flows, and content review in the Amplience GraphQL Management API.

Mutations: Media tools

GraphQL mutations for transformation templates, webhooks, preview keys, temporary file uploads, and extensions in the Amplience GraphQL Management API.

Mutations: Organization & users

GraphQL mutations for teams, users, organization invitations, roles, and personal access tokens in the Amplience GraphQL Management API.

Mutations: Video transcoding

GraphQL mutations for adding, reprocessing, and removing video transcoding profiles in the Amplience GraphQL Management API.

Objects

Reference for all GraphQL object types in the Amplience GraphQL Management API, including Asset, AssetFolder, AssetRepository, MediaHub, and all related response and connection types.

Objects: Assets

GraphQL object types for assets, folders, repositories, video transcoding, and AI image tools in the Amplience GraphQL Management API.

Objects: CMS

GraphQL object types for CMS hubs and repositories in the Amplience GraphQL Management API.

Objects: Commerce

GraphQL object types for commerce repositories, categories, and products in the Amplience GraphQL Management API.

Objects: Content generation

GraphQL object types for content generation, content flow, and content review in the Amplience GraphQL Management API.

Objects: Media tools

GraphQL object types for media hubs, transformation templates, webhooks, extensions, and preview keys in the Amplience GraphQL Management API.

Objects: Organization & users

GraphQL object types for organizations, teams, users, invitations, and personal access tokens in the Amplience GraphQL Management API.

Overview

The Amplience GraphQL Content Delivery API is designed to optimize content delivery by providing the tools to eliminate under fetching and over fetching.

Overview

The Amplience next generation of content delivery is optimized to be even faster, easier to use and more flexible, with delivery keys and formatting options.

Personal access tokens

How to create and manage personal access tokens (PATs) for the Content Management and GraphQL Management APIs using the API or Amplience CMS UI.

Queries

Full reference for all GraphQL queries available in the Amplience GraphQL Management API, including asset search, repository traversal, content generation, and commerce queries.

Reference

Complete GraphQL schema reference for the Amplience GraphQL Management API: queries, mutations, objects, inputs, enums, interfaces, unions, scalars, and directives.

Scalars

Reference for all scalar types in the Amplience GraphQL Management API, including custom scalars such as DateTime, JSON, BigDecimal, and BigInteger.

Search indexes

API reference for search index endpoints. Covers Algolia search index configuration, content type assignment, and analytics.

Sets

Retrieve images from an Amplience Dynamic Media set with the Media Delivery API, return set metadata as JSONP, JSON, XML, text, or HTML, and use SEO-friendly set URLs.

Sizing and scaling

Resize and scale images with Amplience Dynamic Media using the Media Delivery API parameters w, h, maxW, maxH, scale modes, point of interest, resize filters, and upscale behaviour.

Snapshots and publishing jobs

API reference for snapshot and publishing job endpoints. Covers immutable content snapshots and publishing job management.

Temporary file service

Use the Amplience temporary file service to work with assets not stored in Amplience DAM. Supports single uploads up to 100MB and multipart uploads up to 2GB, for use with APIs such as the Background Removal API

The content rendering service

The Amplience content rendering service automates combining JSON content with handlebars templates to generate HTML that can be added to a page on your website.

Unions

Reference for all GraphQL union types in the Amplience GraphQL Management API. Union types can resolve to one of several concrete object types.

Usage

How to authenticate and make requests to the Amplience GraphQL Management API endpoint, including obtaining OAuth2 access tokens.

Using the Content Management API

Overview of the Content Management API, covering API keys and secrets, how to get and include tokens, fair usage, rate limits and additional features.

Variables and conditionals

Build adaptive Amplience Dynamic Media image URLs with the Media Delivery API using variables, conditionals, expressions, and the img404 fallback for missing assets.

Video

Deliver video with Amplience Dynamic Media and the Media Delivery API, including transcode profiles, HTTPS delivery, thumbnails, video metadata, and HTML video embeds.

Virtual staging

How to use the Amplience Virtual Staging API to generate a timestamp or snapshot-specific virtual staging domain for previewing unpublished content.

Webhooks

API reference for webhook endpoints. Covers webhook configuration, request history, and resending.

Workflows and localization

API reference for workflow and localization endpoints. Covers workflow states, locale assignment, and localization group management.

Workforce API

How to use the Amplience Workforce API to submit content generation jobs using the GraphQL Management API, including briefs, brand voices and audiences.

Workforce integration overview

Overview of how to integrate the Amplience Workforce API with your existing content workflow using webhooks or polling to manage AI-generated content.