Connector API

Create or Update Documents

Creates a new document if the document_id doesn't exist, or updates an existing document if it does.

PUThttps://api.dashworks.ai/v1/documents

Header parameters

Body

connection_id*Connection Id

The unique identifier for your custom API integration connection. You can find this ID in your integration settings at https://web.dashworks.ai/integrations

document_id*Document Id (Max 64 characters)

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.

titleTitle

contentContent

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.

authorany of

urlUrl

created_timeinteger (int64)

The created timestamp (in seconds since the Unix epoch) of the source content

Example: 1730243482

modified_timeinteger (int64)

The last modified timestamp (in seconds since the Unix epoch) of the source content

Example: 1730243482

Response

Document successfully created or updated

Body

document_id*string

UUID of the created or updated document

Request

const response = await fetch('https://api.dashworks.ai/v1/documents', {
    method: 'PUT',
    headers: {
      "authorization": "Bearer your_token_here",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "connection_id": 123,
      "document_id": "doc_456",
      "title": "Document Title",
      "content": "Document content.",
      "author": {
        "email": "author@example.com",
        "name": "John Doe"
      },
      "url": "https://example.com/doc_456",
      "created_time": 1730243482,
      "modified_time": 1730243482
    }),
});
const data = await response.json();

Response

{
  "document_id": "4ffceea3-309c-4aa6-ae28-d1cb9524006e"
}

Get Documents

GEThttps://api.dashworks.ai/v1/documents

Header parameters

Body

connection_id*Connection Id

The unique identifier for your custom API integration connection. You can find this ID in your integration settings at https://web.dashworks.ai/integrations

document_id*Document Id

The unique identifier for the document that was returned by the Dashworks API when it was added via the POST /v1/documents endpoint.

Response

Successful Response

Body

title*Title

content*Content

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.

authorany of

url*Url

created_timeinteger (int64)

The created timestamp (in seconds since the Unix epoch) of the source content

Example: 1730243482

modified_timeinteger (int64)

The last modified timestamp (in seconds since the Unix epoch) of the source content

Example: 1730243482

Request

const response = await fetch('https://api.dashworks.ai/v1/documents', {
    method: 'GET',
    headers: {
      "authorization": "Bearer your_token_here",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "connection_id": 0,
      "document_id": "text"
    }),
});
const data = await response.json();

Response

{
  "connection_id": 123,
  "document_id": "doc_456",
  "title": "Sample Document",
  "content": "This is a sample document content.",
  "author": {
    "email": "author@example.com",
    "name": "John Doe"
  },
  "url": "https://example.com/doc_456",
  "created_time": 1730243482,
  "modified_time": 1730243482
}

Delete Documents

DELETEhttps://api.dashworks.ai/v1/documents

Header parameters

Body

connection_id*Connection Id

The unique identifier for your custom API integration connection. You can find this ID in your integration settings at https://web.dashworks.ai/integrations

document_id*Document Id

The unique identifier for the document that was returned by the Dashworks API when it was added via the POST /v1/documents endpoint.

Response

Successful Response

Body

message*string

Success message

Request

const response = await fetch('https://api.dashworks.ai/v1/documents', {
    method: 'DELETE',
    headers: {
      "authorization": "Bearer your_token_here",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "connection_id": 0,
      "document_id": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "Document deleted successfully"
}

PreviousAnswer API NextZapier Integration

Last updated 29 days ago

const response = await fetch('https://api.dashworks.ai/v1/documents', { method: 'PUT', headers: { "authorization": "Bearer your_token_here", "Content-Type": "application/json" }, body: JSON.stringify({ "connection_id": 123, "document_id": "doc_456", "title": "Document Title", "content": "Document content.", "author": { "email": "author@example.com", "name": "John Doe" }, "url": "https://example.com/doc_456", "created_time": 1730243482, "modified_time": 1730243482 }), }); const data = await response.json();