{ "info": { "_postman_id": "aec479cd-4548-48ea-8171-910f888f0c52", "name": "Clerk Backend Account Portal Agent Tasks API", "description": "The Clerk REST Backend API, meant to be accessed by backend servers.\n\n### Versions\n\nWhen the API changes in a way that isn't compatible with older versions, a new version is released.\nEach version is identified by its release date, e.g. `2025-04-10`. For more information, please see [Clerk API Versions](https://clerk.com/docs/versioning/available-versions).\n\nPlease see https://clerk.com/docs for more information.\n\nContact Support:\n Name: Clerk Platform Team\n Email: support@clerk.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:22:17.000Z", "updatedAt": "2026-07-28T01:22:17.000Z", "lastUpdatedBy": "35240", "uid": "35240-aec479cd-4548-48ea-8171-910f888f0c52" }, "item": [ { "name": "agents", "item": [ { "name": "tasks", "item": [ { "name": "{agent_task_id}", "item": [ { "name": "revoke", "item": [ { "name": "Revoke Agent Task", "id": "974ebcc0-165d-403d-aae3-5127e6f6835b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/agents/tasks/:agent_task_id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "agents", "tasks", ":agent_task_id", "revoke" ], "variable": [ { "id": "fd906ef4-704d-4a0b-95b4-a5ef9d86e189", "key": "agent_task_id", "value": "", "description": "(Required) The ID of the agent task to be revoked." } ] }, "description": "Revokes a pending agent task." }, "response": [ { "id": "4eb0bb8a-22b4-468d-9a63-28cf344ffc8f", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agents/tasks/:agent_task_id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "agents", "tasks", ":agent_task_id", "revoke" ], "variable": [ { "key": "agent_task_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"agent_task\",\n \"agent_id\": \"\",\n \"agent_task_id\": \"\",\n \"task_id\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-4eb0bb8a-22b4-468d-9a63-28cf344ffc8f" }, { "id": "31f67221-eba1-4519-9ba2-237d648e3a2b", "name": "Request was not successful", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agents/tasks/:agent_task_id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "agents", "tasks", ":agent_task_id", "revoke" ], "variable": [ { "key": "agent_task_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-31f67221-eba1-4519-9ba2-237d648e3a2b" }, { "id": "f14734c4-54a3-49ac-8468-22a5045dd0f4", "name": "Resource not found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agents/tasks/:agent_task_id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "agents", "tasks", ":agent_task_id", "revoke" ], "variable": [ { "key": "agent_task_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-f14734c4-54a3-49ac-8468-22a5045dd0f4" } ], "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-974ebcc0-165d-403d-aae3-5127e6f6835b" } ], "id": "88b9bb23-adee-4544-b013-2ae64a05bad7", "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-88b9bb23-adee-4544-b013-2ae64a05bad7" } ], "id": "f006de69-fcb8-43f1-88fc-b4f59d97a5b6", "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-f006de69-fcb8-43f1-88fc-b4f59d97a5b6" }, { "name": "Create Agent Task", "id": "18a55530-fc93-46be-b682-93cdacf41f3d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"on_behalf_of\": {\n \"user_id\": \"\",\n \"identifier\": \"\"\n },\n \"permissions\": \"*\",\n \"agent_name\": \"\",\n \"task_description\": \"\",\n \"redirect_url\": \"\",\n \"session_max_duration_in_seconds\": 1800\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agents/tasks", "host": [ "{{baseUrl}}" ], "path": [ "agents", "tasks" ] }, "description": "Create an agent task on behalf of a user.\nThe response contains a URL that, when visited, creates a session for the user.\nThe agent_id is stable per agent_name within an instance. The agent_task_id is unique per call." }, "response": [ { "id": "da3cce86-8816-4ebc-8ad1-0c7f03e49dcd", "name": "Success", "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 \"on_behalf_of\": {\n \"user_id\": \"\",\n \"identifier\": \"\"\n },\n \"permissions\": \"*\",\n \"agent_name\": \"\",\n \"task_description\": \"\",\n \"redirect_url\": \"\",\n \"session_max_duration_in_seconds\": 1800\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agents/tasks", "host": [ "{{baseUrl}}" ], "path": [ "agents", "tasks" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"agent_task\",\n \"agent_id\": \"\",\n \"agent_task_id\": \"\",\n \"task_id\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-da3cce86-8816-4ebc-8ad1-0c7f03e49dcd" }, { "id": "ebbd96b1-21e8-4322-9939-08b9c611f6d6", "name": "Request was not successful", "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 \"on_behalf_of\": {\n \"user_id\": \"\",\n \"identifier\": \"\"\n },\n \"permissions\": \"*\",\n \"agent_name\": \"\",\n \"task_description\": \"\",\n \"redirect_url\": \"\",\n \"session_max_duration_in_seconds\": 1800\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agents/tasks", "host": [ "{{baseUrl}}" ], "path": [ "agents", "tasks" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-ebbd96b1-21e8-4322-9939-08b9c611f6d6" }, { "id": "339c35ab-2345-4049-a90c-aa4b39bf3fa5", "name": "Resource not found", "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 \"on_behalf_of\": {\n \"user_id\": \"\",\n \"identifier\": \"\"\n },\n \"permissions\": \"*\",\n \"agent_name\": \"\",\n \"task_description\": \"\",\n \"redirect_url\": \"\",\n \"session_max_duration_in_seconds\": 1800\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agents/tasks", "host": [ "{{baseUrl}}" ], "path": [ "agents", "tasks" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-339c35ab-2345-4049-a90c-aa4b39bf3fa5" }, { "id": "e108f1ff-a9ab-4e95-bfd8-26a2ce57dd1f", "name": "Invalid request parameters", "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 \"on_behalf_of\": {\n \"user_id\": \"\",\n \"identifier\": \"\"\n },\n \"permissions\": \"*\",\n \"agent_name\": \"\",\n \"task_description\": \"\",\n \"redirect_url\": \"\",\n \"session_max_duration_in_seconds\": 1800\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agents/tasks", "host": [ "{{baseUrl}}" ], "path": [ "agents", "tasks" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-e108f1ff-a9ab-4e95-bfd8-26a2ce57dd1f" } ], "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-18a55530-fc93-46be-b682-93cdacf41f3d" } ], "id": "2a654bf2-8703-4a47-bdb2-7e7f8139c90b", "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-2a654bf2-8703-4a47-bdb2-7e7f8139c90b" } ], "id": "fee02d96-3fe6-4c8c-8054-a129de9a0100", "createdAt": "2026-07-28T01:22:18.000Z", "updatedAt": "2026-07-28T01:22:18.000Z", "uid": "35240-fee02d96-3fe6-4c8c-8054-a129de9a0100" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.clerk.com/v1" } ] }