Browse the API reference

Get Document Section

get/v1/graphs/{graph_id}/search/{document_id}

Part of Search.

Authentication

Authenticate in any one of these ways — not all of them:

API key in the X-API-Key header.
Bearer token in the Authorization header.

Path parameters

Name	Type	Description
`graph_id`required	string	Graph Id
`document_id`required	string	Document Id

Example request

curl

curl -X GET "https://api.robosystems.ai/v1/graphs/{graph_id}/search/{document_id}" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY"

Responses

200 Successful Response

Field	Type	Description
`document_id`required	string
`graph_id`required	string
`source_type`required	string
`parent_document_id`optional	string
`part`optional	integer	Default: `1`
`part_count`optional	integer	Default: `1`
`next_document_id`optional	string
`entity_ticker`optional	string
`entity_name`optional	string
`entity_cik`optional	string
`section_label`optional	string
`section_id`optional	string
`element_qname`optional	string
`filing_date`optional	string
`fiscal_year`optional	integer
`fiscal_period`optional	string
`form_type`optional	string
`accession_number`optional	string
`xbrl_elements`optional	string[]
`content`required	string
`content_url`optional	string
`content_length`optional	integer	Default: `0`
`document_title`optional	string
`tags`optional	string[]
`folder`optional	string

Status	Meaning
400	Invalid request
401	Authentication required
403	Access denied
404	Resource not found
422	Validation Error
429	Rate limit exceeded
500	Internal server error
503	Text search not available