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

# Get a procedure

> Returns one procedure, including its steps.



## OpenAPI

````yaml /api-v2-openapi.json get /agents/{agentId}/procedures/{procedureId}
openapi: 3.1.0
info:
  title: Chatbase API v2
  version: 2.0.0
  description: >-
    Chatbase API v2 - A robust, structured API for managing agents,
    conversations, and the helpdesk.
servers:
  - url: https://www.chatbase.co/api/v2
    description: Chatbase API v2
security: []
paths:
  /agents/{agentId}/procedures/{procedureId}:
    get:
      tags:
        - Procedures
      summary: Get a procedure
      description: Returns one procedure, including its steps.
      operationId: getProcedure
      parameters:
        - schema:
            type: string
            minLength: 1
            description: The agent ID
            example: 5QHA6VB-DIAbBhxwqxfdi
          required: true
          description: The agent ID
          name: agentId
          in: path
        - schema:
            type: string
            format: uuid
            description: The procedure ID
            example: b1d47c2e-5a3f-4e8b-9c1d-2f6a7b8c9d0e
          required: true
          description: The procedure ID
          name: procedureId
          in: path
      responses:
        '200':
          description: The procedure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Procedure'
        '400':
          description: >-
            The request body failed schema validation. Inspect the `details`
            object in the error response for field-level errors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: VALIDATION_INVALID_BODY
                  message: Invalid request
        '401':
          description: >-
            No Authorization header present. Provide a valid API key as a Bearer
            token in the Authorization header: `Authorization: Bearer
            <api-key>`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: AUTH_MISSING_API_KEY
                  message: Authentication required
        '403':
          description: >-
            Your current plan does not include API access. Upgrade to the Basic
            plan or higher to use the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: SUBSCRIPTION_API_RESTRICTED_PLAN
                  message: A Basic plan or higher is required to access the API
        '404':
          description: >-
            No procedure matches the provided `procedureId` on this agent, or it
            does not belong to the authenticated account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: PROCEDURE_NOT_FOUND
                  message: Procedure not found
        '429':
          description: >-
            Rate limit exceeded. Check the `X-RateLimit-Reset` response header
            for the Unix epoch seconds when the limit resets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: RATE_LIMIT_TOO_MANY_REQUESTS
                  message: Too many requests, please try again later
        '500':
          description: >-
            An unhandled server error occurred. If the issue persists, contact
            support with the `x-request-id` response header value for debugging.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: INTERNAL_SERVER_ERROR
                  message: Something went wrong, please try again
        '503':
          description: >-
            Chatbase is undergoing scheduled maintenance and the API is
            temporarily rejecting requests. This is transient; retry after a
            short delay. Requests are rejected before any data is read or
            written, so no partial changes are applied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: SERVICE_UNDER_MAINTENANCE
                  message: >-
                    The API is temporarily unavailable for scheduled
                    maintenance, please try again later
      security:
        - bearerAuth: []
components:
  schemas:
    Procedure:
      allOf:
        - $ref: '#/components/schemas/ProcedureListItem'
        - type: object
          properties:
            steps:
              type: array
              items:
                $ref: '#/components/schemas/ProcedureStep'
              description: The steps in order.
          required:
            - steps
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code
            message:
              type: string
              description: Human-readable error message
            details:
              type: object
              additionalProperties:
                type: string
              description: Field-level validation errors
          required:
            - code
            - message
      required:
        - error
    ProcedureListItem:
      type: object
      properties:
        id:
          type: string
          description: Procedure ID
        name:
          type: string
          description: Procedure name, unique within the agent
        status:
          type: string
          enum:
            - enabled
            - disabled
          description: Whether the agent can run the procedure.
        trigger:
          type: string
          description: When the agent should start the procedure
          example: The customer asks for a refund
        unavailableActions:
          type: array
          items:
            type: string
          description: >-
            Action mentions in the steps, such as `@refund_payment`, whose
            action is missing or disabled. While any is listed, the agent skips
            the procedure. It also skips the procedure on a channel where a
            mentioned action is switched off.
          example:
            - '@refund_payment'
      required:
        - id
        - name
        - status
        - trigger
        - unavailableActions
    ProcedureStep:
      oneOf:
        - $ref: '#/components/schemas/ProcedureInstructionStep'
        - $ref: '#/components/schemas/ProcedureBranchStep'
      discriminator:
        propertyName: kind
        mapping:
          instruction: '#/components/schemas/ProcedureInstructionStep'
          branch: '#/components/schemas/ProcedureBranchStep'
    ProcedureInstructionStep:
      type: object
      properties:
        kind:
          type: string
          enum:
            - instruction
        text:
          type: string
          description: >-
            What the agent does. `@` plus an action name in lowercase, with `-`
            written as `_`, mentions that action.
          example: Ask for the order number, then call @get_order
      required:
        - kind
        - text
    ProcedureBranchStep:
      type: object
      properties:
        kind:
          type: string
          enum:
            - branch
        branches:
          type: array
          items:
            type: object
            properties:
              condition:
                type: string
                description: When this branch runs
                example: The order is older than 30 days
              steps:
                type: array
                items:
                  $ref: '#/components/schemas/ProcedureStep'
            required:
              - condition
              - steps
        otherwise:
          type: object
          properties:
            steps:
              type: array
              items:
                $ref: '#/components/schemas/ProcedureStep'
          required:
            - steps
          description: Runs when no condition matches
      required:
        - kind
        - branches
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from your account settings

````

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