Hyperforge (v1)

API reference for Hyperforge retrieval agent endpoints.

Audit

Audit log and download request endpoints.

Delete Download Request

Delete a download request by its ID

path Parameters

agent_id required	string (Agent Id)
request_id required	string (Request Id)

Responses

Response samples

Content type

application/json

null

Get Download Request Status

Get status of an audit download request by its ID

path Parameters

agent_id required	string (Agent Id)
request_id required	string (Request Id)

Responses

Response samples

Content type

application/json

{"id": "string",
"type": "string",
"status": "pending",
"download_url": "string",
"query": { }
}

List Download Requests

List all download requests for the account

path Parameters

agent_id

required

string (Agent Id)

Responses

Response samples

Content type

application/json

[{"id": "string",
"type": "string",
"status": "pending",
"download_url": "string",
"query": { }
}
]

Request Interactions Audit Download

Request a download for the audit log of an agent's interactions

path Parameters

agent_id

required

string (Agent Id)

header Parameters

string (Accept)

Default: text/csv

Enum: "application/x-ndjson" "text/csv"

Request Body schema: application/json
required

	Session Id (string) or Session Id (null) (Session Id) Filter by session ID
	Year (integer) or Year (null) (Year) Filter by year (e.g., 2024). If not specified, defaults to the current year.
	Month (integer) or Month (null) (Month) Filter by month (1-12). If not specified, defaults to the past month.

Responses

Request samples

Payload

Content type

application/json

{"session_id": "string",
"year": 0,
"month": 0
}

Response samples

Content type

application/json

{"id": "string",
"type": "string",
"status": "pending",
"download_url": "string",
"query": { }
}

Drivers

Driver configuration endpoints.

Patch Driver

Set Agent Configuration

path Parameters

agent_id required	string (Agent Id)
driver required	string (Driver)

Request Body schema: application/json
required

	Id (string) or Id (null) (Id)
identifier required	string (Identifier)
name required	string (Name)
provider required	any (Provider) The type of source, e.g., 'google', 'marklogic', etc.
config required	object (EncryptedPayload) The configuration specific to the source.

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"identifier": "string",
"name": "string",
"provider": null,
"config": { }
}

Response samples

Content type

application/json

null

Delete Driver

Set Agent Configuration

path Parameters

agent_id required	string (Agent Id)
driver required	string (Driver)

Responses

Response samples

Content type

application/json

null

Add Driver

Set Agent Configuration

path Parameters

agent_id

required

string (Agent Id)

Request Body schema: application/json
required

	Id (string) or Id (null) (Id)
identifier required	string (Identifier)
name required	string (Name)
provider required	any (Provider) The type of source, e.g., 'google', 'marklogic', etc.
config required	object (EncryptedPayload) The configuration specific to the source.

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"identifier": "string",
"name": "string",
"provider": null,
"config": { }
}

Response samples

Content type

application/json

{"id": "string"
}

Get Drivers

Get Agent Configuration

path Parameters

agent_id

required

string (Agent Id)

Responses

Response samples

Content type

application/json

[{ }
]

Import Export

Retrieval Agent import and export endpoints.

Request Export Retrieval Agent

Request the export of a Retrieval Agent. This will send an email with a download link to the email associated with the account.

path Parameters

agent_id

required

string (Agent Id)

Request Body schema: application/json
required

passphrase

required

string (Passphrase) >= 16 characters

Passphrase to encrypt the exported configuration. Will be required for import.

Responses

Request samples

Payload

Content type

application/json

{"passphrase": "stringstringstri"
}

Response samples

Content type

application/json

null

Import Retrieval Agent

Import Retrieval Agent Configuration

path Parameters

agent_id

required

string (Agent Id)

Request Body schema: multipart/form-data
required

file required	string <application/octet-stream> (File)
passphrase required	string (Passphrase) Passphrase for the encrypted export file
overwrite	boolean (Overwrite) Default: false Whether to overwrite existing agent configuration. If false and the agent configuration is not empty, the import will fail.

Responses

Response samples

Content type

application/json

null

MCP

Model Context Protocol interaction endpoints.

Mcp Handler Delete

path Parameters

agent_id required	string (Agent Id)
session required	string (Session)

Responses

Response samples

Content type

application/json

null

Interaction Mcp Handler

path Parameters

agent_id required	string (Agent Id)
session required	string (Session)

Responses

Response samples

Content type

application/json

null

Interaction Mcp Handler

path Parameters

agent_id required	string (Agent Id)
session required	string (Session)

Responses

Response samples

Content type

application/json

null

Prompt Management

Prompt configuration endpoints.

Patch Prompt

Update Prompt of Agent

path Parameters

agent_id required	string (Agent Id)
prompt_id required	string (Prompt Id)

Request Body schema: application/json
required

name required	string (Name)
description required	string (Description)
prompt required	string (Prompt)
	Array of Arguments (objects) or Arguments (null) (Arguments)
	Icons (object) or Icons (null) (Icons)
	Meta (object) or Meta (null) (Meta)
	Prompt Id (string) or Prompt Id (null) (Prompt Id)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"prompt": "string",
"arguments": [{"name": "string",
"description": "string",
"required": true
}
],
"icons": {"property1": "string",
"property2": "string"
},
"meta": {"property1": "string",
"property2": "string"
},
"prompt_id": "string"
}

Response samples

Content type

application/json

null

Delete Prompt

Delete prompt id

path Parameters

agent_id required	string (Agent Id)
prompt_id required	string (Prompt Id)

Responses

Response samples

Content type

application/json

null

Get Prompt

Get Agent Configuration

path Parameters

agent_id required	string (Agent Id)
prompt_id required	string (Prompt Id)

Responses

Response samples

Content type

application/json

{"name": "string",
"description": "string",
"prompt": "string",
"arguments": [{"name": "string",
"description": "string",
"required": true
}
],
"icons": {"property1": "string",
"property2": "string"
},
"meta": {"property1": "string",
"property2": "string"
},
"prompt_id": "string"
}

Add Prompt

Add Prompt to Agent

path Parameters

agent_id

required

string (Agent Id)

Request Body schema: application/json
required

name required	string (Name)
description required	string (Description)
prompt required	string (Prompt)
	Array of Arguments (objects) or Arguments (null) (Arguments)
	Icons (object) or Icons (null) (Icons)
	Meta (object) or Meta (null) (Meta)
	Prompt Id (string) or Prompt Id (null) (Prompt Id)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"prompt": "string",
"arguments": [{"name": "string",
"description": "string",
"required": true
}
],
"icons": {"property1": "string",
"property2": "string"
},
"meta": {"property1": "string",
"property2": "string"
},
"prompt_id": "string"
}

Response samples

Content type

application/json

{"id": "string"
}

Get Prompts

Get Agent Configuration

path Parameters

agent_id

required

string (Agent Id)

Responses

Response samples

Content type

application/json

[{"name": "string",
"description": "string",
"prompt": "string",
"arguments": [{"name": "string",
"description": "string",
"required": true
}
],
"icons": {"property1": "string",
"property2": "string"
},
"meta": {"property1": "string",
"property2": "string"
},
"prompt_id": "string"
}
]

Sessions

Session management endpoints.

Interaction

Interact session

path Parameters

agent_id required	string (Agent Id)
session required	string (Session)

query Parameters

workflow_id

string (Workflow Id)

Default: "default"

Request Body schema: application/json
required

question required	string (Question)
	object (Headers) Default: {}
	object (Arguments) Default: {}
	Array of Chat History (objects) or Chat History (null) (Chat History) Client-managed chat history. When set (even to an empty list), overrides any server-side session history for agents that use previous Q&A context (rephrase, summarize, smart, etc.). Omit the field entirely to use server-side session history.
operation	integer (InteractionOperation) Default: 0 Enum: 0 1
streaming	boolean (Streaming) Default: false

Responses

Request samples

Payload

Content type

application/json

{"question": "string",
"headers": { },
"arguments": { },
"chat_history": [{"question": "string",
"answer": "string"
}
],
"operation": 0,
"streaming": false
}

Response samples

Content type

application/json

null

Patch Session

Create session

path Parameters

agent_id required	string (Agent Id)
session required	string (Session)

Request Body schema: application/json
required

slug required	string (Slug)
name required	string (Name)
summary required	string (Summary)
data required	string (Data)
format required	string (TextFormat) Enum: "PLAIN" "HTML" "RST" "MARKDOWN" "JSON" "KEEP_MARKDOWN" "JSONL" "PLAIN_BLANKLINE_SPLIT"

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string",
"summary": "string",
"data": "string",
"format": "PLAIN"
}

Response samples

Content type

application/json

null

Delete Session

Delete session

path Parameters

agent_id required	string (Agent Id)
session required	string (Session)

Responses

Response samples

Content type

application/json

null

Get Session

Create session

path Parameters

agent_id required	string (Agent Id)
session required	string (Session)

Responses

Response samples

Content type

application/json

{"id": "string",
"slug": "string",
"title": "string",
"summary": "string",
"icon": "string",
"thumbnail": "string",
"metadata": {"metadata": { },
"language": "string",
"languages": ["string"
],
"status": "PENDING"
},
"usermetadata": {"classifications": [ ],
"relations": [ ]
},
"fieldmetadata": [{"paragraphs": [ ],
"question_answers": [ ],
"field": {"field_type": "file",
"field": "string"
}
}
],
"computedmetadata": {"field_classifications": [ ]
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"last_seqid": 0,
"last_account_seq": 0,
"queue": "private",
"hidden": true,
"origin": {"source_id": "string",
"url": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"metadata": { },
"tags": [ ],
"collaborators": [ ],
"filename": "string",
"related": [ ],
"path": "string",
"sync_metadata": {"file_id": "string",
"auth_provider": "string",
"content_hash": "string"
},
"source": "API"
},
"extra": {"metadata": { }
},
"relations": [{"relation": "ABOUT",
"label": "string",
"metadata": {"paragraph_id": "string",
"source_start": 0,
"source_end": 0,
"to_start": 0,
"to_end": 0,
"data_augmentation_task_id": "string"
},
"from": {"value": "string",
"type": "entity",
"group": "string"
},
"to": {"value": "string",
"type": "entity",
"group": "string"
}
}
],
"data": {"texts": {"property1": {"value": {"body": "string",
"format": "PLAIN",
"md5": "string",
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": ["string"
],
"paragraphs": [{"start": 0,
"end": 0,
"start_seconds": [null
],
"end_seconds": [null
],
"kind": "TEXT",
"classifications": [null
],
"sentences": [null
],
"key": "string",
"page": {"page": null,
"page_with_visual": null
},
"representation": {"is_a_table": null,
"reference_file": null
},
"relations": {"parents": [ ],
"siblings": [ ],
"replacements": [ ]
}
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [null
]
},
"property2": {"entities": [null
]
}
},
"classifications": [{"labelset": "string",
"label": "string"
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [null
],
"entity": "string"
},
"property2": {"position": [null
],
"entity": "string"
}
},
"relations": [{"relation": "ABOUT",
"label": "string",
"metadata": {"paragraph_id": null,
"source_start": null,
"source_end": null,
"to_start": null,
"to_end": null,
"data_augmentation_task_id": null
},
"from": {"value": null,
"type": null,
"group": null
},
"to": {"value": null,
"type": null,
"group": null
}
}
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
},
"property2": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [{"token": "string",
"root": "string",
"type": "string"
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"split_metadata": {"property1": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"property2": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [{"start": 0,
"end": 0,
"start_paragraph": 0,
"end_paragraph": 0,
"vector": [null
]
}
]
},
"split_vectors": {"property1": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
},
"property2": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [{"question": {"text": null,
"language": null,
"ids_paragraphs": [ ]
},
"answers": [null
]
}
]
},
"split_question_answers": {"property1": {"question_answer": [{"question": null,
"answers": [ ]
}
]
},
"property2": {"question_answer": [{"question": null,
"answers": [ ]
}
]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": "string",
"vector": [0
]
}
],
"property2": [{"node_value": "string",
"vector": [0
]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": "string",
"vector": [0
]
}
],
"property2": [{"relation_label": "string",
"vector": [0
]
}
]
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
},
"property2": {"value": {"body": "string",
"format": "PLAIN",
"md5": "string",
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": ["string"
],
"paragraphs": [{"start": 0,
"end": 0,
"start_seconds": [null
],
"end_seconds": [null
],
"kind": "TEXT",
"classifications": [null
],
"sentences": [null
],
"key": "string",
"page": {"page": null,
"page_with_visual": null
},
"representation": {"is_a_table": null,
"reference_file": null
},
"relations": {"parents": [ ],
"siblings": [ ],
"replacements": [ ]
}
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [null
]
},
"property2": {"entities": [null
]
}
},
"classifications": [{"labelset": "string",
"label": "string"
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [null
],
"entity": "string"
},
"property2": {"position": [null
],
"entity": "string"
}
},
"relations": [{"relation": "ABOUT",
"label": "string",
"metadata": {"paragraph_id": null,
"source_start": null,
"source_end": null,
"to_start": null,
"to_end": null,
"data_augmentation_task_id": null
},
"from": {"value": null,
"type": null,
"group": null
},
"to": {"value": null,
"type": null,
"group": null
}
}
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
},
"property2": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [{"token": "string",
"root": "string",
"type": "string"
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"split_metadata": {"property1": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"property2": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [{"start": 0,
"end": 0,
"start_paragraph": 0,
"end_paragraph": 0,
"vector": [null
]
}
]
},
"split_vectors": {"property1": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
},
"property2": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [{"question": {"text": null,
"language": null,
"ids_paragraphs": [ ]
},
"answers": [null
]
}
]
},
"split_question_answers": {"property1": {"question_answer": [{"question": null,
"answers": [ ]
}
]
},
"property2": {"question_answer": [{"question": null,
"answers": [ ]
}
]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": "string",
"vector": [0
]
}
],
"property2": [{"node_value": "string",
"vector": [0
]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": "string",
"vector": [0
]
}
],
"property2": [{"relation_label": "string",
"vector": [0
]
}
]
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
}
},
"files": {"property1": {"value": {"added": "2019-08-24T14:15:22Z",
"file": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"password": "string",
"external": false,
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": ["string"
],
"paragraphs": [{"start": 0,
"end": 0,
"start_seconds": [null
],
"end_seconds": [null
],
"kind": "TEXT",
"classifications": [null
],
"sentences": [null
],
"key": "string",
"page": {"page": null,
"page_with_visual": null
},
"representation": {"is_a_table": null,
"reference_file": null
},
"relations": {"parents": [ ],
"siblings": [ ],
"replacements": [ ]
}
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [null
]
},
"property2": {"entities": [null
]
}
},
"classifications": [{"labelset": "string",
"label": "string"
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [null
],
"entity": "string"
},
"property2": {"position": [null
],
"entity": "string"
}
},
"relations": [{"relation": "ABOUT",
"label": "string",
"metadata": {"paragraph_id": null,
"source_start": null,
"source_end": null,
"to_start": null,
"to_end": null,
"data_augmentation_task_id": null
},
"from": {"value": null,
"type": null,
"group": null
},
"to": {"value": null,
"type": null,
"group": null
}
}
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
},
"property2": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [{"token": "string",
"root": "string",
"type": "string"
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"split_metadata": {"property1": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"property2": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [{"start": 0,
"end": 0,
"start_paragraph": 0,
"end_paragraph": 0,
"vector": [null
]
}
]
},
"split_vectors": {"property1": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
},
"property2": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [{"question": {"text": null,
"language": null,
"ids_paragraphs": [ ]
},
"answers": [null
]
}
]
},
"split_question_answers": {"property1": {"question_answer": [{"question": null,
"answers": [ ]
}
]
},
"property2": {"question_answer": [{"question": null,
"answers": [ ]
}
]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": "string",
"vector": [0
]
}
],
"property2": [{"node_value": "string",
"vector": [0
]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": "string",
"vector": [0
]
}
],
"property2": [{"relation_label": "string",
"vector": [0
]
}
]
},
"file": {"language": "string",
"md5": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"nested": {"property1": "string",
"property2": "string"
},
"file_generated": {"property1": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"property2": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
}
},
"file_rows_previews": {"property1": {"sheets": {"property1": {"rows": null
},
"property2": {"rows": null
}
}
},
"property2": {"sheets": {"property1": {"rows": null
},
"property2": {"rows": null
}
}
}
},
"file_preview": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"file_pages_previews": {"pages": [{"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
}
],
"positions": [{"start": 0,
"end": 0
}
],
"structures": [{"page": {"width": null,
"height": null
},
"tokens": [null
]
}
]
},
"file_thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"field": "string",
"icon": "string",
"nested_position": {"property1": {"start": 0,
"end": 0,
"page": 0
},
"property2": {"start": 0,
"end": 0,
"page": 0
}
},
"nested_list_position": {"property1": {"positions": [{"start": null,
"end": null,
"page": null
}
]
},
"property2": {"positions": [{"start": null,
"end": null,
"page": null
}
]
}
}
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
},
"property2": {"value": {"added": "2019-08-24T14:15:22Z",
"file": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"password": "string",
"external": false,
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": ["string"
],
"paragraphs": [{"start": 0,
"end": 0,
"start_seconds": [null
],
"end_seconds": [null
],
"kind": "TEXT",
"classifications": [null
],
"sentences": [null
],
"key": "string",
"page": {"page": null,
"page_with_visual": null
},
"representation": {"is_a_table": null,
"reference_file": null
},
"relations": {"parents": [ ],
"siblings": [ ],
"replacements": [ ]
}
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [null
]
},
"property2": {"entities": [null
]
}
},
"classifications": [{"labelset": "string",
"label": "string"
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [null
],
"entity": "string"
},
"property2": {"position": [null
],
"entity": "string"
}
},
"relations": [{"relation": "ABOUT",
"label": "string",
"metadata": {"paragraph_id": null,
"source_start": null,
"source_end": null,
"to_start": null,
"to_end": null,
"data_augmentation_task_id": null
},
"from": {"value": null,
"type": null,
"group": null
},
"to": {"value": null,
"type": null,
"group": null
}
}
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
},
"property2": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [{"token": "string",
"root": "string",
"type": "string"
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"split_metadata": {"property1": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"property2": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [{"start": 0,
"end": 0,
"start_paragraph": 0,
"end_paragraph": 0,
"vector": [null
]
}
]
},
"split_vectors": {"property1": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
},
"property2": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [{"question": {"text": null,
"language": null,
"ids_paragraphs": [ ]
},
"answers": [null
]
}
]
},
"split_question_answers": {"property1": {"question_answer": [{"question": null,
"answers": [ ]
}
]
},
"property2": {"question_answer": [{"question": null,
"answers": [ ]
}
]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": "string",
"vector": [0
]
}
],
"property2": [{"node_value": "string",
"vector": [0
]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": "string",
"vector": [0
]
}
],
"property2": [{"relation_label": "string",
"vector": [0
]
}
]
},
"file": {"language": "string",
"md5": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"nested": {"property1": "string",
"property2": "string"
},
"file_generated": {"property1": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"property2": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
}
},
"file_rows_previews": {"property1": {"sheets": {"property1": {"rows": null
},
"property2": {"rows": null
}
}
},
"property2": {"sheets": {"property1": {"rows": null
},
"property2": {"rows": null
}
}
}
},
"file_preview": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"file_pages_previews": {"pages": [{"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
}
],
"positions": [{"start": 0,
"end": 0
}
],
"structures": [{"page": {"width": null,
"height": null
},
"tokens": [null
]
}
]
},
"file_thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"field": "string",
"icon": "string",
"nested_position": {"property1": {"start": 0,
"end": 0,
"page": 0
},
"property2": {"start": 0,
"end": 0,
"page": 0
}
},
"nested_list_position": {"property1": {"positions": [{"start": null,
"end": null,
"page": null
}
]
},
"property2": {"positions": [{"start": null,
"end": null,
"page": null
}
]
}
}
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
}
},
"links": {"property1": {"value": {"added": "2019-08-24T14:15:22Z",
"headers": {"property1": "string",
"property2": "string"
},
"cookies": {"property1": "string",
"property2": "string"
},
"uri": "string",
"language": "string",
"localstorage": {"property1": "string",
"property2": "string"
},
"css_selector": "string",
"xpath": "string",
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": ["string"
],
"paragraphs": [{"start": 0,
"end": 0,
"start_seconds": [null
],
"end_seconds": [null
],
"kind": "TEXT",
"classifications": [null
],
"sentences": [null
],
"key": "string",
"page": {"page": null,
"page_with_visual": null
},
"representation": {"is_a_table": null,
"reference_file": null
},
"relations": {"parents": [ ],
"siblings": [ ],
"replacements": [ ]
}
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [null
]
},
"property2": {"entities": [null
]
}
},
"classifications": [{"labelset": "string",
"label": "string"
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [null
],
"entity": "string"
},
"property2": {"position": [null
],
"entity": "string"
}
},
"relations": [{"relation": "ABOUT",
"label": "string",
"metadata": {"paragraph_id": null,
"source_start": null,
"source_end": null,
"to_start": null,
"to_end": null,
"data_augmentation_task_id": null
},
"from": {"value": null,
"type": null,
"group": null
},
"to": {"value": null,
"type": null,
"group": null
}
}
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
},
"property2": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [{"token": "string",
"root": "string",
"type": "string"
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"split_metadata": {"property1": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"property2": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [{"start": 0,
"end": 0,
"start_paragraph": 0,
"end_paragraph": 0,
"vector": [null
]
}
]
},
"split_vectors": {"property1": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
},
"property2": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [{"question": {"text": null,
"language": null,
"ids_paragraphs": [ ]
},
"answers": [null
]
}
]
},
"split_question_answers": {"property1": {"question_answer": [{"question": null,
"answers": [ ]
}
]
},
"property2": {"question_answer": [{"question": null,
"answers": [ ]
}
]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": "string",
"vector": [0
]
}
],
"property2": [{"node_value": "string",
"vector": [0
]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": "string",
"vector": [0
]
}
],
"property2": [{"relation_label": "string",
"vector": [0
]
}
]
},
"link": {"date": "2019-08-24T14:15:22Z",
"language": "string",
"title": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"link_thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"link_preview": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"field": "string",
"link_image": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"description": "string",
"type": "string",
"embed": "string",
"file_generated": {"property1": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"property2": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
}
}
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
},
"property2": {"value": {"added": "2019-08-24T14:15:22Z",
"headers": {"property1": "string",
"property2": "string"
},
"cookies": {"property1": "string",
"property2": "string"
},
"uri": "string",
"language": "string",
"localstorage": {"property1": "string",
"property2": "string"
},
"css_selector": "string",
"xpath": "string",
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": ["string"
],
"paragraphs": [{"start": 0,
"end": 0,
"start_seconds": [null
],
"end_seconds": [null
],
"kind": "TEXT",
"classifications": [null
],
"sentences": [null
],
"key": "string",
"page": {"page": null,
"page_with_visual": null
},
"representation": {"is_a_table": null,
"reference_file": null
},
"relations": {"parents": [ ],
"siblings": [ ],
"replacements": [ ]
}
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [null
]
},
"property2": {"entities": [null
]
}
},
"classifications": [{"labelset": "string",
"label": "string"
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [null
],
"entity": "string"
},
"property2": {"position": [null
],
"entity": "string"
}
},
"relations": [{"relation": "ABOUT",
"label": "string",
"metadata": {"paragraph_id": null,
"source_start": null,
"source_end": null,
"to_start": null,
"to_end": null,
"data_augmentation_task_id": null
},
"from": {"value": null,
"type": null,
"group": null
},
"to": {"value": null,
"type": null,
"group": null
}
}
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
},
"property2": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [{"token": "string",
"root": "string",
"type": "string"
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"split_metadata": {"property1": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"property2": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [{"start": 0,
"end": 0,
"start_paragraph": 0,
"end_paragraph": 0,
"vector": [null
]
}
]
},
"split_vectors": {"property1": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
},
"property2": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [{"question": {"text": null,
"language": null,
"ids_paragraphs": [ ]
},
"answers": [null
]
}
]
},
"split_question_answers": {"property1": {"question_answer": [{"question": null,
"answers": [ ]
}
]
},
"property2": {"question_answer": [{"question": null,
"answers": [ ]
}
]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": "string",
"vector": [0
]
}
],
"property2": [{"node_value": "string",
"vector": [0
]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": "string",
"vector": [0
]
}
],
"property2": [{"relation_label": "string",
"vector": [0
]
}
]
},
"link": {"date": "2019-08-24T14:15:22Z",
"language": "string",
"title": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"link_thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"link_preview": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"field": "string",
"link_image": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"description": "string",
"type": "string",
"embed": "string",
"file_generated": {"property1": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"property2": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
}
}
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
}
},
"conversations": {"property1": {"value": {"pages": 0,
"size": 0,
"total": 0,
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": ["string"
],
"paragraphs": [{"start": 0,
"end": 0,
"start_seconds": [null
],
"end_seconds": [null
],
"kind": "TEXT",
"classifications": [null
],
"sentences": [null
],
"key": "string",
"page": {"page": null,
"page_with_visual": null
},
"representation": {"is_a_table": null,
"reference_file": null
},
"relations": {"parents": [ ],
"siblings": [ ],
"replacements": [ ]
}
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [null
]
},
"property2": {"entities": [null
]
}
},
"classifications": [{"labelset": "string",
"label": "string"
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [null
],
"entity": "string"
},
"property2": {"position": [null
],
"entity": "string"
}
},
"relations": [{"relation": "ABOUT",
"label": "string",
"metadata": {"paragraph_id": null,
"source_start": null,
"source_end": null,
"to_start": null,
"to_end": null,
"data_augmentation_task_id": null
},
"from": {"value": null,
"type": null,
"group": null
},
"to": {"value": null,
"type": null,
"group": null
}
}
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
},
"property2": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [{"token": "string",
"root": "string",
"type": "string"
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"split_metadata": {"property1": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"property2": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [{"start": 0,
"end": 0,
"start_paragraph": 0,
"end_paragraph": 0,
"vector": [null
]
}
]
},
"split_vectors": {"property1": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
},
"property2": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [{"question": {"text": null,
"language": null,
"ids_paragraphs": [ ]
},
"answers": [null
]
}
]
},
"split_question_answers": {"property1": {"question_answer": [{"question": null,
"answers": [ ]
}
]
},
"property2": {"question_answer": [{"question": null,
"answers": [ ]
}
]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": "string",
"vector": [0
]
}
],
"property2": [{"node_value": "string",
"vector": [0
]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": "string",
"vector": [0
]
}
],
"property2": [{"relation_label": "string",
"vector": [0
]
}
]
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
},
"property2": {"value": {"pages": 0,
"size": 0,
"total": 0,
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": ["string"
],
"paragraphs": [{"start": 0,
"end": 0,
"start_seconds": [null
],
"end_seconds": [null
],
"kind": "TEXT",
"classifications": [null
],
"sentences": [null
],
"key": "string",
"page": {"page": null,
"page_with_visual": null
},
"representation": {"is_a_table": null,
"reference_file": null
},
"relations": {"parents": [ ],
"siblings": [ ],
"replacements": [ ]
}
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [null
]
},
"property2": {"entities": [null
]
}
},
"classifications": [{"labelset": "string",
"label": "string"
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [null
],
"entity": "string"
},
"property2": {"position": [null
],
"entity": "string"
}
},
"relations": [{"relation": "ABOUT",
"label": "string",
"metadata": {"paragraph_id": null,
"source_start": null,
"source_end": null,
"to_start": null,
"to_end": null,
"data_augmentation_task_id": null
},
"from": {"value": null,
"type": null,
"group": null
},
"to": {"value": null,
"type": null,
"group": null
}
}
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
},
"property2": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [{"token": "string",
"root": "string",
"type": "string"
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"split_metadata": {"property1": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"property2": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [{"start": 0,
"end": 0,
"start_paragraph": 0,
"end_paragraph": 0,
"vector": [null
]
}
]
},
"split_vectors": {"property1": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
},
"property2": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [{"question": {"text": null,
"language": null,
"ids_paragraphs": [ ]
},
"answers": [null
]
}
]
},
"split_question_answers": {"property1": {"question_answer": [{"question": null,
"answers": [ ]
}
]
},
"property2": {"question_answer": [{"question": null,
"answers": [ ]
}
]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": "string",
"vector": [0
]
}
],
"property2": [{"node_value": "string",
"vector": [0
]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": "string",
"vector": [0
]
}
],
"property2": [{"relation_label": "string",
"vector": [0
]
}
]
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
}
},
"generics": {"property1": {"value": "string",
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": ["string"
],
"paragraphs": [{"start": 0,
"end": 0,
"start_seconds": [null
],
"end_seconds": [null
],
"kind": "TEXT",
"classifications": [null
],
"sentences": [null
],
"key": "string",
"page": {"page": null,
"page_with_visual": null
},
"representation": {"is_a_table": null,
"reference_file": null
},
"relations": {"parents": [ ],
"siblings": [ ],
"replacements": [ ]
}
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [null
]
},
"property2": {"entities": [null
]
}
},
"classifications": [{"labelset": "string",
"label": "string"
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [null
],
"entity": "string"
},
"property2": {"position": [null
],
"entity": "string"
}
},
"relations": [{"relation": "ABOUT",
"label": "string",
"metadata": {"paragraph_id": null,
"source_start": null,
"source_end": null,
"to_start": null,
"to_end": null,
"data_augmentation_task_id": null
},
"from": {"value": null,
"type": null,
"group": null
},
"to": {"value": null,
"type": null,
"group": null
}
}
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
},
"property2": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [{"token": "string",
"root": "string",
"type": "string"
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"split_metadata": {"property1": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"property2": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [{"start": 0,
"end": 0,
"start_paragraph": 0,
"end_paragraph": 0,
"vector": [null
]
}
]
},
"split_vectors": {"property1": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
},
"property2": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [{"question": {"text": null,
"language": null,
"ids_paragraphs": [ ]
},
"answers": [null
]
}
]
},
"split_question_answers": {"property1": {"question_answer": [{"question": null,
"answers": [ ]
}
]
},
"property2": {"question_answer": [{"question": null,
"answers": [ ]
}
]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": "string",
"vector": [0
]
}
],
"property2": [{"node_value": "string",
"vector": [0
]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": "string",
"vector": [0
]
}
],
"property2": [{"relation_label": "string",
"vector": [0
]
}
]
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
},
"property2": {"value": "string",
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": ["string"
],
"paragraphs": [{"start": 0,
"end": 0,
"start_seconds": [null
],
"end_seconds": [null
],
"kind": "TEXT",
"classifications": [null
],
"sentences": [null
],
"key": "string",
"page": {"page": null,
"page_with_visual": null
},
"representation": {"is_a_table": null,
"reference_file": null
},
"relations": {"parents": [ ],
"siblings": [ ],
"replacements": [ ]
}
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [null
]
},
"property2": {"entities": [null
]
}
},
"classifications": [{"labelset": "string",
"label": "string"
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [null
],
"entity": "string"
},
"property2": {"position": [null
],
"entity": "string"
}
},
"relations": [{"relation": "ABOUT",
"label": "string",
"metadata": {"paragraph_id": null,
"source_start": null,
"source_end": null,
"to_start": null,
"to_end": null,
"data_augmentation_task_id": null
},
"from": {"value": null,
"type": null,
"group": null
},
"to": {"value": null,
"type": null,
"group": null
}
}
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
},
"property2": {"links": ["string"
],
"paragraphs": [{"start": null,
"end": null,
"start_seconds": null,
"end_seconds": null,
"kind": null,
"classifications": null,
"sentences": null,
"key": null,
"page": null,
"representation": null,
"relations": null
}
],
"ner": {"property1": "string",
"property2": "string"
},
"entities": {"property1": {"entities": [ ]
},
"property2": {"entities": [ ]
}
},
"classifications": [{"labelset": null,
"label": null
}
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"summary": "string",
"positions": {"property1": {"position": [ ],
"entity": null
},
"property2": {"position": [ ],
"entity": null
}
},
"relations": [{"relation": null,
"label": null,
"metadata": null,
"from": null,
"to": null
}
],
"mime_type": "string"
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [{"token": "string",
"root": "string",
"type": "string"
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"split_metadata": {"property1": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
},
"property2": {"entities": [{"token": null,
"root": null,
"type": null
}
],
"tokens": {"property1": 0,
"property2": 0
}
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [{"start": 0,
"end": 0,
"start_paragraph": 0,
"end_paragraph": 0,
"vector": [null
]
}
]
},
"split_vectors": {"property1": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
},
"property2": {"vectors": [{"start": null,
"end": null,
"start_paragraph": null,
"end_paragraph": null,
"vector": null
}
]
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [{"question": {"text": null,
"language": null,
"ids_paragraphs": [ ]
},
"answers": [null
]
}
]
},
"split_question_answers": {"property1": {"question_answer": [{"question": null,
"answers": [ ]
}
]
},
"property2": {"question_answer": [{"question": null,
"answers": [ ]
}
]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": "string",
"vector": [0
]
}
],
"property2": [{"node_value": "string",
"vector": [0
]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": "string",
"vector": [0
]
}
],
"property2": [{"relation_label": "string",
"vector": [0
]
}
]
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
}
},
"key_values": {"property1": {"value": {"data": {"property1": "string",
"property2": "string"
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
},
"property2": {"value": {"data": {"property1": "string",
"property2": "string"
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
}
}
},
"security": {"access_groups": [ ]
}
}

Create Session

Create session

path Parameters

agent_id

required

string (Agent Id)

Request Body schema: application/json
required

slug required	string (Slug)
name required	string (Name)
summary required	string (Summary)
data required	string (Data)
format required	string (TextFormat) Enum: "PLAIN" "HTML" "RST" "MARKDOWN" "JSON" "KEEP_MARKDOWN" "JSONL" "PLAIN_BLANKLINE_SPLIT"

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string",
"summary": "string",
"data": "string",
"format": "PLAIN"
}

Response samples

Content type

application/json

{"uuid": "string",
"elapsed": 0,
"seqid": 0
}

Get Sessions

Create session

path Parameters

agent_id

required

string (Agent Id)

query Parameters

page	integer (Page) Default: 0 Requested page number (0-based)
size	integer (Size) Default: 20 Page size

Responses

Response samples

Content type

application/json

{"resources": [{"id": "string",
"slug": "string",
"title": "string",
"summary": "string",
"icon": "string",
"thumbnail": "string",
"metadata": {"metadata": { },
"language": "string",
"languages": ["string"
],
"status": "PENDING"
},
"usermetadata": {"classifications": [ ],
"relations": [ ]
},
"fieldmetadata": [{"paragraphs": [ ],
"question_answers": [ ],
"field": {"field_type": "file",
"field": "string"
}
}
],
"computedmetadata": {"field_classifications": [ ]
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"last_seqid": 0,
"last_account_seq": 0,
"queue": "private",
"hidden": true,
"origin": {"source_id": "string",
"url": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"metadata": { },
"tags": [ ],
"collaborators": [ ],
"filename": "string",
"related": [ ],
"path": "string",
"sync_metadata": {"file_id": "string",
"auth_provider": "string",
"content_hash": "string"
},
"source": "API"
},
"extra": {"metadata": { }
},
"relations": [{"relation": "ABOUT",
"label": "string",
"metadata": {"paragraph_id": "string",
"source_start": 0,
"source_end": 0,
"to_start": 0,
"to_end": 0,
"data_augmentation_task_id": "string"
},
"from": {"value": "string",
"type": "entity",
"group": "string"
},
"to": {"value": "string",
"type": "entity",
"group": "string"
}
}
],
"data": {"texts": {"property1": {"value": {"body": "string",
"format": "PLAIN",
"md5": "string",
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": [null
],
"paragraphs": [null
],
"ner": {"property1": null,
"property2": null
},
"entities": {"property1": null,
"property2": null
},
"classifications": [null
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"language": "string",
"summary": "string",
"positions": {"property1": null,
"property2": null
},
"relations": [null
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
},
"property2": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [null
],
"tokens": {"property1": null,
"property2": null
}
},
"split_metadata": {"property1": {"entities": null,
"tokens": null
},
"property2": {"entities": null,
"tokens": null
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [null
]
},
"split_vectors": {"property1": {"vectors": null
},
"property2": {"vectors": null
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [null
]
},
"split_question_answers": {"property1": {"question_answer": [ ]
},
"property2": {"question_answer": [ ]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": null,
"vector": [ ]
}
],
"property2": [{"node_value": null,
"vector": [ ]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": null,
"vector": [ ]
}
],
"property2": [{"relation_label": null,
"vector": [ ]
}
]
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
},
"property2": {"value": {"body": "string",
"format": "PLAIN",
"md5": "string",
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": [null
],
"paragraphs": [null
],
"ner": {"property1": null,
"property2": null
},
"entities": {"property1": null,
"property2": null
},
"classifications": [null
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"language": "string",
"summary": "string",
"positions": {"property1": null,
"property2": null
},
"relations": [null
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
},
"property2": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [null
],
"tokens": {"property1": null,
"property2": null
}
},
"split_metadata": {"property1": {"entities": null,
"tokens": null
},
"property2": {"entities": null,
"tokens": null
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [null
]
},
"split_vectors": {"property1": {"vectors": null
},
"property2": {"vectors": null
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [null
]
},
"split_question_answers": {"property1": {"question_answer": [ ]
},
"property2": {"question_answer": [ ]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": null,
"vector": [ ]
}
],
"property2": [{"node_value": null,
"vector": [ ]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": null,
"vector": [ ]
}
],
"property2": [{"relation_label": null,
"vector": [ ]
}
]
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
}
},
"files": {"property1": {"value": {"added": "2019-08-24T14:15:22Z",
"file": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"password": "string",
"external": false,
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": [null
],
"paragraphs": [null
],
"ner": {"property1": null,
"property2": null
},
"entities": {"property1": null,
"property2": null
},
"classifications": [null
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"language": "string",
"summary": "string",
"positions": {"property1": null,
"property2": null
},
"relations": [null
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
},
"property2": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [null
],
"tokens": {"property1": null,
"property2": null
}
},
"split_metadata": {"property1": {"entities": null,
"tokens": null
},
"property2": {"entities": null,
"tokens": null
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [null
]
},
"split_vectors": {"property1": {"vectors": null
},
"property2": {"vectors": null
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [null
]
},
"split_question_answers": {"property1": {"question_answer": [ ]
},
"property2": {"question_answer": [ ]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": null,
"vector": [ ]
}
],
"property2": [{"node_value": null,
"vector": [ ]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": null,
"vector": [ ]
}
],
"property2": [{"relation_label": null,
"vector": [ ]
}
]
},
"file": {"language": "string",
"md5": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"nested": {"property1": "string",
"property2": "string"
},
"file_generated": {"property1": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"property2": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
}
},
"file_rows_previews": {"property1": {"sheets": null
},
"property2": {"sheets": null
}
},
"file_preview": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"file_pages_previews": {"pages": [null
],
"positions": [null
],
"structures": [null
]
},
"file_thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"field": "string",
"icon": "string",
"nested_position": {"property1": {"start": null,
"end": null,
"page": null
},
"property2": {"start": null,
"end": null,
"page": null
}
},
"nested_list_position": {"property1": {"positions": [ ]
},
"property2": {"positions": [ ]
}
}
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
},
"property2": {"value": {"added": "2019-08-24T14:15:22Z",
"file": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"language": "string",
"password": "string",
"external": false,
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": [null
],
"paragraphs": [null
],
"ner": {"property1": null,
"property2": null
},
"entities": {"property1": null,
"property2": null
},
"classifications": [null
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"language": "string",
"summary": "string",
"positions": {"property1": null,
"property2": null
},
"relations": [null
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
},
"property2": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [null
],
"tokens": {"property1": null,
"property2": null
}
},
"split_metadata": {"property1": {"entities": null,
"tokens": null
},
"property2": {"entities": null,
"tokens": null
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [null
]
},
"split_vectors": {"property1": {"vectors": null
},
"property2": {"vectors": null
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [null
]
},
"split_question_answers": {"property1": {"question_answer": [ ]
},
"property2": {"question_answer": [ ]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": null,
"vector": [ ]
}
],
"property2": [{"node_value": null,
"vector": [ ]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": null,
"vector": [ ]
}
],
"property2": [{"relation_label": null,
"vector": [ ]
}
]
},
"file": {"language": "string",
"md5": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"nested": {"property1": "string",
"property2": "string"
},
"file_generated": {"property1": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"property2": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
}
},
"file_rows_previews": {"property1": {"sheets": null
},
"property2": {"sheets": null
}
},
"file_preview": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"file_pages_previews": {"pages": [null
],
"positions": [null
],
"structures": [null
]
},
"file_thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"field": "string",
"icon": "string",
"nested_position": {"property1": {"start": null,
"end": null,
"page": null
},
"property2": {"start": null,
"end": null,
"page": null
}
},
"nested_list_position": {"property1": {"positions": [ ]
},
"property2": {"positions": [ ]
}
}
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
}
},
"links": {"property1": {"value": {"added": "2019-08-24T14:15:22Z",
"headers": {"property1": "string",
"property2": "string"
},
"cookies": {"property1": "string",
"property2": "string"
},
"uri": "string",
"language": "string",
"localstorage": {"property1": "string",
"property2": "string"
},
"css_selector": "string",
"xpath": "string",
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": [null
],
"paragraphs": [null
],
"ner": {"property1": null,
"property2": null
},
"entities": {"property1": null,
"property2": null
},
"classifications": [null
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"language": "string",
"summary": "string",
"positions": {"property1": null,
"property2": null
},
"relations": [null
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
},
"property2": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [null
],
"tokens": {"property1": null,
"property2": null
}
},
"split_metadata": {"property1": {"entities": null,
"tokens": null
},
"property2": {"entities": null,
"tokens": null
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [null
]
},
"split_vectors": {"property1": {"vectors": null
},
"property2": {"vectors": null
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [null
]
},
"split_question_answers": {"property1": {"question_answer": [ ]
},
"property2": {"question_answer": [ ]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": null,
"vector": [ ]
}
],
"property2": [{"node_value": null,
"vector": [ ]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": null,
"vector": [ ]
}
],
"property2": [{"relation_label": null,
"vector": [ ]
}
]
},
"link": {"date": "2019-08-24T14:15:22Z",
"language": "string",
"title": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"link_thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"link_preview": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"field": "string",
"link_image": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"description": "string",
"type": "string",
"embed": "string",
"file_generated": {"property1": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"property2": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
}
}
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
},
"property2": {"value": {"added": "2019-08-24T14:15:22Z",
"headers": {"property1": "string",
"property2": "string"
},
"cookies": {"property1": "string",
"property2": "string"
},
"uri": "string",
"language": "string",
"localstorage": {"property1": "string",
"property2": "string"
},
"css_selector": "string",
"xpath": "string",
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": [null
],
"paragraphs": [null
],
"ner": {"property1": null,
"property2": null
},
"entities": {"property1": null,
"property2": null
},
"classifications": [null
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"language": "string",
"summary": "string",
"positions": {"property1": null,
"property2": null
},
"relations": [null
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
},
"property2": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [null
],
"tokens": {"property1": null,
"property2": null
}
},
"split_metadata": {"property1": {"entities": null,
"tokens": null
},
"property2": {"entities": null,
"tokens": null
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [null
]
},
"split_vectors": {"property1": {"vectors": null
},
"property2": {"vectors": null
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [null
]
},
"split_question_answers": {"property1": {"question_answer": [ ]
},
"property2": {"question_answer": [ ]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": null,
"vector": [ ]
}
],
"property2": [{"node_value": null,
"vector": [ ]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": null,
"vector": [ ]
}
],
"property2": [{"relation_label": null,
"vector": [ ]
}
]
},
"link": {"date": "2019-08-24T14:15:22Z",
"language": "string",
"title": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"link_thumbnail": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"link_preview": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"field": "string",
"link_image": {"uri": "string",
"size": 0,
"content_type": "string",
"filename": "string",
"md5": "string"
},
"description": "string",
"type": "string",
"embed": "string",
"file_generated": {"property1": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"property2": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
}
}
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
}
},
"conversations": {"property1": {"value": {"pages": 0,
"size": 0,
"total": 0,
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": [null
],
"paragraphs": [null
],
"ner": {"property1": null,
"property2": null
},
"entities": {"property1": null,
"property2": null
},
"classifications": [null
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"language": "string",
"summary": "string",
"positions": {"property1": null,
"property2": null
},
"relations": [null
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
},
"property2": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [null
],
"tokens": {"property1": null,
"property2": null
}
},
"split_metadata": {"property1": {"entities": null,
"tokens": null
},
"property2": {"entities": null,
"tokens": null
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [null
]
},
"split_vectors": {"property1": {"vectors": null
},
"property2": {"vectors": null
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [null
]
},
"split_question_answers": {"property1": {"question_answer": [ ]
},
"property2": {"question_answer": [ ]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": null,
"vector": [ ]
}
],
"property2": [{"node_value": null,
"vector": [ ]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": null,
"vector": [ ]
}
],
"property2": [{"relation_label": null,
"vector": [ ]
}
]
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
},
"property2": {"value": {"pages": 0,
"size": 0,
"total": 0,
"extract_strategy": "string",
"split_strategy": "string"
},
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": [null
],
"paragraphs": [null
],
"ner": {"property1": null,
"property2": null
},
"entities": {"property1": null,
"property2": null
},
"classifications": [null
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"language": "string",
"summary": "string",
"positions": {"property1": null,
"property2": null
},
"relations": [null
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
},
"property2": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [null
],
"tokens": {"property1": null,
"property2": null
}
},
"split_metadata": {"property1": {"entities": null,
"tokens": null
},
"property2": {"entities": null,
"tokens": null
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [null
]
},
"split_vectors": {"property1": {"vectors": null
},
"property2": {"vectors": null
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [null
]
},
"split_question_answers": {"property1": {"question_answer": [ ]
},
"property2": {"question_answer": [ ]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": null,
"vector": [ ]
}
],
"property2": [{"node_value": null,
"vector": [ ]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": null,
"vector": [ ]
}
],
"property2": [{"relation_label": null,
"vector": [ ]
}
]
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
}
},
"generics": {"property1": {"value": "string",
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": [null
],
"paragraphs": [null
],
"ner": {"property1": null,
"property2": null
},
"entities": {"property1": null,
"property2": null
},
"classifications": [null
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"language": "string",
"summary": "string",
"positions": {"property1": null,
"property2": null
},
"relations": [null
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
},
"property2": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [null
],
"tokens": {"property1": null,
"property2": null
}
},
"split_metadata": {"property1": {"entities": null,
"tokens": null
},
"property2": {"entities": null,
"tokens": null
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [null
]
},
"split_vectors": {"property1": {"vectors": null
},
"property2": {"vectors": null
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [null
]
},
"split_question_answers": {"property1": {"question_answer": [ ]
},
"property2": {"question_answer": [ ]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": null,
"vector": [ ]
}
],
"property2": [{"node_value": null,
"vector": [ ]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": null,
"vector": [ ]
}
],
"property2": [{"relation_label": null,
"vector": [ ]
}
]
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
},
"property2": {"value": "string",
"extracted": {"text": {"text": "string",
"split_text": {"property1": "string",
"property2": "string"
},
"deleted_splits": ["string"
]
},
"metadata": {"metadata": {"links": [null
],
"paragraphs": [null
],
"ner": {"property1": null,
"property2": null
},
"entities": {"property1": null,
"property2": null
},
"classifications": [null
],
"last_index": "2019-08-24T14:15:22Z",
"last_understanding": "2019-08-24T14:15:22Z",
"last_extract": "2019-08-24T14:15:22Z",
"last_summary": "2019-08-24T14:15:22Z",
"last_processing_start": "2019-08-24T14:15:22Z",
"thumbnail": {"uri": null,
"size": null,
"content_type": null,
"filename": null,
"md5": null
},
"language": "string",
"summary": "string",
"positions": {"property1": null,
"property2": null
},
"relations": [null
],
"mime_type": "string"
},
"split_metadata": {"property1": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
},
"property2": {"links": [ ],
"paragraphs": [ ],
"ner": { },
"entities": { },
"classifications": [ ],
"last_index": null,
"last_understanding": null,
"last_extract": null,
"last_summary": null,
"last_processing_start": null,
"thumbnail": null,
"language": null,
"summary": null,
"positions": { },
"relations": null,
"mime_type": null
}
},
"deleted_splits": ["string"
]
},
"large_metadata": {"metadata": {"entities": [null
],
"tokens": {"property1": null,
"property2": null
}
},
"split_metadata": {"property1": {"entities": null,
"tokens": null
},
"property2": {"entities": null,
"tokens": null
}
},
"deleted_splits": ["string"
]
},
"vectors": {"vectors": {"vectors": [null
]
},
"split_vectors": {"property1": {"vectors": null
},
"property2": {"vectors": null
}
},
"deleted_splits": ["string"
]
},
"question_answers": {"question_answers": {"question_answer": [null
]
},
"split_question_answers": {"property1": {"question_answer": [ ]
},
"property2": {"question_answer": [ ]
}
},
"deleted_splits": ["string"
]
},
"relation_node_vectors": {"property1": [{"node_value": null,
"vector": [ ]
}
],
"property2": [{"node_value": null,
"vector": [ ]
}
]
},
"relation_edge_vectors": {"property1": [{"relation_label": null,
"vector": [ ]
}
],
"property2": [{"relation_label": null,
"vector": [ ]
}
]
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
}
},
"key_values": {"property1": {"value": {"data": {"property1": "string",
"property2": "string"
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
},
"property2": {"value": {"data": {"property1": "string",
"property2": "string"
}
},
"error": {"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
},
"status": "string",
"errors": [{"body": "string",
"code": 0,
"code_str": "string",
"created": "2019-08-24T14:15:22Z",
"severity": "string"
}
]
}
}
},
"security": {"access_groups": [ ]
}
}
],
"pagination": {"page": 0,
"size": 0,
"last": true
}
}

Interaction

Interact session

path Parameters

agent_id required	string (Agent Id)
session required	string (Session)
workflow_id required	string (Workflow Id)

Request Body schema: application/json
required

question required	string (Question)
	object (Headers) Default: {}
	object (Arguments) Default: {}
	Array of Chat History (objects) or Chat History (null) (Chat History) Client-managed chat history. When set (even to an empty list), overrides any server-side session history for agents that use previous Q&A context (rephrase, summarize, smart, etc.). Omit the field entirely to use server-side session history.
operation	integer (InteractionOperation) Default: 0 Enum: 0 1
streaming	boolean (Streaming) Default: false

Responses

Request samples

Payload

Content type

application/json

{"question": "string",
"headers": { },
"arguments": { },
"chat_history": [{"question": "string",
"answer": "string"
}
],
"operation": 0,
"streaming": false
}

Response samples

Content type

application/json

null

Workflow Agents

Workflow Agent configuration and interaction endpoints.

Add Generation

Add Generation Agent Configuration

path Parameters

agent_id

required

string (Agent Id)

Request Body schema: application/json
required

object (BaseModel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"id": "string"
}

Get Generation

Set Agent Configuration

path Parameters

agent_id

required

string (Agent Id)

Responses

Response samples

Content type

application/json

[null
]

Patch Generation

Set PreProcess Agent Configuration

path Parameters

agent_id required	string (Agent Id)
generation required	string (Generation)

Request Body schema: application/json
required

object (BaseModel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

null

Delete Generation

Delete Generation Agent Configuration

path Parameters

agent_id required	string (Agent Id)
generation required	string (Generation)

Responses

Response samples

Content type

application/json

null

Add Postprocess

Add PostProcess Agent Configuration

path Parameters

agent_id

required

string (Agent Id)

Request Body schema: application/json
required

object (BaseModel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"id": "string"
}

Get Postprocess

Set Agent Configuration

path Parameters

agent_id

required

string (Agent Id)

Responses

Response samples

Content type

application/json

[null
]

Patch Postprocess

Set PostProcess Agent Configuration

path Parameters

agent_id required	string (Agent Id)
postprocess required	string (Postprocess)

Request Body schema: application/json
required

object (BaseModel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

null

Delete Postprocess

Delete PreProcess Agent Configuration

path Parameters

agent_id required	string (Agent Id)
postprocess required	string (Postprocess)

Responses

Response samples

Content type

application/json

null

Add Preprocess

Add PreProcess Agent Configuration

path Parameters

agent_id

required

string (Agent Id)

Request Body schema: application/json
required

object (BaseModel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"id": "string"
}

Get Preprocess

Set Agent Configuration

path Parameters

agent_id

required

string (Agent Id)

Responses

Response samples

Content type

application/json

[null
]

Patch Preprocess

Set PreProcess Agent Configuration

path Parameters

agent_id required	string (Agent Id)
preprocess required	string (Preprocess)

Request Body schema: application/json
required

object (BaseModel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

null

Delete Preprocess

Delete PreProcess Agent Configuration

path Parameters

agent_id required	string (Agent Id)
preprocess required	string (Preprocess)

Responses

Response samples

Content type

application/json

null

Add Generation

Add Generation Workflows Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)

Request Body schema: application/json
required

object (BaseModel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"id": "string"
}

Get Generation

Get Generation Workflows Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)

Responses

Response samples

Content type

application/json

[null
]

Patch Generation

Set Generation Workflows Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)
generation required	string (Generation)

Request Body schema: application/json
required

object (BaseModel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

null

Delete Generation

Delete Generation Workflows Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)
generation required	string (Generation)

Responses

Response samples

Content type

application/json

null

Add Postprocess

Add PostProcess Workflows Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)

Request Body schema: application/json
required

object (BaseModel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"id": "string"
}

Get Postprocess

Get PostProcess Workflows Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)

Responses

Response samples

Content type

application/json

[null
]

Patch Postprocess

Set PostProcess Workflows Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)
postprocess required	string (Postprocess)

Request Body schema: application/json
required

object (BaseModel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

null

Delete Postprocess

Delete PostProcess Workflows Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)
postprocess required	string (Postprocess)

Responses

Response samples

Content type

application/json

null

Add Preprocess

Add PreProcess Workflows Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)

Request Body schema: application/json
required

object (BaseModel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"id": "string"
}

Get Preprocess

Set Workflow Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)

Responses

Response samples

Content type

application/json

[null
]

Patch Preprocess

Set PreProcess Workflows Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)
preprocess required	string (Preprocess)

Request Body schema: application/json
required

object (BaseModel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

null

Delete Preprocess

Delete PreProcess Workflows Configuration

path Parameters

agent_id required	string (Agent Id)
preprocess required	string (Preprocess)
workflow_id required	string (Workflow Id)

Responses

Response samples

Content type

application/json

null

Workflows

Workflow configuration endpoints.

Set Rules

Set Agent Configuration

path Parameters

agent_id

required

string (Agent Id)

Request Body schema: application/json
required

Array of Rule (object) or strings (Rules)

List of rules that the workflow should follow. Each rule can be a string or a Rule object with a prompt.

Array

Any of

	Prompt (string) or Prompt (null) (Prompt)
Any of string (Prompt)

Responses

Request samples

Payload

Content type

application/json

{"rules": [{"prompt": "string"
}
]
}

Response samples

Content type

application/json

null

Get Rules

Set Agent Configuration

path Parameters

agent_id

required

string (Agent Id)

Responses

Response samples

Content type

application/json

null

Set Workflow

Set Workflow Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)

Request Body schema: application/json
required

name required	string (Name)
description required	string (Description)
required	object (Parameters)
required	Array of strings (Required)
	Rules (object) or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"parameters": { },
"required": ["string"
],
"rules": {"rules": [{"prompt": "string"
}
]
}
}

Response samples

Content type

application/json

null

Delete Workflow

Delete Workflow Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)

Responses

Response samples

Content type

application/json

null

Set Rules

Set Workflow Rules Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)

Request Body schema: application/json
required

Array of Rule (object) or strings (Rules)

List of rules that the workflow should follow. Each rule can be a string or a Rule object with a prompt.

Array

Any of

	Prompt (string) or Prompt (null) (Prompt)
Any of string (Prompt)

Responses

Request samples

Payload

Content type

application/json

{"rules": [{"prompt": "string"
}
]
}

Response samples

Content type

application/json

null

Get Rules

Get Workflow Rules Configuration

path Parameters

agent_id required	string (Agent Id)
workflow_id required	string (Workflow Id)

Responses

Response samples

Content type

application/json

null

Add Workflow

Add Workflow Configuration

path Parameters

agent_id

required

string (Agent Id)

Request Body schema: application/json
required

id required	string (Id)
name required	string (Name)
	Description (string) or Description (null) (Description)
	Parameters (object) or Parameters (null) (Parameters)
	object (Rules)
required	Array of strings (Required)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"parameters": { },
"rules": {"rules": [{"prompt": "string"
}
]
},
"required": ["string"
]
}

Response samples

Content type

application/json

null

Get Workflows

Get Workflow Configuration

path Parameters

agent_id

required

string (Agent Id)

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"parameters": { },
"rules": {"rules": [{"prompt": "string"
}
]
},
"required": ["string"
]
}
]

Hyperforge (v1)

Audit

Delete Download Request

path Parameters

Responses

Response samples

Get Download Request Status

path Parameters

Responses

Response samples

List Download Requests

path Parameters

Responses

Response samples

Request Interactions Audit Download

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Drivers

Patch Driver

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Driver

path Parameters

Responses

Response samples

Add Driver

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Drivers

path Parameters

Responses

Response samples

Import Export

Request Export Retrieval Agent

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Import Retrieval Agent

path Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

MCP

Mcp Handler Delete

path Parameters

Responses

Response samples

Interaction Mcp Handler

path Parameters

Responses

Response samples

Interaction Mcp Handler

path Parameters

Responses

Response samples

Prompt Management

Patch Prompt

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Prompt

path Parameters

Responses

Response samples

Get Prompt

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required