Outline · Example Payload

Documentsanswerquestion

Documents

Documentsanswerquestion is an example object payload from Outline, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdpathmethodsummarytagsrequestSchema

Example Payload

Raw ↑ 
{
  "operationId": "documentsAnswerQuestion",
  "path": "/documents.answerQuestion",
  "method": "POST",
  "summary": "Query documents with natural language",
  "tags": [
    "Documents"
  ],
  "requestSchema": {
    "allOf": [
      {
        "type": "object",
        "properties": {
          "query": {
            "type": "string",
            "example": "What is our holiday policy?"
          },
          "userId": {
            "type": "string",
            "description": "Any documents that have not been edited by the user identifier will be filtered out",
            "format": "uuid"
          },
          "collectionId": {
            "type": "string",
            "description": "A collection to search within",
            "format": "uuid"
          },
          "documentId": {
            "type": "string",
            "description": "A document to search within",
            "format": "uuid"
          },
          "statusFilter": {
            "type": "string",
            "description": "Any documents that are not in the specified status will be filtered out",
            "enum": [
              "draft",
              "archived",
              "published"
            ]
          },
          "dateFilter": {
            "type": "string",
            "description": "Any documents that have not been updated within the specified period will be filtered out",
            "enum": [
              "day",
              "week",
              "month",
              "year"
            ]
          }
        }
      }
    ]
  }
}