Endpoints
search_content
Search text inside authorized native files; JSON body keeps terms out of URL logs. Requires files.list and each returned type read scope.
Request
Authentication is required by the published contract.
curl -X POST 'https://api.ursy.cloud/v1/content-search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_SERVICE_TOKEN'- Scopes
- Not specified by this operation
- Execution
- At the owning service
- Risk classification
- not declared
Parameters
This operation declares no parameters.
This operation is documented here. Use the owning service with the appropriate credentials and permissions to execute it.
Response schemas and request body
{
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"query": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"cursor": {
"type": "string",
"maxLength": 2048,
"x-ursy-maxBytes": 2048
},
"type": {
"type": "string",
"enum": [
"document",
"spreadsheet",
"presentation",
"note",
"publication"
]
}
},
"required": [
"query"
]
}
}
}
},
"responses": {
"200": {
"description": "Typed operation result; request_id correlates the request.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true,
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"file": {
"type": "object",
"additionalProperties": false,
"properties": {
"schema": {
"type": "string",
"enum": [
"ursy.cloud/file/v1"
]
},
"id": {
"type": "string",
"pattern": "^file_[1-9][0-9]{0,14}$"
},
"workspace_id": {
"type": "string",
"pattern": "^ws_[1-9][0-9]*$"
},
"parent_id": {
"oneOf": [
{
"type": "string",
"pattern": "^file_[1-9][0-9]{0,14}$"
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"maxLength": 190,
"x-ursy-maxBytes": 190
},
"type": {
"type": "string",
"enum": [
"folder",
"document",
"spreadsheet",
"presentation",
"note",
"publication",
"pdf",
"uploaded_file"
]
},
"current_version_id": {
"oneOf": [
{
"type": "string",
"pattern": "^ver_[1-9][0-9]*$"
},
{
"type": "null"
}
]
},
"etag": {
"type": "string",
"pattern": "^\"[a-f0-9]{64}\"$"
},
"state": {
"type": "string",
"enum": [
"active",
"trashed"
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"human_url": {
"type": "string"
}
},
"required": [
"schema",
"id",
"workspace_id",
"parent_id",
"name",
"type",
"current_version_id",
"etag",
"state",
"created_at",
"updated_at",
"human_url"
]
},
"version_id": {
"oneOf": [
{
"type": "string",
"pattern": "^ver_[1-9][0-9]*$"
},
{
"type": "null"
}
]
},
"matches": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"text": {
"type": "string",
"maxLength": 242,
"x-ursy-maxBytes": 242
},
"anchor": {
"type": "object",
"additionalProperties": false,
"properties": {
"block_id": {
"type": "string",
"maxLength": 64,
"x-ursy-maxBytes": 64
},
"slide_id": {
"type": "string",
"maxLength": 64,
"x-ursy-maxBytes": 64
},
"page_id": {
"type": "string",
"maxLength": 64,
"x-ursy-maxBytes": 64
},
"element_id": {
"type": "string",
"maxLength": 64,
"x-ursy-maxBytes": 64
},
"field": {
"type": "string",
"enum": [
"title",
"body",
"notes",
"content"
]
},
"sheet_index": {
"type": "integer",
"minimum": 0
},
"row_index": {
"type": "integer",
"minimum": 0
},
"column_index": {
"type": "integer",
"minimum": 0
},
"range": {
"type": "string",
"pattern": "^[A-Z]+[1-9][0-9]*$"
}
}
}
},
"required": [
"text",
"anchor"
]
},
"minItems": 1,
"maxItems": 3
}
},
"required": [
"file",
"version_id",
"matches"
]
},
"minItems": 0,
"maxItems": 50
},
"content_is_untrusted": {
"const": true
},
"match_mode": {
"type": "string",
"enum": [
"case_insensitive_literal_substring"
]
},
"consistency": {
"type": "string"
},
"next_cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"has_more": {
"type": "boolean"
},
"request_id": {
"type": "string"
},
"replayed": {
"type": "boolean"
}
},
"required": [
"results",
"content_is_untrusted",
"match_mode",
"consistency",
"next_cursor",
"has_more"
]
}
}
}
},
"default": {
"description": "Stable error envelope. 401 invalid/expired/revoked grant; 403 missing scope; 404 unavailable resource; 409 plan/idempotency conflict; 412 stale ETag; 413 size/quota; 429 rate limit.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}