> ## Documentation Index > Fetch the complete documentation index at: https://docs.prisme.ai/llms.txt > Use this file to discover all available pages before exploring further. # Share an agent with a principal (create binding) > Create a binding granting a user, group, or org access to this agent. User and group principals are validated against the agent's organization via `ai-governance-v2`. Default role is `admin` if `role_slug` is omitted. ## OpenAPI ````yaml /api-reference/agent-factory/swagger.yml post /v1/agents/{agentId}/access openapi: 3.0.3 info: version: 1.0.0 title: Agent Factory API description: | Public REST API for the Agent Factory workspace - agents, conversations, messages, tools, artifacts, sharing, ratings, and discovery. Powered by Prisme.ai's runtime; all endpoints are exposed under each workspace's webhook namespace. contact: name: Prisme.ai url: https://prisme.ai servers: - url: https://{host}/v2/workspaces/slug:agent-factory/webhooks description: Prisme.ai workspace webhooks variables: host: default: api.studio.prisme.ai description: API host (override for self-hosted or sandbox) security: - BearerAuth: [] - OrgApiKeyAuth: [] tags: - name: Agents description: Agent CRUD, discovery, AGENTS.md import/export. - name: Access description: Agent access bindings, sharing, and access requests. - name: ApiKeys description: Agent-scoped API key management (mint, revoke, rotate). - name: Publishing description: Publish or discard draft changes on an agent. - name: Ratings description: User ratings on published agents. - name: Profiles description: >- Agent profiles/presets catalog (simple, workflow, agent_light, agent_full, orchestrator). - name: Activity description: Activity feed for agents (events, errors, lifecycle changes). - name: Analytics description: Agent usage analytics (series + summary). - name: Conversations description: Conversations on an agent (CRUD, archive, star). - name: Messages description: Send messages to an agent (synchronous send + SSE stream). - name: Tasks description: Async task lifecycle (list, fetch, cancel, resolve, subscribe). - name: Artifacts description: Generated artifacts (files, code, content) attached to a task. - name: Shares description: Conversation, message, and artifact share-link snapshots. - name: A2A description: Agent-to-agent JSON-RPC 2.0 gateway (well-known agent.json + RPC). - name: Tools description: Per-agent tool catalogue (system tools, MCP servers, function tools). - name: Retention description: Per-agent and org-wide conversation retention policies. - name: Evaluations description: Agent evaluation runs and results. paths: /v1/agents/{agentId}/access: post: tags: - Access summary: Share an agent with a principal (create binding) description: | Create a binding granting a user, group, or org access to this agent. User and group principals are validated against the agent's organization via `ai-governance-v2`. Default role is `admin` if `role_slug` is omitted. operationId: shareAgent parameters: - name: agentId in: path required: true schema: type: string maxLength: 64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessShareInput' responses: '200': description: Binding created. content: application/json: schema: $ref: '#/components/schemas/AccessShareResponse' '400': description: >- Validation error (invalid principal_type, missing principal_id, cross-org sharing, etc.). content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Agent not found. content: application/json: schema: $ref: '#/components/schemas/Error' '405': description: Method not allowed. content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Binding already exists. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: AccessShareInput: type: object required: - principal_type - principal_id properties: principal_type: type: string enum: - user - group - org maxLength: 32 principal_id: type: string maxLength: 128 description: >- User id (or email for user type, resolved server-side), group id, or org slug. role_slug: type: string maxLength: 64 description: Role to grant. Defaults to `admin`. AccessShareResponse: type: object properties: created: type: boolean example: true binding: $ref: '#/components/schemas/AccessBinding' Error: type: object required: - error - message properties: error: type: string description: >- Stable PascalCase or SNAKE_CASE error code (e.g. AgentNotFound, VALIDATION_ERROR, FORBIDDEN, METHOD_NOT_ALLOWED). message: type: string description: Human-readable error message. details: type: object description: Optional structured context for the error. additionalProperties: true AccessBinding: type: object description: Access binding granting a principal a role on an agent. properties: agent_id: type: string principal_type: type: string enum: - user - group - org principal_id: type: string email: type: string orgSlug: type: string granted_by: type: string role_slug: type: string securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: | User-bound credential carrying an identity: either a session JWT or a user access token (`at:*`) generated from the user settings UI. Send as `Authorization: Bearer `. Org API keys (`iak_*`) are **not** accepted here - they carry no user identity. Use the `x-prismeai-api-key` header instead (see `OrgApiKeyAuth`). OrgApiKeyAuth: type: apiKey in: header name: x-prismeai-api-key description: | Organization API key (`iak_{orgSlug}_{uuid}`). Unlike `Authorization: Bearer`, this credential is **not** tied to a user identity - it is bound to the org and its effective access is defined by the scopes / permission rules attached to it (it can be restricted to a single project, or kept broader). For Agent Factory, these keys can be generated directly from the Agent Factory UI (in addition to the AI Governance settings). Send as `x-prismeai-api-key: iak_...`. ````