Retrieve Chunk | SignalWire

using RestSharp;
var client = new RestClient("https://{your_space_name}.signalwire.com/api/datasphere/documents/documentId/chunks/chunkId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
IRestResponse response = client.Execute(request);

{
  "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"
}

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.

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)

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.

Permissions

Authentication

Path parameters

Response

Errors