{ "swagger": "2.0", "info": { "title": "Agravity OpenAPI Documentation - Public Functions", "description": "
The Agravity Public API provides comprehensive access to digital asset management functionality for technical integrations, portals, and third-party applications. These endpoints are designed for programmatic access with API key authentication.
All endpoints (except public share endpoints) require API key authentication. The API key can be provided:
Portal endpoints may have additional authentication methods (OAuth, Azure AD, Auth0, password) depending on portal configuration.
For technical support or integration questions, contact support@agravity.io or visit https://agravity.io.
Copyright © Agravity GmbH 2026. All Rights Reserved
", "contact": { "name": "Agravity GmbH", "url": "https://agravity.io", "email": "support@agravity.io" }, "version": "10.3.0" }, "host": "devagravitypublic.azurewebsites.net", "basePath": "/api", "schemes": [ "https" ], "paths": { "/portals/{id}": { "get": { "tags": [ "Public Portal Management" ], "description": "This endpoint return the created portal by ID.", "operationId": "HttpPortalsGetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The ID of the portal.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns on portal from database.", "schema": { "$ref": "#/definitions/portal" } }, "401": { "description": "Unauthorized. API Key not provided." }, "500": { "description": "Internal server error. Please contact administrator." } }, "security": [ { "function_key": [] } ] } }, "/portals/{id}/config": { "get": { "tags": [ "Public Portal Management" ], "description": "This endpoint returns a full configuration of the portal. Incl. download formats, SDLs, UDLs, etc.", "operationId": "HttpPortalsConfigurationGetById", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The ID of the portal.", "required": true, "type": "string" }, { "in": "query", "name": "translations", "description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)", "type": "boolean" }, { "in": "header", "name": "Accept-Language", "description": "The requested language of the response. If not matching it falls back to default language.", "type": "string" } ], "responses": { "200": { "description": "Returns a full configuration of a portal.", "schema": { "$ref": "#/definitions/portalConfiguration" } }, "401": { "description": "Unauthorized. API Key not provided." }, "500": { "description": "Internal server error. Please contact administrator." } }, "security": [ { "function_key": [] } ] } }, "/portalsenhancetoken": { "post": { "tags": [ "Public Portal Management" ], "description": "This endpoint saves the portal user and returns CustomClaimsProviderResponseContentTokenIssuanceStart which is used to enhance the token with user context,...", "operationId": "HttpPortalsEnhanceToken", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns CustomClaimsProviderResponseContentTokenIssuanceStart.", "schema": { "$ref": "#/definitions/customClaimsProviderResponseContentTokenIssuanceStart" } }, "401": { "description": "Unauthorized. API Key not provided." }, "500": { "description": "Internal server error. Please contact administrator." } }, "security": [ { "function_key": [] } ] } }, "/portalssaveuserattributes": { "post": { "tags": [ "Public Portal Management" ], "description": "This endpoint saves the portal user attributes", "operationId": "HttpPortalsSavePortalUserAttributes", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns CustomClaimsProviderResponseContentAttributeCollectionSubmit", "schema": { "$ref": "#/definitions/customClaimsProviderResponseContentAttributeCollectionSubmit" } }, "401": { "description": "Unauthorized. API Key not provided." }, "500": { "description": "Internal server error. Please contact administrator." } }, "security": [ { "function_key": [] } ] } }, "/portals/{id}/zip": { "post": { "tags": [ "Public Portal Management" ], "description": "Initiates the ZIP creation of an asset basket from an portal.", "operationId": "HttpPortalRequestZipById", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "The ID of the portal.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "The allowed formats are the input which could be added.", "required": true, "schema": { "$ref": "#/definitions/downloadZipRequest" } } ], "responses": { "201": { "description": "Returns the portal with the given ID.", "schema": { "$ref": "#/definitions/downloadZipRequest" } }, "400": { "description": "Not valid portal id! (Code: 00b410fe-97d1-4952-ba0b-327d22514934)