> ## 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.

# Create a new agent

> Create a new agent in the caller's organization. The agent starts
in `draft` status and `private` visibility. A service account is
provisioned automatically; failure to provision rolls back the
creation.




## OpenAPI

````yaml /api-reference/agent-factory/swagger.yml post /v1/agents
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:
    post:
      tags:
        - Agents
      summary: Create a new agent
      description: |
        Create a new agent in the caller's organization. The agent starts
        in `draft` status and `private` visibility. A service account is
        provisioned automatically; failure to provision rolls back the
        creation.
      operationId: createAgent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentCreateInput'
            example:
              name: Test Agent
              description: Agent created by automated test
              instructions: You are a helpful test assistant.
              model: gpt-4o-mini
              temperature: 0.7
      responses:
        '200':
          description: Agent created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentCreateResponse'
        '400':
          description: >-
            Validation error (e.g. missing `instructions`, too many
            sub_agents/starters).
          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: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Service account provisioning failed (agent record rolled back).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AgentCreateInput:
      type: object
      required:
        - instructions
      properties:
        name:
          type: string
          maxLength: 256
        description:
          type: string
          maxLength: 4096
        instructions:
          type: string
          maxLength: 100000
          description: System prompt / agent instructions.
        model:
          type: string
          maxLength: 128
        fallback_models:
          type: array
          items:
            type: string
        temperature:
          type: number
        profile:
          type: string
          maxLength: 64
          enum:
            - simple
            - workflow
            - agent_light
            - agent_full
            - orchestrator
        skills:
          type: array
          items:
            type: object
            additionalProperties: true
        sub_agents:
          type: array
          description: Sub-agent delegations (max 20).
          items:
            $ref: '#/components/schemas/SubAgentRef'
        starters:
          type: array
          description: Conversation starter prompts (max 10).
          items:
            type: object
            additionalProperties: true
    AgentCreateResponse:
      type: object
      description: Slim record returned on agent create / import.
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
          enum:
            - draft
        serviceAccountId:
          type: string
        createdAt:
          type: string
          format: date-time
    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
    SubAgentRef:
      type: object
      description: Sub-agent delegation entry on an agent.
      properties:
        agent_id:
          type: string
        name:
          type: string
        description:
          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 <token>`.
        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_...`.

````