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

# Read Pin

> Read a specific pin from the storage board.

The pin_name is passed as a query parameter, board config in the body.



## OpenAPI

````yaml /api-reference/openapi.json post /api/data-lake/pins/read
openapi: 3.1.0
info:
  title: apowerb API
  description: REST API of the apowerb agentic framework (open-source edition).
  version: 0.1.2
  license:
    name: MIT
    url: https://github.com/apowerb/apowerb/blob/main/LICENSE
servers:
  - url: https://api.example.com
    description: Your apowerb instance
  - url: http://localhost:8000
    description: Local stack
security: []
paths:
  /api/data-lake/pins/read:
    post:
      tags:
        - data-lake
      summary: Read Pin
      description: |-
        Read a specific pin from the storage board.

        The pin_name is passed as a query parameter, board config in the body.
      operationId: read_pin_api_data_lake_pins_read_post
      parameters:
        - name: pin_name
          in: query
          required: true
          schema:
            type: string
            title: Pin Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PinReadSchema'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    PinReadSchema:
      properties:
        bucket_name:
          type: string
          title: Bucket Name
        prefix:
          type: string
          title: Prefix
        storage_source:
          type: string
          title: Storage Source
          default: s3
      type: object
      required:
        - bucket_name
        - prefix
      title: PinReadSchema
      description: Schema for reading a pin (used when query params are not enough).
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

## Related topics

- [Write Pin](/api-reference/data-lake/write-pin.md)
- [List Pins](/api-reference/data-lake/list-pins.md)
- [Mark As Read](/api-reference/notifications/mark-as-read.md)
- [Read Agent](/api-reference/agents/read-agent.md)
- [Mark All As Read](/api-reference/notifications/mark-all-as-read.md)