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

# Draft a conversation flow with AI (streaming)

> AI-draft over server-sent events — flow nodes/edges stream in as the model writes them

**Required scope:** `agents.edit`

<Note>Requires the `agent_studio` feature enabled for your workspace. Otherwise the request is refused; see [Errors](/concepts/errors).</Note>


## OpenAPI

````yaml /api-reference/openapi.json post /agents/studio/draft/stream
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /agents/studio/draft/stream:
    post:
      summary: Draft a conversation flow with AI (streaming)
      description: >-
        AI-draft over server-sent events — flow nodes/edges stream in as the
        model writes them
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                goal:
                  type: string
                  minLength: 1
                  maxLength: 2000
                companyName:
                  type: string
                  minLength: 1
                  maxLength: 120
                companyDescription:
                  type: string
                  maxLength: 4000
                industry:
                  type: string
                  maxLength: 100
                designation:
                  type: string
                  maxLength: 100
                agentName:
                  type: string
                  maxLength: 100
                briefText:
                  type: string
                  maxLength: 8000
                languages:
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 40
                  minItems: 1
                  maxItems: 24
                primaryLanguage:
                  type: string
                  minLength: 1
                  maxLength: 40
                tone:
                  type: string
                  enum:
                    - warm_professional
                    - formal
                    - casual
                    - assertive
                    - empathetic
                parts:
                  type: array
                  items:
                    type: string
                    enum:
                      - flow
                      - faqs
                      - opening
                  minItems: 1
                revision:
                  type: object
                  properties:
                    instruction:
                      type: string
                      minLength: 1
                      maxLength: 1000
                    currentGraph:
                      type: object
                      properties:
                        nodes:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                minLength: 1
                                maxLength: 64
                              type:
                                type: string
                                enum:
                                  - step
                                  - branch
                                  - end
                              title:
                                type: string
                                minLength: 1
                                maxLength: 200
                              detail:
                                type: string
                                maxLength: 2000
                              position:
                                type: object
                                properties:
                                  x:
                                    type: number
                                  'y':
                                    type: number
                                required:
                                  - x
                                  - 'y'
                            required:
                              - id
                              - type
                              - title
                          maxItems: 40
                        edges:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                minLength: 1
                                maxLength: 64
                              source:
                                type: string
                                minLength: 1
                                maxLength: 64
                              target:
                                type: string
                                minLength: 1
                                maxLength: 64
                              condition:
                                type: string
                                maxLength: 200
                            required:
                              - id
                              - source
                              - target
                          maxItems: 80
                      required:
                        - nodes
                        - edges
                  required:
                    - instruction
                    - currentGraph
              required:
                - goal
                - companyName
                - languages
                - tone
      responses:
        '200':
          description: >-
            text/event-stream — `data:` lines of {type:
            node|edge|faqs|opening|keys|done|error, ...}; `done` carries the
            full StudioFlowDraftResponse payload
        '400':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `feature_not_available`: This feature is not enabled for your
            workspace or plan.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

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