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

# Create Forward



## OpenAPI

````yaml /api-reference/openapi.json post /v1/workspaces/{workspace}/streams/{stream_id}/forwards
openapi: 3.1.0
info:
  description: >-
    Modular and extensible framework for building AI agents. This API requires
    JWT Bearer token authentication for most endpoints. Include your JWT token
    in the Authorization header. Public endpoints include /, /health, /docs,
    /redoc, and /openapi.json.
  title: AgentArea API
  version: 0.1.0
servers: []
security:
  - bearer: []
paths:
  /v1/workspaces/{workspace}/streams/{stream_id}/forwards:
    post:
      tags:
        - v1
        - protected
        - streams
      summary: Create Forward
      operationId: create_forward_v1_streams__stream_id__forwards_post
      parameters:
        - in: path
          name: stream_id
          required: true
          schema:
            format: uuid
            title: Stream Id
            type: string
        - description: Slug of the workspace the request acts in
          in: path
          name: workspace
          required: true
          schema:
            description: Slug of the workspace the request acts in
            maxLength: 120
            pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
            title: Workspace
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForwardCreate'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    ForwardCreate:
      additionalProperties: false
      properties:
        event_filter:
          $ref: '#/components/schemas/EventFilter'
          description: Which events are copied; empty copies all.
        output_stream_ids:
          description: Streams every matching event is copied into; never the input.
          items:
            format: uuid
            type: string
          minItems: 1
          title: Output Stream Ids
          type: array
      required:
        - output_stream_ids
      title: ForwardCreate
      type: object
    SubscriptionResponse:
      properties:
        attempts:
          title: Attempts
          type: integer
        created_at:
          format: date-time
          title: Created At
          type: string
        cursor_sequence:
          title: Cursor Sequence
          type: integer
        filter:
          additionalProperties: true
          title: Filter
          type: object
        id:
          format: uuid
          title: Id
          type: string
        kind:
          title: Kind
          type: string
        last_error:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Error
        next_attempt_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Next Attempt At
        output_stream_ids:
          items:
            format: uuid
            type: string
          title: Output Stream Ids
          type: array
        status:
          title: Status
          type: string
        trigger_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Trigger Id
      required:
        - id
        - kind
        - trigger_id
        - filter
        - output_stream_ids
        - cursor_sequence
        - status
        - attempts
        - last_error
        - next_attempt_at
        - created_at
      title: SubscriptionResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    EventFilter:
      additionalProperties: false
      description: Empty kinds and fields match every event.
      properties:
        fields:
          additionalProperties: true
          title: Fields
          type: object
        kinds:
          items:
            type: string
          title: Kinds
          type: array
      title: EventFilter
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      description: JWT Bearer token for authentication
      scheme: bearer
      type: http
    HTTPBearer:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.