> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hookie.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an AI agent



## OpenAPI

````yaml /openapi.json post /admin/api/projects/{project_id}/ai-agents
openapi: 3.1.0
info:
  title: Hookie API
  version: 1.0.0
  summary: Capture, route and deliver webhooks.
  description: >-
    Hookie exposes three HTTP surfaces.


    **Ingest + streaming** is the public plane. A path-form endpoint URL
    authenticates by its own high-entropy slug — there is no key, token or
    cookie — and an `ik_live_…` ingest key authenticates the `/v1/*` routes.
    Whenever the URL names a dataset the payload is stored whole into it;
    project mapping rules are evaluated on exactly one shape, `POST
    /v1/ingest/{ingest_key}` with no dataset segment.


    **The customer portal API** is a separate, token-authed surface for your end
    customers, scoped to one portal and one customer.


    **The admin API** drives the console. It accepts either a browser session or
    an OAuth bearer token from a connected coding agent — the same routes, the
    same validation, the same audit trail. An agent's authority is its user's
    workspace role narrowed to the scopes granted in the console.


    This document is generated from the request handlers and adversarially
    verified against them.
  contact:
    name: Hookie
    url: https://hookie.ai
  license:
    name: Proprietary
    url: https://hookie.ai/legal/terms
servers:
  - url: https://app.hookie.ai
    description: Production
  - url: https://app.preview.hookie.ai
    description: Preview
security: []
tags:
  - name: Ingest
    description: Send events to Hookie.
  - name: Streaming
    description: Tail events in real time over SSE or WebSocket.
  - name: Portal
    description: Token-authed surface for your end customers.
  - name: Projects
    description: Projects and their settings.
  - name: Routing
    description: Rules, endpoints, datasets and records.
  - name: Delivery
    description: Destinations, deliveries and replay.
  - name: Workflows
    description: Multi-step workflows, triggers and AI agents.
  - name: Observability
    description: Search, correlation, stats and the audit log.
  - name: Workspace
    description: Members, connected agents, SSO and billing.
paths:
  /admin/api/projects/{project_id}/ai-agents:
    post:
      tags:
        - AI agents
      summary: Create an AI agent
      operationId: createAiAgent
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                  description: Trimmed before validation.
                active:
                  type: boolean
                  default: true
                  description: >-
                    Only the literal false deactivates. An inactive agent makes
                    an agent_call workflow step fail.
                model:
                  type: string
                  default: '@cf/meta/llama-3.3-70b-instruct-fp8-fast'
                  description: >-
                    Workers AI model id. SILENTLY replaced by the default unless
                    it starts with '@'.
                system_prompt:
                  type: string
                  maxLength: 8000
                  default: ''
                  description: '`prompt` is accepted as an alias.'
                prompt:
                  type: string
                  description: Alias for system_prompt.
                tools:
                  type: array
                  default: []
                  items: {}
                  description: >-
                    Stored verbatim; reserved for tool-calling and not used at
                    run time.
                memory_dataset:
                  type:
                    - string
                    - 'null'
                  pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,62}$
                  description: >-
                    When set, each run's output is written there as a record for
                    longer-term recall.
                max_tokens:
                  type: integer
                  default: 1024
                  description: Clamped to 1..1024; a non-integer becomes 1024.
      responses:
        '201':
          description: Created.
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - ok
                properties:
                  id:
                    type: string
                  ok:
                    type: boolean
                    enum:
                      - true
        '400':
          description: >-
            `body must be an object`; `name is required (<=120 chars)`;
            `system_prompt too long (<=8000 chars)`; `tools must be an array`;
            `memory_dataset: <dataset name error>`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Not signed in.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            `Insufficient role` (write capability required), or `Missing
            X-Requested-With header`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: '`Project not found`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: '`Internal error`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - session: []
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable reason.
        retry_after:
          type: integer
          description: Seconds to wait. Present on 429.
        upgrade_url:
          type: string
          format: uri
          description: Present only on a monthly-quota 429.
  securitySchemes:
    session:
      type: apiKey
      in: cookie
      name: hookie_session
      description: >-
        The console's sealed session cookie, set by WorkOS AuthKit. Mutating
        requests also require the `X-Requested-With` CSRF header.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        An OAuth 2.1 access token from a connected agent, audienced at the
        `/mcp` resource URI. The agent acts as its user, with that user's role
        narrowed to the granted `hookie:*` scopes. No CSRF header is required —
        a bearer token is not ambient credentials.

````