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

# Get workflow inputs

> Get the input variable names a workflow accepts at execution time



## OpenAPI

````yaml https://odyssey.asteroid.ai/agents/v2/openapi.yaml get /agents/{agentId}/workflows/{workflowId}/inputs
openapi: 3.1.0
info:
  title: Agent Service
  version: v1
servers:
  - description: V2 API
    url: https://odyssey.asteroid.ai/agents/v2
security:
  - ApiKeyAuth: []
tags:
  - name: Agents
  - name: Execution
  - name: Files
  - name: Agent Profiles
  - name: Agent Profile Pools
  - name: Workflows
  - name: Schema
  - name: Documentation
  - name: Context
paths:
  /agents/{agentId}/workflows/{workflowId}/inputs:
    get:
      tags:
        - Workflows
      summary: Get workflow inputs
      description: Get the input variable names a workflow accepts at execution time
      operationId: AgentWorkflowsGetInputs
      parameters:
        - description: The ID of the agent
          in: path
          name: agentId
          required: true
          schema:
            $ref: '#/components/schemas/Common.uuid'
        - description: The ID of the workflow
          in: path
          name: workflowId
          required: true
          schema:
            $ref: '#/components/schemas/Common.uuid'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agents.Workflow.WorkflowInputs'
          description: The request has succeeded.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.BadRequestErrorBody'
          description: The server could not understand the request due to invalid syntax.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.UnauthorizedErrorBody'
          description: Access is unauthorized.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.ForbiddenErrorBody'
          description: Access is forbidden.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.NotFoundErrorBody'
          description: The server cannot find the requested resource.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common.InternalServerErrorBody'
          description: Server error
components:
  schemas:
    Common.uuid:
      format: uuid
      type: string
    Agents.Workflow.WorkflowInputs:
      description: The typed inputs a workflow declares
      properties:
        inputs:
          description: Typed input definitions the workflow accepts at execution time
          items:
            $ref: '#/components/schemas/Agents.Workflow.Input'
          type: array
      required:
        - inputs
      type: object
    Common.BadRequestErrorBody:
      properties:
        code:
          enum:
            - 400
          type: number
          x-enum-varnames:
            - BadRequest
        message:
          type: string
      required:
        - code
        - message
      type: object
    Common.UnauthorizedErrorBody:
      properties:
        code:
          enum:
            - 401
          type: number
          x-enum-varnames:
            - Unauthorized
        message:
          type: string
      required:
        - code
        - message
      type: object
    Common.ForbiddenErrorBody:
      properties:
        code:
          enum:
            - 403
          type: number
          x-enum-varnames:
            - Forbidden
        message:
          type: string
      required:
        - code
        - message
      type: object
    Common.NotFoundErrorBody:
      properties:
        code:
          enum:
            - 404
          type: number
          x-enum-varnames:
            - NotFound
        message:
          type: string
      required:
        - code
        - message
      type: object
    Common.InternalServerErrorBody:
      properties:
        code:
          enum:
            - 500
          type: number
          x-enum-varnames:
            - InternalServerError
        message:
          type: string
      required:
        - code
        - message
      type: object
    Agents.Workflow.Input:
      description: >-
        A typed input variable a workflow declares. Referenced as {{.name}} in
        prompts.
      properties:
        defaultValue:
          description: Optional value used when the input is omitted at execution time.
        description:
          description: Optional human-readable description of the input.
          type: string
        name:
          description: >-
            The variable name. Matches [a-zA-Z_][a-zA-Z0-9_]* and is unique
            within the workflow.
          pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
          type: string
        required:
          description: >-
            Whether a value must be supplied at execution time. Defaults to
            false.
          type: boolean
        schema:
          description: >-
            A single-field JSON Schema fragment describing the input's type,
            e.g. {type: "string"}, {type: "number"}, {type: "object",
            properties: {...}}. Validated adaptively at execution time.
          type: object
          unevaluatedProperties: {}
      required:
        - name
        - schema
        - required
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-Asteroid-Agents-Api-Key
      type: apiKey

````