Search
Search gpt
Collects the AI answer that the matching search call started in the background, using the key that search returned, and holds the request open for up to two minutes while polling for it before reporting a timed-out status.
The answer is composed from the knowledge the search found, and placeholders in the workspace's custom instructions are resolved before it is returned.
GET
/api/{tenant:minlength(2)}/v{version:apiVersion}/search/search_gpt
- Authorisation
- Minimum role: USER
Request arguments
| Name |
Type |
Source |
| key | String | Query |
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_search_response_gpt_wrapper
- Wrapper
- DTO_response_wrap
- Other statuses
- 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_search_response_gpt_wrapper
DTO_search_gpt_debug_response
| Name | Type | ReadOnly | Description |
|---|
| took_explained | DTO_took[] | | Took explained |
| error_message | String | | Error message |
| tokens_count_input | Int32 | | Tokens count input |
| tokens_count_completion | Int32 | | Tokens count completion |
| debug_messages | String[] | | Debug messages |
DTO_took
| Name | Type | ReadOnly | Description |
|---|
| item | String | | Item |
| took_ms | Int64 | | Took ms |
ENUM search_status
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | INVALID | Invalid |
| 2 | NOT_APPLICABLE | Not applicable |
| 3 | IN_PROGRESS | In progress |
| 4 | COMPLETED | Completed |
| 5 | OTHER_SEARCH_IN_PROGRESS | Another search in progress |
| 6 | NO_DATA | No data |
| 7 | NO_ACTIVE_SEARCH | No active search |
| 8 | TIMED_OUT | Timed out |
Generated Aug 4, 2026 18:37
