Connection

Add Documents

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

Header parameters

Body

application/json

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

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

APIUserInfonull

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

Response

200404422

Successful Response

Body

application/json

document_id*string

Unique identifier for the document added to Dashworks

Request

JavaScriptCurlPython

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

Response

200422

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

Update Documents

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

Header parameters

Body

application/json

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 it was added via the POST /v1/documents endpoint.

titleTitle

stringnull

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.

stringnull

authorany of

APIUserInfonull

urlUrl

stringnull

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

200404422

Successful Response

Body

application/json

message*string

Success message

Request

JavaScriptCurlPython

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

Response

200422

{
  "message": "Document updated successfully"
}

Get Documents

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

Header parameters

Body

application/json

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

200404422

Successful Response

Body

application/json

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

APIUserInfonull

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

JavaScriptCurlPython

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({
      "document_id": "text"
    }),
});
const data = await response.json();

Response

200422

{
  "connection_id": 123,
  "document_id": "doc_456",
  "title": "Sample Document",
  "content": "This is a sample document content.",
  "author": {
    "email": "[e-mail]",
    "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

application/json

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

200404422

Successful Response

Body

application/json

message*string

Success message

Request

JavaScriptCurlPython

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({
      "document_id": "text"
    }),
});
const data = await response.json();

Response

200422

{
  "message": "Document deleted successfully"
}