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

# Browse Connector



## OpenAPI

````yaml https://api.outerproduct.com/openapi.json get /v1/workspaces/{workspace_id}/connectors/{connector_id}:browse
openapi: 3.1.0
info:
  title: OuterProduct API
  description: >-
    Public-facing REST API for OuterProduct model distillation, prediction, and
    explanation.
  version: 0.1.8
servers: []
security: []
paths:
  /v1/workspaces/{workspace_id}/connectors/{connector_id}:browse:
    get:
      tags:
        - connector
      summary: Browse Connector
      operationId: >-
        browse_connector_v1_workspaces__workspace_id__connectors__connector_id__browse_get
      parameters:
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            title: Workspace Id
        - name: connector_id
          in: path
          required: true
          schema:
            type: string
            title: Connector Id
        - name: pathPrefix
          in: query
          required: false
          schema:
            type: string
            default: ''
            title: Pathprefix
        - name: depth
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 32
                exclusiveMinimum: 0
              - type: 'null'
            title: Depth
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Pagesize
        - name: pageToken
          in: query
          required: false
          schema:
            type: string
            default: ''
            title: Pagetoken
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrowseConnectorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    BrowseConnectorResponse:
      properties:
        objects:
          items:
            $ref: '#/components/schemas/ConnectorObject'
          type: array
          title: Objects
          description: Connector objects in this page.
        nextPageToken:
          type: string
          title: Nextpagetoken
          description: >-
            Token for retrieving the next page, or empty when this is the last
            page.
          default: ''
      type: object
      title: BrowseConnectorResponse
      description: Response containing one page of objects visible through a connector.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ConnectorObject:
      properties:
        objectStore:
          anyOf:
            - $ref: '#/components/schemas/ObjectStoreObject'
            - type: 'null'
          description: >-
            An object-store prefix or object.

            Only one of the fields can be specified with: ["object_store",
            "relational"] (oneof object)
        relational:
          anyOf:
            - $ref: '#/components/schemas/RelationalObject'
            - type: 'null'
          description: >-
            A relational catalog, schema, or table.

            Only one of the fields can be specified with: ["object_store",
            "relational"] (oneof object)
      type: object
      title: ConnectorObject
      description: |-
        One object observed through a connector.

        Connector objects describe current external state. They are not durable
        workspace resources and therefore do not have resource names.
    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
    ObjectStoreObject:
      properties:
        path:
          type: string
          title: Path
          description: Connector-relative object key.
        uri:
          type: string
          title: Uri
          description: Absolute URI for this object or prefix.
        kind:
          $ref: '#/components/schemas/ObjectStoreObjectKind'
          description: Whether this observation is a prefix or an object.
        size:
          anyOf:
            - type: string
            - type: 'null'
          title: Size
          description: Object size in bytes. Omitted for prefixes.
        updateTime:
          anyOf:
            - type: string
            - type: 'null'
          title: Updatetime
          description: Time at which the object store reports the object was last updated.
        etag:
          anyOf:
            - type: string
            - type: 'null'
          title: Etag
          description: Entity tag reported by the object store.
        version:
          anyOf:
            - type: string
            - type: 'null'
          title: Version
          description: Object version reported by the object store.
      type: object
      required:
        - path
        - uri
        - kind
      title: ObjectStoreObject
      description: An object-store prefix or object.
    RelationalObject:
      properties:
        path:
          items:
            type: string
            minLength: 1
          type: array
          maxItems: 3
          minItems: 1
          title: Path
          description: |-
            Identifier components from catalog through this object.

            Components remain separate so names containing delimiters round-trip
            without ambiguity.
        kind:
          $ref: '#/components/schemas/RelationalObjectKind'
          description: The level represented by `path`.
      type: object
      required:
        - path
        - kind
      title: RelationalObject
      description: A relational catalog, schema, or table.
    ObjectStoreObjectKind:
      type: string
      enum:
        - OBJECT_STORE_OBJECT_KIND_UNSPECIFIED
        - OBJECT_STORE_OBJECT_KIND_PREFIX
        - OBJECT_STORE_OBJECT_KIND_OBJECT
      title: ObjectStoreObjectKind
      description: Kind of object observed in an object store.
    RelationalObjectKind:
      type: string
      enum:
        - RELATIONAL_OBJECT_KIND_UNSPECIFIED
        - RELATIONAL_OBJECT_KIND_CATALOG
        - RELATIONAL_OBJECT_KIND_SCHEMA
        - RELATIONAL_OBJECT_KIND_TABLE
      title: RelationalObjectKind
      description: Kind of object observed in a relational connector.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key or OAuth2/OIDC access token
      description: >-
        An API key or OAuth2/OIDC access token sent as `Authorization: Bearer
        <token>`.

````