Last 7 days, UTC

Average Latency
75ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time
Header Authentication

Authentication
Description
Parameter
String

get your API key by signing into gandalf.io

X-Gandalf-Authorization

Required

Endpoints

HTTP 200 : Answer GET/answers/{document_id}/{question_id}
						[{
  "branch_label": "String Value",
  "text": "String Value"
}]						
Answers to Question

Returns all the answers for the question


Test console
Description
Parameter
string

Identifier for the Document

document_id

Required

string

Identifier for the Question

question_id

Required

HTTP 200 : Clause POST/clause/{document_id}/{index_no}
JSON model for Clause object
						{
  "branch_label": "String Value",
  "doc_id": "String Value",
  "index": 10,
  "label": "String Value",
  "text": "String Value"
}						
Create Clause at Index

Takes a clause JSON, creates a new Clause, adds it at the url <index>


Test console
Description
Parameter
string

Identifier for the Document

document_id

Required

string

Index of clause in Document

index_no

Required

Request Body

HTTP 200 : Question POST/questions/{document_id}
JSON representation of Question
						{
  "doc_id": "String Value",
  "text": "String Value"
}						
Create Question for Document

Takes a 'question' JSON and creates a Question object, returns the newly created question.


Test console
Description
Parameter
string

Identifier for the Document

document_id

Required

Request Body

HTTP 200 : string DELETE/clause/{document_id}/{index_no}
Delete Clause(s)

Deletes Clause(es) at the specified index


Test console
Description
Parameter
string

Identifier of the Document

document_id

Required

string

??

index_no

Required

HTTP 200 : Clause POST/clauses
JSON model for Clause object
						{
  "branch_label": "String Value",
  "doc_id": "String Value",
  "index": 10,
  "label": "String Value",
  "text": "String Value"
}						
Get Clauses

Takes a json formatted clause data and creates a new Clause for the document


HTTP 200 : ListOfClauses GET/clauses/{document_id}
						[{
  "branch_label": "String Value",
  "doc_id": "String Value",
  "label": 10,
  "text": "String Value"
}]						
Get Clauses for a Document

Returns all clauses of the document


Test console
Description
Parameter
string

Identifier for the document
Example: 5241db3172664d2bf1f6808d

document_id

Required

HTTP 200 : Document GET/document/{document_id}
						{
  "clauses": [
    {
      "branch_label": "String Value",
      "doc_id": "String Value",
      "label": 10,
      "text": "String Value"
    }
  ],
  "title": "String Value"
}						
Get Document Details

Returns details of documents, if the document belongs to the user or is public


Test console
Description
Parameter
string

document_id

Required

HTTP 200 : QuestionAnswersModel GET/questions/{document_id}
						[Needs to be updated]						
Get Question/Answers for Document

Returns all the questions including their answers for the document.


Test console
Description
Parameter
string

document_id

Required

HTTP 200 : string GET/labels/{document_id}
Get all branch_label in Document

Returns all the branch_label's present in the document


Test console
Description
Parameter
string

Identifier for the Document

document_id

Required

HTTP 200 : ListOfDocuments GET/documents
						[[
  {
    "_id": "5241db3172664d2bf1f67fdf",
    "no_of_paragraphs": 7,
    "title": "dummycontract"
  },
  {
    "_id": "5241db3172664d2bf1f680b1",
    "no_of_paragraphs": 115,
    "title": "SeriesARestatedCert"
  },
  {
    "_id": "5241db3172664d2bf1f68125",
    "no_of_paragraphs": 86,
    "title": "aa-arcoi"
  },
  {
    "_id": "5241db3172664d2bf1f681f7",
    "no_of_paragraphs": 39,
    "title": "aa-termsheet"
  },
  {
    "_id": "5241db3172664d2bf1f67fe7",
    "no_of_paragraphs": 165,
    "title": "InvestorRightsAgreement"
  },
  {
    "_id": "5241db3172664d2bf1f6808d",
    "no_of_paragraphs": 35,
    "title": "non-disclosure agreement"
  },
  {
    "_id": "5241db3172664d2bf1f6817c",
    "no_of_paragraphs": 122,
    "title": "aa-spa"
  }
]]						
Get all documents

GET - returns a list of documents


HTTP 200 : ListOfClauses GET/clause/{document_id}/{index_no}
						[{
  "branch_label": "String Value",
  "doc_id": "String Value",
  "label": 10,
  "text": "String Value"
}]						
Get clause/branches at index

Returns all the clauses/branches at the specified index


Test console
Description
Parameter
string

Identifier of the document
Example: 5241db3172664d2bf1f67fdf

document_id

Required

string

Index of the clause
Example: 1

index_no

Required

HTTP 200 : Answer POST/answers/{document_id}/{question_id}
						{
  "branch_label": "String Value",
  "text": "String Value"
}						
Post Answer to Question

Takes a 'answer'JSON and creates an Answer object, returns the newly created answer.


Test console
Description
Parameter
string

document_id

Required

string

question_id

Required

Request Body

HTTP 200 : Clause PUT/clause/{document_id}/{index_no}
JSON model for Clause object
						{
  "branch_label": "String Value",
  "doc_id": "String Value",
  "index": 10,
  "label": "String Value",
  "text": "String Value"
}						
Put Clause at Index

Takes a Clause JSON, if the branch label is new then creates a new Clause adds it at the index as a branch. If branch_label is existing, edits the 'text' field of the Clause with new value


Test console
Description
Parameter
string

Identifier for the Document

document_id

Required

string

Index of the Branch

index_no

Required

Request Body

HTTP 200 : string POST/documents
Upload your document

POST - takes a text file, extracts document content, and initialises a wizard


Consume this API completely for free!


By joining the mashape API marketplace you can start using Document Assembly API today!

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.