Search

Operations tagged Search in the public API.

/v1/search

Semantic search

Semantic search. Authenticate with a bearer API key that includes the required scope. Resources that belong to another account return 404 NOT_FOUND. Mutations accept Idempotency-Key and emit a webhook event when they succeed.

Required scopesearch:read

Name	Type	Required	Description
`query`	string	Required	The query field.
`limit`	string	Optional	The limit field.
`collection_id`	string	Optional	The collection id field.
`include_content`	string	Optional	The include content field.

Status	Description
`200`	Search hits, each `{chunk_id, dataset_id, chunk_index, score, score_kind}` plus `chunk_text` when `include_content` is true. `score_kind` is `reranker` (calibrated 0..1 probability), `cosine` (absolute similarity) or `fused` (rank fusion, no absolute meaning). Vector-store point ids and tenant payload fields are never returned.
`401`	Unauthenticated
`403`	The API key is missing a required scope.
`422`	Validation error
`429`	Rate limited. Honour the Retry-After header before retrying.

curl

curl -X POST https://api.agentency.com/v1/search \
  -H "Authorization: Bearer <YOUR_KEY>" \
  -H "Content-Type: application/json"
  -d '{
  "query": "query",
  "limit": "limit",
  "collection_id": 1,
  "include_content": "include_content"
}'

/v1/search/similar/{datasetId}

Similar search

Similar search. Authenticate with a bearer API key that includes the required scope. Resources that belong to another account return 404 NOT_FOUND. Mutations accept Idempotency-Key and emit a webhook event when they succeed.

Required scopesearch:read

Name	In	Type	Required	Description
`datasetId`	path	integer	Required	Knowledge dataset id owned by the API key account.
`query`	query	string	Optional	Text to compare against. Defaults to the dataset name.
`limit`	query	string	Optional	Maximum hits to return (1-50). Defaults to 10.

Status	Description
`200`	Hits from the given dataset, each `{chunk_id, dataset_id, chunk_index, score, score_kind}`; `score_kind` is `reranker`, `cosine` or `fused`. Vector-store point ids and tenant payload fields are never returned.
`401`	Unauthenticated
`403`	The API key is missing a required scope.
`404`	The resource does not exist on this account.
`422`	Validation error
`429`	Rate limited. Honour the Retry-After header before retrying.

curl

curl -X GET https://api.agentency.com/v1/search/similar/{datasetId} \
  -H "Authorization: Bearer <YOUR_KEY>" \
  -H "Content-Type: application/json"

Operations tagged Search in the public API.

/v1/search

Semantic search

Required scopesearch:read

Name	Type	Required	Description
`query`	string	Required	The query field.
`limit`	string	Optional	The limit field.
`collection_id`	string	Optional	The collection id field.
`include_content`	string	Optional	The include content field.

Status	Description
`200`	Search hits, each `{chunk_id, dataset_id, chunk_index, score, score_kind}` plus `chunk_text` when `include_content` is true. `score_kind` is `reranker` (calibrated 0..1 probability), `cosine` (absolute similarity) or `fused` (rank fusion, no absolute meaning). Vector-store point ids and tenant payload fields are never returned.
`401`	Unauthenticated
`403`	The API key is missing a required scope.
`422`	Validation error
`429`	Rate limited. Honour the Retry-After header before retrying.

curl

curl -X POST https://api.agentency.com/v1/search \
  -H "Authorization: Bearer <YOUR_KEY>" \
  -H "Content-Type: application/json"
  -d '{
  "query": "query",
  "limit": "limit",
  "collection_id": 1,
  "include_content": "include_content"
}'

/v1/search/similar/{datasetId}

Similar search

Required scopesearch:read

Name	In	Type	Required	Description
`datasetId`	path	integer	Required	Knowledge dataset id owned by the API key account.
`query`	query	string	Optional	Text to compare against. Defaults to the dataset name.
`limit`	query	string	Optional	Maximum hits to return (1-50). Defaults to 10.

Status	Description
`200`	Hits from the given dataset, each `{chunk_id, dataset_id, chunk_index, score, score_kind}`; `score_kind` is `reranker`, `cosine` or `fused`. Vector-store point ids and tenant payload fields are never returned.
`401`	Unauthenticated
`403`	The API key is missing a required scope.
`404`	The resource does not exist on this account.
`422`	Validation error
`429`	Rate limited. Honour the Retry-After header before retrying.

curl

curl -X GET https://api.agentency.com/v1/search/similar/{datasetId} \
  -H "Authorization: Bearer <YOUR_KEY>" \
  -H "Content-Type: application/json"