> ## Documentation Index > Fetch the complete documentation index at: https://docs.osint.ly/llms.txt > Use this file to discover all available pages before exploring further. # Get BYOK provider results > Return BYOK provider execution status, result counters, errors, and stored provider payloads for a search. ## OpenAPI ````yaml /api-reference/openapi.json get /search/{id}/byok openapi: 3.1.0 info: title: Osintly API version: 1.0.0 description: OpenAPI specification for the Osintly API service. contact: name: Osintly url: https://docs.osint.ly/api-reference/quick-start servers: - url: https://api.osint.ly description: Production security: [] tags: - name: System description: Health and service checks - name: Auth description: Authorization validation - name: Search description: Create, monitor and retrieve search results - name: Usage description: Rate limit and usage information - name: Radar description: Breach intelligence endpoints (free with API key) - name: Webhooks description: Webhook callback payloads configured from search creation paths: /search/{id}/byok: get: tags: - Search summary: Get BYOK provider results description: >- Return BYOK provider execution status, result counters, errors, and stored provider payloads for a search. operationId: getSearchByok parameters: - $ref: '#/components/parameters/SearchId' - name: provider in: query required: false description: >- Filter the response to a single BYOK provider. When omitted, all available BYOK providers for the search are returned. schema: type: string enum: - osint_industries - sherlockeye responses: '200': description: BYOK provider status, metadata, and stored payloads content: application/json: schema: $ref: '#/components/schemas/SearchByokResponse' examples: byok: value: data: mode: default providers: osint_industries: status: success result_count: 12 started_at: '2026-05-27T12:00:03.000Z' finished_at: '2026-05-27T12:00:18.000Z' mapping_version: 1 error: null raw: provider: osint_industries search_id: d290f1ee-6c54-4b01-90e6-d701748f0851 result_count: 12 status: success mapping_version: 1 started_at: '2026-05-27T12:00:03.000Z' finished_at: '2026-05-27T12:00:18.000Z' raw: [] meta: environment: production timestamp: '2026-05-27T12:00:20.000Z' sherlockeye_only: summary: Filter to Sherlockeye only value: data: mode: default providers: sherlockeye: status: success result_count: 4 started_at: '2026-05-27T12:00:03.000Z' finished_at: '2026-05-27T12:00:14.000Z' mapping_version: 1 error: null raw: provider: sherlockeye search_id: d290f1ee-6c54-4b01-90e6-d701748f0851 result_count: 4 status: success mapping_version: 1 started_at: '2026-05-27T12:00:03.000Z' finished_at: '2026-05-27T12:00:14.000Z' raw: [] meta: environment: production timestamp: '2026-05-27T12:00:20.000Z' '400': $ref: '#/components/responses/SearchApiError' '401': $ref: '#/components/responses/UnauthorizedError' '500': $ref: '#/components/responses/SearchApiError' security: - bearerAuth: [] components: parameters: SearchId: name: id in: path required: true schema: type: string format: uuid description: Search UUID schemas: SearchByokResponse: type: object required: - data - meta properties: data: type: object required: - mode - providers properties: mode: type: - string - 'null' enum: - default - only - null providers: type: object additionalProperties: false properties: osint_industries: $ref: '#/components/schemas/SearchByokProviderResponse' sherlockeye: $ref: '#/components/schemas/SearchByokProviderResponse' meta: $ref: '#/components/schemas/ResponseMeta' SearchByokProviderResponse: type: object required: - status - result_count - started_at - finished_at - mapping_version - error - raw properties: status: type: string result_count: type: integer started_at: type: - string - 'null' format: date-time finished_at: type: - string - 'null' format: date-time mapping_version: type: - integer - 'null' error: type: - string - 'null' raw: oneOf: - type: 'null' - type: object additionalProperties: true - type: array items: {} ResponseMeta: type: object required: - timestamp properties: environment: type: string timestamp: type: string format: date-time SearchApiErrorResponse: type: object required: - error - meta properties: error: type: object required: - code - message properties: code: type: string message: type: string details: oneOf: - type: string - type: array items: $ref: '#/components/schemas/ValidationIssue' meta: $ref: '#/components/schemas/ResponseMeta' BasicErrorResponse: type: object required: - success - message properties: success: type: boolean enum: - false message: type: string additionalProperties: true ValidationIssue: type: object required: - path - message properties: path: type: string message: type: string responses: SearchApiError: description: Search API error content: application/json: schema: $ref: '#/components/schemas/SearchApiErrorResponse' examples: validation_error: value: error: code: VALIDATION_ERROR message: Invalid request parameters details: - path: query.value message: query.value must be a valid email meta: timestamp: '2026-05-27T12:00:00.000Z' rate_limited: value: error: code: RATE_LIMIT_EXCEEDED message: Rate limit exceeded details: API usage limits have been reached meta: environment: production timestamp: '2026-05-27T12:00:00.000Z' run_not_found: value: error: code: RUN_NOT_FOUND message: Search run not available details: No active run is associated with this search meta: environment: production timestamp: '2026-05-27T12:00:00.000Z' leak_source_not_found: value: error: code: LEAK_SOURCE_NOT_FOUND message: Leak source not found details: No leaked results source matches 'unknown-source' meta: environment: production timestamp: '2026-05-27T12:00:00.000Z' UnauthorizedError: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/BasicErrorResponse' examples: unauthorized: value: success: false message: Unauthorized securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key ````