{ "info": { "_postman_id": "45af309a-6e49-47c1-9b06-a27abcc6e7b9", "name": "Prezent Platform Audiences File Access API", "description": "The Prezent Platform API exposes Prezent's AutoGenerator, Template Converter,\nAudiences, Themes, and File-upload services as a uniform JSON HTTP API.\n\nThis contract describes the **target agent-ready shape** of the API: every\ndocumented endpoint returns a uniform success envelope `{ \"success\": true,\n\"data\": { ... } }` or a uniform error envelope `{ \"success\": false,\n\"data\": null, \"error\": { \"code\": \"...\", \"message\": \"...\", \"details\": { ... } } }`.\nError codes are drawn from a stable catalog (see `ErrorCode`). The contract\nis additive: handlers may continue to emit legacy keys alongside the\ndocumented ones for backwards compatibility, so schemas explicitly allow\nadditional properties at the envelope and data levels.\n\nSeveral endpoints kick off long-running background work and return a\n`callback_id` that the client polls against a corresponding status\nendpoint. The canonical async polling endpoint for the Template Converter\nfamily is **`GET /api/v2/template-converter/status/{callback_id}`** which\nuses strict HTTP-status mapping (200 only on workflow success, 4xx/5xx on\nworkflow failure). The v1 polling endpoint at\n`/api/v1/template-converter/status/{callbackId}` (and its REST alias\n`GET /api/v1/template-conversions/{callback_id}`) continues to be served\nwith legacy semantics (HTTP 200 with `status` field) and is intentionally\nomitted from this documentation.\n\n**REST resource aliases (v1.1).** AutoGenerator and Template Converter\nendpoints are documented here under their REST-resource path names\n(`/api/v1/autogenerations`, `/api/v1/template-conversions`). The legacy\nRPC-style paths under `/api/v1/autogenerator/*` and\n`/api/v1/template-converter/*` continue to be served indefinitely; they\nreturn a `Deprecation: true` header pointing to the successor alias.\n\n**Conventions that apply to every endpoint** (full reference in the\ncompanion guides on this documentation site):\n\n- **Auth:** API key as a Bearer token \u2014 `Authorization: Bearer `.\n Each key is scoped to an allow-list of endpoint paths; an out-of-scope\n call returns `404 ENDPOINT_NOT_FOUND`.\n- **Rate limits:** gateway throttle 10 req/s sustained, 5 burst,\n 1,000 req/day per key; per-company per-category 60-second sliding\n windows; annual quotas (50,000 slide generations/yr, 1,000,000\n downloads/yr). Limit breaches return `429` with `error.code`\n `TOO_MANY_REQUESTS` (gateway), `RATE_LIMIT_EXCEEDED` (per-category),\n or `USAGE_LIMIT_EXCEEDED` (annual).\n- **Errors:** every error uses the `{ success:false, data:null, error:{\n code, message, details } }` envelope with stable, documented `code`\n values.\n- **Idempotency & pagination:** mutating requests accept an\n `Idempotency-Key`; list endpoints accept opt-in `limit`/`cursor`\n paging.\n\n**Building with an AI agent?** Prezent ships a first-class Model Context\nProtocol (MCP) server. The hosted endpoint is\n`https://mcp.myprezent.com/mcp` (OAuth 2.1, works with Claude.ai Custom\nConnectors); a local stdio server is published on PyPI as\n`prezent-mcp-server` and plugs into Claude Desktop, Cursor, Cline,\nContinue, and Zed. The MCP tools wrap the same REST endpoints\ndescribed here.\n\n**Official SDKs.** Typed REST clients are published for Python and\nTypeScript (`prezent-sdk`) \u2014 generated from and versioned against this\nspec. For other languages, generate a client from this document.\n\n**Out of scope of this document:** SCIM endpoints under `/api/v1/scim/*`.\nThose endpoints conform to RFC 7644 (SCIM 2.0) and follow a different\nenvelope (`schemas`, `Resources`, `totalResults`, etc.). They are\ndocumented separately at /docs/scim-user-management.\n\n\nContact Support:\n Name: Prezent API Support\n Email: support@prezent.ai", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:40:14.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "lastUpdatedBy": "35240", "uid": "35240-45af309a-6e49-47c1-9b06-a27abcc6e7b9" }, "item": [ { "name": "api", "item": [ { "name": "v1", "item": [ { "name": "access-tokens", "item": [ { "name": "Create signed access tokens for stored files", "id": "ee6641cf-d18f-4976-beaf-ef49ba762db8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"filePaths\": [\n \"\"\n ],\n \"source\": \"betaimages\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "access-tokens" ] }, "description": "Returns short-lived per-file access tokens that allow the caller\nto download the referenced files from the underlying storage\nbackend.\n" }, "response": [ { "id": "1fb5ce38-b171-4eff-81d3-32ac5e3a0d27", "name": "Tokens minted.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"filePaths\": [\n \"\"\n ],\n \"source\": \"betaimages\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "access-tokens" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"access_tokens\": {\n \"in_\": \"\"\n },\n \"message\": \"\"\n },\n \"success\": \"\"\n}", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-1fb5ce38-b171-4eff-81d3-32ac5e3a0d27" }, { "id": "9e839401-0b55-40bf-9892-85dbd31b9d9c", "name": "Generic client error. `error.code` is one of `BAD_REQUEST`, `INVALID_JSON`, `MISSING_REQUIRED_FIELD`, `MISSING_QUERY_PARAM`, `MISSING_CALLBACK_ID`, `MISSING_SLIDES_ARRAY`, `MISSING_PROMPT`, `MISSING_TEMPLATE_ID`, `MISSING_FILE_CONTENT`, `MISSING_SHARE_DET", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"filePaths\": [\n \"\"\n ],\n \"source\": \"betaimages\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "access-tokens" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": null,\n \"error\": {\n \"code\": \"RATE_LIMIT_EXCEEDED\",\n \"message\": \"\",\n \"details\": {\n \"exercitationb7\": 44075121.55928588,\n \"nostrud0\": -25302150.007800072\n }\n }\n}", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-9e839401-0b55-40bf-9892-85dbd31b9d9c" }, { "id": "e394df57-640a-4d3d-b570-6733cffc67b5", "name": "Caller did not present a valid Bearer token, or the token has\nexpired. `error.code` is one of `UNAUTHORIZED`, `INVALID_API_KEY`,\n`EXPIRED_API_KEY`.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"filePaths\": [\n \"\"\n ],\n \"source\": \"betaimages\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "access-tokens" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": null,\n \"error\": {\n \"code\": \"RATE_LIMIT_EXCEEDED\",\n \"message\": \"\",\n \"details\": {\n \"exercitationb7\": 44075121.55928588,\n \"nostrud0\": -25302150.007800072\n }\n }\n}", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-e394df57-640a-4d3d-b570-6733cffc67b5" }, { "id": "74dea679-db9d-4c30-b518-619ac3442a6c", "name": "Caller is authenticated but not allowed to perform this operation. `error.code` is `FORBIDDEN`.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"filePaths\": [\n \"\"\n ],\n \"source\": \"betaimages\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "access-tokens" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": null,\n \"error\": {\n \"code\": \"RATE_LIMIT_EXCEEDED\",\n \"message\": \"\",\n \"details\": {\n \"exercitationb7\": 44075121.55928588,\n \"nostrud0\": -25302150.007800072\n }\n }\n}", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-74dea679-db9d-4c30-b518-619ac3442a6c" }, { "id": "ffddf07b-0024-4117-b705-0f8271c270b4", "name": "Requested endpoint or resource does not exist. `error.code` is\none of `ENDPOINT_NOT_FOUND`, `RESOURCE_NOT_FOUND`, `NOT_FOUND`.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"filePaths\": [\n \"\"\n ],\n \"source\": \"betaimages\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "access-tokens" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": null,\n \"error\": {\n \"code\": \"RATE_LIMIT_EXCEEDED\",\n \"message\": \"\",\n \"details\": {\n \"exercitationb7\": 44075121.55928588,\n \"nostrud0\": -25302150.007800072\n }\n }\n}", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-ffddf07b-0024-4117-b705-0f8271c270b4" }, { "id": "2d964c89-2ebf-422d-b683-328ac6d8bc91", "name": "Request was well-formed but failed semantic validation.\n`error.code` is one of `INVALID_INPUT`, `UNPROCESSABLE_ENTITY`.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"filePaths\": [\n \"\"\n ],\n \"source\": \"betaimages\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "access-tokens" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": null,\n \"error\": {\n \"code\": \"RATE_LIMIT_EXCEEDED\",\n \"message\": \"\",\n \"details\": {\n \"exercitationb7\": 44075121.55928588,\n \"nostrud0\": -25302150.007800072\n }\n }\n}", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-2d964c89-2ebf-422d-b683-328ac6d8bc91" }, { "id": "a2be0ba6-fc8b-48a5-99d7-9611a9b7859a", "name": "Rate limit, usage limit, or gateway-level throttle exceeded.\n`error.code` is `TOO_MANY_REQUESTS` (gateway throttle),\n`RATE_LIMIT_EXCEEDED` (per-category), or `USAGE_LIMIT_EXCEEDED`\n(annual quota).\n\nDefault limits (all configurable per company/key):\n- Gate", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"filePaths\": [\n \"\"\n ],\n \"source\": \"betaimages\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "access-tokens" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": null,\n \"error\": {\n \"code\": \"RATE_LIMIT_EXCEEDED\",\n \"message\": \"\",\n \"details\": {\n \"exercitationb7\": 44075121.55928588,\n \"nostrud0\": -25302150.007800072\n }\n }\n}", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-a2be0ba6-fc8b-48a5-99d7-9611a9b7859a" }, { "id": "acb82ca6-6098-4d70-ae00-c5738539c211", "name": "Unexpected server error. `error.code` is `INTERNAL_SERVER_ERROR`.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"filePaths\": [\n \"\"\n ],\n \"source\": \"betaimages\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "access-tokens" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": null,\n \"error\": {\n \"code\": \"RATE_LIMIT_EXCEEDED\",\n \"message\": \"\",\n \"details\": {\n \"exercitationb7\": 44075121.55928588,\n \"nostrud0\": -25302150.007800072\n }\n }\n}", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-acb82ca6-6098-4d70-ae00-c5738539c211" }, { "id": "da06b46c-5731-4c23-b6ce-fbbeb243bdf8", "name": "Service is temporarily unavailable (downstream dependency unhealthy). `error.code` is `SERVICE_UNAVAILABLE` or `EXTERNAL_SERVICE_ERROR`.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"filePaths\": [\n \"\"\n ],\n \"source\": \"betaimages\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "access-tokens" ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": null,\n \"error\": {\n \"code\": \"RATE_LIMIT_EXCEEDED\",\n \"message\": \"\",\n \"details\": {\n \"exercitationb7\": 44075121.55928588,\n \"nostrud0\": -25302150.007800072\n }\n }\n}", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-da06b46c-5731-4c23-b6ce-fbbeb243bdf8" }, { "id": "812c81ab-f1a3-4370-b9fe-e3a307632620", "name": "A downstream call timed out. `error.code` is `GATEWAY_TIMEOUT`.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"filePaths\": [\n \"\"\n ],\n \"source\": \"betaimages\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "access-tokens" ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": null,\n \"error\": {\n \"code\": \"RATE_LIMIT_EXCEEDED\",\n \"message\": \"\",\n \"details\": {\n \"exercitationb7\": 44075121.55928588,\n \"nostrud0\": -25302150.007800072\n }\n }\n}", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-812c81ab-f1a3-4370-b9fe-e3a307632620" } ], "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-ee6641cf-d18f-4976-beaf-ef49ba762db8" } ], "id": "9f637a03-9030-43b5-bd31-a6f6a812ff3a", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-9f637a03-9030-43b5-bd31-a6f6a812ff3a" } ], "id": "20bd87b1-231c-4231-8a59-31016fd1f587", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-20bd87b1-231c-4231-8a59-31016fd1f587" } ], "id": "30348fa5-06b9-46e3-8e1e-48f92b8c43c8", "createdAt": "2026-07-28T02:40:15.000Z", "updatedAt": "2026-07-28T02:40:15.000Z", "uid": "35240-30348fa5-06b9-46e3-8e1e-48f92b8c43c8" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.prezent.ai" } ] }