> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

# list_chunks

> List chunks belonging to a document.

List chunks belonging to a document. Chunks are the individual text segments
created when a document is processed for vector search.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/datasphere/documents/{documentId}/chunks:
    get:
      operationId: list_document_chunks
      summary: List chunks
      description: >-
        A list of chunks for a Datasphere Document.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _DataSphere_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_chunks
      parameters:
        - name: documentId
          in: path
          description: Unique ID of the Document.
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
        - name: page_number
          in: query
          description: The page number to retrieve (0-indexed).
          required: false
          schema:
            type: integer
            default: 0
        - name: page_size
          in: query
          description: >-
            Specify the number of results to return on a single page. The
            default page size is `50` and the maximum is `1000`.
          required: false
          schema:
            type: integer
            default: 50
        - name: page_token
          in: query
          description: Token for cursor-based pagination. Required when `page_number` > 0.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Datasphere.ChunkListResponse'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode400'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Datasphere.ListStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
    description: SignalWire API
components:
  schemas:
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    Datasphere.ChunkStatus:
      type: string
      enum:
        - submitted
        - in_progress
        - completed
        - failed
      description: The current Status of the Chunk.
      title: Datasphere.ChunkStatus
    Datasphere.ChunkResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the chunk.
        datasphere_document_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the chunk's datasphere document.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the project.
        status:
          $ref: '#/components/schemas/Datasphere.ChunkStatus'
          description: Status of the chunk.
        tags:
          type: array
          items:
            type: string
          description: The tags of the document associated with the chunk.
        content:
          type: string
          description: Content of the chunk.
        created_at:
          type: string
          format: date-time
          description: Chunk Creation Date.
        updated_at:
          type: string
          format: date-time
          description: Chunk Update Date.
      required:
        - id
        - datasphere_document_id
        - project_id
        - status
        - tags
        - content
        - created_at
        - updated_at
      title: Datasphere.ChunkResponse
    Datasphere.ChunkPaginationResponse:
      type: object
      properties:
        self:
          type: string
          format: uri
          description: Link of the current page.
        first:
          type: string
          format: uri
          description: Link to the first page.
        next:
          type: string
          format: uri
          description: Link to the next page. Only present when there are more results.
        prev:
          type: string
          format: uri
          description: Link to the previous page. Only present when not on the first page.
      required:
        - self
        - first
      title: Datasphere.ChunkPaginationResponse
    Datasphere.ChunkListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Datasphere.ChunkResponse'
          description: A list of chunks.
        links:
          $ref: '#/components/schemas/Datasphere.ChunkPaginationResponse'
          description: Pagination links.
      required:
        - data
        - links
      title: Datasphere.ChunkListResponse
    TypesStatusCodesStatusCode400Error:
      type: string
      enum:
        - Bad Request
      title: TypesStatusCodesStatusCode400Error
    Types.StatusCodes.StatusCode400:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode400Error'
      required:
        - error
      description: The request is invalid.
      title: Types.StatusCodes.StatusCode400
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    Types.StatusCodes.RestApiErrorItem:
      type: object
      properties:
        type:
          type: string
          description: The category of error.
        code:
          type: string
          description: A specific error code.
        message:
          type: string
          description: A description of what caused the error.
        attribute:
          type:
            - string
            - 'null'
          description: The request parameter that caused the error, if applicable.
        url:
          type: string
          description: A link to documentation about this error.
      required:
        - type
        - code
        - message
        - url
      description: Details about a specific error.
      title: Types.StatusCodes.RestApiErrorItem
    Datasphere.ListStatusCode422:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.RestApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request contains invalid parameters. See errors for details.
      title: Datasphere.ListStatusCode422
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500

```

## **Response Example**

### Response (200)

```json
{
  "data": [
    {
      "id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
      "datasphere_document_id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
      "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
      "status": "completed",
      "tags": [
        "sports",
        "football",
        "game"
      ],
      "content": "This is the content from the original document that was chunked.",
      "created_at": "2024-05-06T12:20-12Z",
      "updated_at": "2024-05-06T12:20-12Z"
    }
  ],
  "links": {
    "self": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=0&page_size=50",
    "first": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=0&page_size=50",
    "next": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
    "prev": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=0&page_size=50&page_token=PBbff61159-faab-48b3-959a-3021a8f5beca"
  }
}
```

## **Example**

```python {9}
from signalwire.rest import RestClient

client = RestClient(
    project="your-project-id",
    token="your-api-token",
    host="your-space.signalwire.com",
)

chunks = client.datasphere.documents.list_chunks("document-id")
for chunk in chunks.get("data", []):
    print(chunk.get("id"), chunk.get("text")[:80])
```