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.

put

/v1/documents

Header parameters

authorizationanyrequired

Authorization header

Example: Bearer your_token_here

Body

connection_idintegerrequired

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_idstringrequired

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.

titleany of

contentany of

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

Example: {"email":"[e-mail]","name":"John Doe"}

urlany of

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.dashworks.ai/v1/documents' \
  --header 'authorization: Bearer your_token_here' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
  }'

200

400

404

422

500

200

{
  "document_id": "doc_456"
}

Document successfully created or updated

Get or List Documents

If document_id is provided as a query parameter, returns a single document object. Otherwise, returns a paginated list of documents.

get

/v1/documents

Query parameters

connection_idintegerrequired

The unique identifier for your custom API integration connection.

Example: 123

document_idstring

Unique document identifier. If provided, a single document is returned.

Example: doc_123

limitinteger · default: 20

Number of documents to return when listing

Example: 20

offsetinteger · default: 0

Offset for pagination when listing

Example: 0

Header parameters

authorizationstringrequired

Authorization header

Example: Bearer your_token_here

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.dashworks.ai/v1/documents?connection_id=123' \
  --header 'authorization: Bearer your_token_here'

200

404

422

200

{
  "id": "doc_123",
  "content": "This is a sample document content.",
  "author": {
    "email": "[e-mail]",
    "name": "John Doe"
  },
  "url": "https://example.com/doc_123",
  "created_time": 1730243482,
  "modified_time": 1730243482,
  "title": "Sample Document"
}

Returns a single document or a paginated list of documents.

Delete Documents

delete

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

Header parameters

authorizationanyrequired

Authorization header

Example: Bearer your_token_here

Body

connection_idintegerrequired

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_idstringrequired

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.dashworks.ai/v1/documents' \
  --header 'authorization: Bearer your_token_here' \
  --header 'Content-Type: application/json' \
  --data '{
    "connection_id": 1,
    "document_id": "text"
  }'

200

404

422

200

{
  "message": "Document deleted successfully"
}

Successful Response