For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
      • DELDelete chunk
      • GETGet chunk
      • GETList chunks
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
DatasphereChunks

Get chunk

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/datasphere/documents/:documentId/chunks/:chunkId
GET
/api/datasphere/documents/:documentId/chunks/:chunkId
$curl https://{your_space_name}.signalwire.com/api/datasphere/documents/documentId/chunks/chunkId \
>     -u "<project_id>:<api_token>"
1{
2  "id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
3  "datasphere_document_id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
4  "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
5  "status": "completed",
6  "tags": [
7    "sports",
8    "football",
9    "game"
10  ],
11  "content": "This is the content from the original document that was chunked.",
12  "created_at": "2024-05-06T12:20-12Z",
13  "updated_at": "2024-05-06T12:20-12Z"
14}

Retrieves a specific chunk for a Datasphere Document by ID.

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.

Was this page helpful?
Previous

List chunks

Next
Built with

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

documentIdstringRequiredformat: "uuid"
Unique ID of the parent Document.
chunkIdstringRequiredformat: "uuid"
Unique ID of a Chunk.

Response

The request has succeeded.
idstringformat: "uuid"
Unique ID of the chunk.
datasphere_document_idstringformat: "uuid"
Unique ID of the chunk's datasphere document.
project_idstringformat: "uuid"
Unique ID of the project.
statusenum
Status of the chunk.
Allowed values:
tagslist of strings
The tags of the document associated with the chunk.
contentstring
Content of the chunk.
created_atdatetime
Chunk Creation Date.
updated_atdatetime
Chunk Update Date.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)