Documents_create

POST 
/documents

Creates a Datasphere Document

Request

application/json

Body

required

url urirequired

URL of the document.

chunking_strategy ChunkingStrategy (string)

Possible values: [sentence, paragraph, page, sliding]

Strategy to use when chunking the document.

chunking_param1 integer

Default value: 50

Size of a Chunk.

chunking_param2 integer

Default value: 10

Overlap size between chunks.

tags string[]

Document tags.

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

Schema

Schema

id uuidrequired

Unique ID of a Document.

filename stringrequired

Name of the Document.

status DocumentStatus (string)required

Possible values: [submitted, in_progress, completed, failed]

The current Status of the Document.

tags string[]required

Document tags.

number_of_chunks integerrequired

Number of Chunks in the Document.

created_at date-timerequired

Document Creation Date.

updated_at date-timerequired

Document Update Date.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "filename": "player_list.pdf",
  "status": "submitted",
  "tags": [
    "sports",
    "football",
    "game"
  ],
  "number_of_chunks": 2345,
  "created_at": "2024-05-06T12:20-12Z",
  "updated_at": "2024-05-06T12:20-12Z"
}

401

Access is unauthorized.

application/json

Schema

Schema

string

Possible values: [Unauthorized]

404

The server cannot find the requested resource.

application/json

Schema

Schema

string

Possible values: [Not Found]

422

Client error

application/json

Schema

Schema

errors

object[]

required

Array [

type stringrequired

Error type.

code stringrequired

Error code.

message stringrequired

Error details.

attribute stringrequired

Request parameter associated with this error.

url stringrequired

Link to developer resource for this error.

]

Example (from schema)

{
  "errors": [
    {
      "type": "validation_error",
      "code": "invalid_parameter",
      "message": "Invalid chunking_strategy",
      "attribute": "chunking_strategy",
      "url": "https://developer.signalwire.com/rest/overview/error-codes#{code}"
    }
  ]
}

Loading...