Connector API
Last updated
Was this helpful?
Last updated
Was this helpful?
Authorization header
Bearer your_token_hereThe unique identifier for your custom API integration connection. You can find this ID in your integration settings at https://web.dashworks.ai/integrations
The unique identifier for the document that was returned by the Dashworks API when it was added via the POST /v1/documents endpoint.
DELETE /v1/documents HTTP/1.1
Host: api.dashworks.ai
authorization: Bearer your_token_here
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"connection_id": 1,
"document_id": "text"
}{
"message": "Document deleted successfully"
}Creates a new document if the document_id doesn't exist, or updates an existing document if it does.
Authorization header
Bearer your_token_hereThe unique identifier for your custom API integration connection. You can find this ID in your integration settings at https://web.dashworks.ai/integrations
For creating a new document, this field is optional - if provided, it will be used as the document's identifier. For updating an existing document, this field is required and must match a document_id previously returned by a PUT request. Note: Document ids are limited to 64 characters.
Restriction: The content field cannot exceed 10m tokens. Any content past 10m token would be truncated. Please refer to https://platform.openai.com/tokenizer for approximate token counting.
{"email":"author@example.com","name":"John Doe"}The created timestamp (in seconds since the Unix epoch) of the source content
1730243482The last modified timestamp (in seconds since the Unix epoch) of the source content
1730243482PUT /v1/documents HTTP/1.1
Host: api.dashworks.ai
authorization: Bearer your_token_here
Content-Type: application/json
Accept: */*
Content-Length: 263
{
"connection_id": 123,
"document_id": "doc_456",
"title": "Updated Document Title",
"content": "Updated document content.",
"author": {
"email": "author@example.com",
"name": "John Doe"
},
"url": "https://example.com/doc_456",
"created_time": 1730243482,
"modified_time": 1730243482
}{
"document_id": "doc_456"
}If document_id is provided as a query parameter, returns a single document object. Otherwise, returns a paginated list of documents.
The unique identifier for your custom API integration connection.
123Unique document identifier. If provided, a single document is returned.
doc_123Number of documents to return when listing
20Example: 20Offset for pagination when listing
0Example: 0Authorization header
Bearer your_token_hereGET /v1/documents HTTP/1.1
Host: api.dashworks.ai
authorization: Bearer your_token_here
Accept: */*
{
"id": "doc_123",
"content": "This is a sample document content.",
"author": {
"email": "author@example.com",
"name": "John Doe"
},
"url": "https://example.com/doc_123",
"created_time": 1730243482,
"modified_time": 1730243482,
"title": "Sample Document"
}