### Global Explain API Request Example Source: https://context7_llms Illustrates how to get an estimated count of matching documents across all sources for a query 'q' using the /explain endpoint. ```http GET /v1/explain?q={your_query} HTTP/1.1 Host: api.usersbox.ru Authorization: ``` -------------------------------- ### Explain Search - GET /{database}/{collection}/explain or GET /explain Source: https://context7_llms Provides details about the search query execution plan. This endpoint is free to use with a rate limit. ```APIDOC ## GET /{database}/{collection}/explain or GET /explain ### Description Provides details about the search query execution plan. This endpoint is free to use with a rate limit. ### Method GET ### Endpoint `/{database}/{collection}/explain` or `/explain` ### Parameters #### Query Parameters - **q** (string) - Required - Search query. ### Request Example No request body for GET requests. ### Response #### Success Response (200) - **status** (string) - Indicates success or error. - **data** (object) - Contains explanation details. - **count** (long) - The number of documents found. #### Response Example ```json { "status": "success", "data": { "count": 1500 } } ``` ``` -------------------------------- ### GetMe API Request Example Source: https://context7_llms Demonstrates how to make a GET request to the /getMe endpoint to retrieve information about the authenticated application. Requires the API token to be included in the Authorization header. ```http GET /v1/getMe HTTP/1.1 Host: api.usersbox.ru Authorization: ``` -------------------------------- ### Sources API Response Example Source: https://context7_llms Example JSON response for the /sources endpoint, listing available data collections with their database, collection name, size, item count, and title. ```json { "status": "success", "data": { "count": 981, "items": [ { "database": "cdek", "collection": "full", "size": 31919315138, "count": 205663278, "title": "🚚 CDEK [2022]" }, { "database": "100realt", "collection": "parsing_2021", "size": 5394439345, "count": 4916799, "title": "🏠 ΠŸΠ°Ρ€ΡΠΈΠ½Π³ Β«100realt.ruΒ» [2021]" } ] } } ``` -------------------------------- ### Global Explain API Response Example Source: https://context7_llms Example JSON response for the global /explain endpoint, showing the total estimated count and a breakdown by source where matches were found. ```json { "status": "success", "data": { "count": 15, "items": [ { "source": { "database": "500px_com", "collection": "users" }, "hits": { "count": 1 } }, { "source": { "database": "appen_com", "collection": "users" }, "hits": { "count": 1 } } ] } } ``` -------------------------------- ### Global Search API Request Example Source: https://context7_llms Shows an example of a global search query across all available data sources using the /search endpoint. This method returns up to 25 documents per source. ```http GET /v1/search?q={your_query} HTTP/1.1 Host: api.usersbox.ru Authorization: ``` -------------------------------- ### GET /sources Source: https://context7_llms Lists all available data sources, returning a list of databases and collections. ```APIDOC ## GET /sources ### Description Lists all available data sources, returning a list of databases and collections. ### Method GET ### Endpoint /v1/sources ### Parameters ### Request Example ``` GET /v1/sources HTTP/1.1 Host: api.usersbox.ru Authorization: ``` ### Response #### Success Response (200) - **count** (integer) - Total number of available sources - **items** (array) - List of data sources - **database** (string) - Name of the database - **collection** (string) - Name of the collection - **size** (integer) - Size of the collection in bytes - **count** (integer) - Number of documents in the collection - **title** (string) - Display title of the collection #### Response Example ```json { "status": "success", "data": { "count": 981, "items": [ { "database": "cdek", "collection": "full", "size": 31919315138, "count": 205663278, "title": "🚚 CDEK [2022]" }, { "database": "100realt", "collection": "parsing_2021", "size": 5394439345, "count": 4916799, "title": "🏠 ΠŸΠ°Ρ€ΡΠΈΠ½Π³ Β«100realt.ruΒ» [2021]" } ] } } ``` ``` -------------------------------- ### GetMe API Response Example Source: https://context7_llms A sample JSON response for the /getMe endpoint, showing application details such as ID, title, token, creation date, balance, and owner information. ```json { "status": "success", "data": { "_id": "...", "title": "Morales Publisher", "token": "...", "created_at": "Jan 10, 2024, 12:05:00 PM", "is_active": true, "balance": 150.5, "owner": { "user_id": "...", "bot_id": "..." } } } ``` -------------------------------- ### Collection Sample - GET /{database}/{collection}/sample Source: https://context7_llms Retrieves the first 15 documents of a collection for preliminary study of field structure. This endpoint is free. ```APIDOC ## GET /{database}/{collection}/sample ### Description Retrieves the first 15 documents of a collection for preliminary study of field structure. This endpoint is free. ### Method GET ### Endpoint `/{database}/{collection}/sample` ### Parameters None. ### Request Example No request body for GET requests. ### Response #### Success Response (200) - **status** (string) - Indicates success or error. - **data** (object) - Contains sample documents. - **count** (integer) - The number of documents returned (up to 15). - **items** (array) - Array of sample document objects. #### Response Example ```json { "status": "success", "data": { "count": 15, "items": [ { "_id": 492033988, "user_id": 225889705, "yandex_uid": "1219928845", "first_name": "mrozovmail.ru", "phone": "+79088468484", "amount": 427, "currency": "RUB", "app": "eda_iphone", "user_agent": "ios(5.5.0)", "payment": { "service": "Apple Pay Yandex Eda" }, "address": { "city": "Москва, посСлСниС ЩаповскоС", "street": "ΠΊΠΎΡ‚Ρ‚Π΅Π΄ΠΆΠ½Ρ‹ΠΉ посёлок ЕвропСйская Π”ΠΎΠ»ΠΈΠ½Π°", "house": "1", "office": "148", "reliable": 1, "latitude": "55.430539", "longitude": "37.389167" } } // ... ] } } ``` ``` -------------------------------- ### Search Collection API Response Example (No Results) Source: https://context7_llms Example JSON response when a search within a collection yields no results. The 'count' will be 0 and 'items' will be an empty array. ```json { "status": "success", "data": { "count": 0, "items": [] } } ``` -------------------------------- ### GET /explain Source: https://context7_llms Estimates the number of matching documents across all data sources for a given query. ```APIDOC ## GET /explain ### Description Estimates the number of matching documents across all data sources for a given query. ### Method GET ### Endpoint /v1/explain ### Parameters #### Query Parameters - **q** (string) - Required - Search query. ### Request Example ``` GET /v1/explain?q=global_estimation_query HTTP/1.1 Host: api.usersbox.ru Authorization: ``` ### Response #### Success Response (200) - **count** (integer) - Total estimated count across all sources. - **items** (array) - List of estimations per source. - **source** (object) - **database** (string) - Name of the database. - **collection** (string) - Name of the collection. - **hits** (object) - **count** (integer) - Estimated count for this source. #### Response Example ```json { "status": "success", "data": { "count": 15, "items": [ { "source": { "database": "500px_com", "collection": "users" }, "hits": { "count": 1 } }, { "source": { "database": "appen_com", "collection": "users" }, "hits": { "count": 1 } } ] } } ``` #### Response Example (no results) ```json { "status": "success", "data": { "count": 0, "items": [] } } ``` ``` -------------------------------- ### GET /search Source: https://context7_llms Performs a global search across all available data sources. ```APIDOC ## GET /search ### Description Performs a global search across all available data sources. Returns up to 25 documents per database. ### Method GET ### Endpoint /v1/search ### Parameters #### Query Parameters - **q** (string) - Required - Search query. ### Request Example ``` GET /v1/search?q=global_search_term HTTP/1.1 Host: api.usersbox.ru Authorization: ``` ### Response #### Success Response (200) - **items** (array) - List of search results from different sources. - **source** (object) - **database** (string) - Name of the database. - **collection** (string) - Name of the collection. - **hits** (object) - **hitsCount** (integer) - Total count of hits in this source. - **count** (integer) - Number of items returned for this source. - **items** (array) - Array of found documents (structure depends on the source). #### Response Example (abbreviated structure) ```json { "status": "success", "items": [ { "source": { "database": "2berega_ru", "collection": "clients" }, "hits": { "hitsCount": 1, "count": 1, "items": [ /* ... */ ] } }, { "source": { "database": "yandex", "collection": "eda" }, "hits": { "hitsCount": 1, "count": 1, "items": [ /* ... */ ] } } ] } ``` ``` -------------------------------- ### Explain Collection API Request Example Source: https://context7_llms Demonstrates how to estimate the number of matching documents within a specific collection for a given query 'q' using the /{database}/{collection}/explain endpoint. ```http GET /v1/{database}/{collection}/explain?q={your_query} HTTP/1.1 Host: api.usersbox.ru Authorization: ``` -------------------------------- ### Global Search - GET /search Source: https://context7_llms Performs a search across all available datasets. This is a fixed-price request. ```APIDOC ## GET /search ### Description Performs a search across all available datasets. This is a fixed-price request. ### Method GET ### Endpoint `/search` ### Parameters #### Query Parameters - **q** (string) - Required - Search query. - **count** (integer) - Optional - Number of documents to return (25-500). ### Request Example No request body for GET requests. ### Response #### Success Response (200) - **status** (string) - Indicates success or error. - **data** (object) - Contains search results. - **count** (integer) - Number of documents returned. - **items** (array) - Array of document objects. - **hitsCount** (integer) - Approximate total number of matching documents. #### Response Example ```json { "status": "success", "data": { "count": 15, "items": [ { "_id": 492033988, "user_id": 225889705, "yandex_uid": "1219928845", "first_name": "mrozovmail.ru", "phone": "+79088468484", "amount": 427, "currency": "RUB", "app": "eda_iphone", "user_agent": "ios(5.5.0)", "payment": { "service": "Apple Pay Yandex Eda" }, "address": { "city": "Москва, посСлСниС ЩаповскоС", "street": "ΠΊΠΎΡ‚Ρ‚Π΅Π΄ΠΆΠ½Ρ‹ΠΉ посёлок ЕвропСйская Π”ΠΎΠ»ΠΈΠ½Π°", "house": "1", "office": "148", "reliable": 1, "latitude": "55.430539", "longitude": "37.389167" } } ], "hitsCount": 1000 } } ``` ``` -------------------------------- ### Get Sample Documents from Collection Source: https://context7_llms Retrieves the first 15 documents from a specified database and collection for preliminary field structure examination. This endpoint is free to use. ```json { "status": "success", "data": { "count": 15, "items": [ { "_id": 492033988, "user_id": 225889705, "yandex_uid": "1219928845", "first_name": "mrozovmail.ru", "phone": "+79088468484", "amount": 427, "currency": "RUB", "app": "eda_iphone", "user_agent": "ios(5.5.0)", "payment": { "service": "Apple Pay Yandex Eda" }, "address": { "city": "Москва, посСлСниС ЩаповскоС", "street": "ΠΊΠΎΡ‚Ρ‚Π΅Π΄ΠΆΠ½Ρ‹ΠΉ посёлок ЕвропСйская Π”ΠΎΠ»ΠΈΠ½Π°", "house": "1", "office": "148", "reliable": 1, "latitude": "55.430539", "longitude": "37.389167" } } // ... ] } } ``` -------------------------------- ### GET /getMe Source: https://context7_llms Retrieves information about the current application, used for authorization verification and basic application details. ```APIDOC ## GET /getMe ### Description Retrieves information about the current application, used for authorization verification and basic application details. ### Method GET ### Endpoint /v1/getMe ### Parameters ### Request Example ``` GET /v1/getMe HTTP/1.1 Host: api.usersbox.ru Authorization: ``` ### Response #### Success Response (200) - **_id** (string) - Application ID - **title** (string) - Application title - **token** (string) - Application token - **created_at** (string) - Timestamp of application creation - **is_active** (boolean) - Indicates if the application is active - **balance** (number) - Application balance - **owner** (object) - Information about the application owner - **user_id** (string) - **bot_id** (string) #### Response Example ```json { "status": "success", "data": { "_id": "...", "title": "Morales Publisher", "token": "...", "created_at": "Jan 10, 2024, 12:05:00 PM", "is_active": true, "balance": 150.5, "owner": { "user_id": "...", "bot_id": "..." } } } ``` ``` -------------------------------- ### Explain Collection API Response Example Source: https://context7_llms Sample JSON response for the /{database}/{collection}/explain endpoint, indicating the estimated count of documents matching the query in the specified collection. ```json { "status": "success", "data": { "count": 11458 } } ``` -------------------------------- ### GET /{database}/{collection}/search Source: https://context7_llms Searches within a specific collection for given query parameters. ```APIDOC ## GET /{database}/{collection}/search ### Description Searches within a specific collection for given query parameters. Returns the first found documents in the specified collection. ### Method GET ### Endpoint /v1/{database}/{collection}/search ### Parameters #### Query Parameters - **q** (string) - Required - Search query (phone, email, username, IP, etc.). - **count** (integer) - Optional - Number of elements to return (25 to 500). ### Request Example ``` GET /v1/my_database/my_collection/search?q=example_query&count=100 HTTP/1.1 Host: api.usersbox.ru Authorization: ``` ### Response #### Success Response (200) - **count** (integer) - Number of documents found. - **items** (array) - Array of found documents. - **_id** (any) - Unique identifier of the document. - **full_name** (string) - Full name of the person (if applicable). - **birth_date** (string) - Date of birth (if applicable). - **phone** (string) - Phone number (if applicable). - **_score** (number) - Relevance score of the document. #### Response Example (documents found) ```json { "status": "success", "data": { "count": 4, "items": [ { "_id": 3212868, "full_name": "Василий Иванов ΠœΠ°ΠΊΡΠΈΠΌΠΎΠ²ΠΈΡ‡", "birth_date": "30.08.1945", "phone": "+79177840591", "_score": 7.08725643157959 }, { "_id": 4349339, "full_name": "Василий Иванов ΠœΠ°ΠΊΡΠΈΠΌΠΎΠ²ΠΈΡ‡", "birth_date": "20.05.1968", "phone": "+79065499712", "_score": 7.08725643157959 } ] } } ``` #### Response Example (no results) ```json { "status": "success", "data": { "count": 0, "items": [] } } ``` ``` -------------------------------- ### Global Search API Response Example Source: https://context7_llms A simplified structure of a JSON response for the global /search endpoint, showing results grouped by source, including the collection and the hits found. ```json { "status": "success", "items": [ { "source": { "database": "2berega_ru", "collection": "clients" }, "hits": { "hitsCount": 1, "count": 1, "items": [ /* ... */ ] } }, { "source": { "database": "yandex", "collection": "eda" }, "hits": { "hitsCount": 1, "count": 1, "items": [ /* ... */ ] } } ] } ``` -------------------------------- ### GET /{database}/{collection}/explain Source: https://context7_llms Estimates the number of matching documents within a specific collection for a given query. ```APIDOC ## GET /{database}/{collection}/explain ### Description Estimates the number of matching documents within a specific collection for a given query. ### Method GET ### Endpoint /v1/{database}/{collection}/explain ### Parameters #### Query Parameters - **q** (string) - Required - Search query. ### Request Example ``` GET /v1/my_database/my_collection/explain?q=estimation_query HTTP/1.1 Host: api.usersbox.ru Authorization: ``` ### Response #### Success Response (200) - **count** (integer) - Estimated number of matching documents. #### Response Example ```json { "status": "success", "data": { "count": 11458 } } ``` ``` -------------------------------- ### Russian Localization - GET /lang/ru Source: https://context7_llms Provides Russian translations for field names. This endpoint is free. ```APIDOC ## GET /lang/ru ### Description Provides Russian translations for field names. This endpoint is free. ### Method GET ### Endpoint `/lang/ru` ### Parameters None. ### Request Example No request body for GET requests. ### Response #### Success Response (200) - **status** (string) - Indicates success or error. - **data** (object) - Contains field name translations. #### Response Example ```json { "status": "success", "data": { "id": "ID", "uid": "User ID", "first_name": "Имя", "last_name": "Ѐамилия", "sex": "Пол", "age": "Возраст" // ... } } ``` ``` -------------------------------- ### Search Collection API Response Example (Found) Source: https://context7_llms A sample JSON response for a successful search within a collection, returning the count of found items and the items themselves, including their scores. ```json { "status": "success", "data": { "count": 4, "items": [ { "_id": 3212868, "full_name": "Василий Иванов ΠœΠ°ΠΊΡΠΈΠΌΠΎΠ²ΠΈΡ‡", "birth_date": "30.08.1945", "phone": "+79177840591", "_score": 7.08725643157959 }, { "_id": 4349339, "full_name": "Василий Иванов ΠœΠ°ΠΊΡΠΈΠΌΠΎΠ²ΠΈΡ‡", "birth_date": "20.05.1968", "phone": "+79065499712", "_score": 7.08725643157959 } ] } } ``` -------------------------------- ### GET /{database}/{collection}/nearbySearch Source: https://context7_llms Performs a geographical radius search within a specified collection. ```APIDOC ## GET /{database}/{collection}/nearbySearch ### Description Performs a geographical radius search within a specified collection. Supported collections include examples like `delivery_club/part1`, `yandex/eda`, `avito/ads`. ### Method GET ### Endpoint /v1/{database}/{collection}/nearbySearch ### Parameters #### Query Parameters - **lat** (double) - Required - Latitude. - **lon** (double) - Required - Longitude. - **radius** (integer) - Required - Search radius in meters. - **count** (integer) - Optional - Number of elements to return (25 to 500). ### Request Example ``` GET /v1/yandex/eda/nearbySearch?lat=55.7558&lon=37.6173&radius=1000&count=50 HTTP/1.1 Host: api.usersbox.ru Authorization: ``` ### Response #### Success Response (200) - **hitsCount** (integer) - Total number of documents found within the radius. - **tooManyDocs** (boolean) - Indicates if the total number of documents exceeds limits. - **count** (integer) - Number of items returned in this response. - **items** (array) - Array of found documents. - **user_id** (integer) - User ID. - **first_name** (string) - First name. - **phone** (string) - Phone number. - **address** (object) - Address details. - **city** (string) - **street** (string) - **house** (string) - **floor** (string) #### Response Example ```json { "status": "success", "data": { "hitsCount": 1000, "tooManyDocs": true, "count": 25, "items": [ { "user_id": 6538242, "first_name": "Бтанислав", "phone": "+79112778424", "address": { "city": "Π‘Π°Π½ΠΊΡ‚-ΠŸΠ΅Ρ‚Π΅Ρ€Π±ΡƒΡ€Π³", "street": "Гороховая ΡƒΠ»ΠΈΡ†Π°", "house": "4", "floor": "4" } } ] } } ``` ``` -------------------------------- ### Search Collection API Request Example Source: https://context7_llms Illustrates how to perform a search within a specific database collection using the /search method. This method accepts a query 'q' and an optional 'count' parameter to limit results. ```http GET /v1/{database}/{collection}/search?q={your_query}&count=100 HTTP/1.1 Host: api.usersbox.ru Authorization: ``` -------------------------------- ### Collection Schema - GET /{database}/{collection}/schema Source: https://context7_llms Retrieves the JSON Schema (draft-07) for a collection, based on the first ~5000 records. This endpoint is free. ```APIDOC ## GET /{database}/{collection}/schema ### Description Retrieves the JSON Schema (draft-07) for a collection, based on the first ~5000 records. This endpoint is free. ### Method GET ### Endpoint `/{database}/{collection}/schema` ### Parameters None. ### Request Example No request body for GET requests. ### Response #### Success Response (200) - **status** (string) - Indicates success or error. - **data** (object) - Contains the JSON Schema. - **$schema** (string) - Schema version. - **type** (string) - Schema type. - **properties** (object) - Defines the properties of the schema. #### Response Example ```json { "status": "success", "data": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "_id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "sex": { "type": "integer" } // ... } } } ``` ``` -------------------------------- ### Nearby Search API Response Example Source: https://context7_llms A sample JSON response for the nearbySearch endpoint, indicating the total number of documents within the radius, whether there were too many, and the count and details of the returned items. ```json { "status": "success", "data": { "hitsCount": 1000, "tooManyDocs": true, "count": 25, "items": [ { "user_id": 6538242, "first_name": "Бтанислав", "phone": "+79112778424", "address": { "city": "Π‘Π°Π½ΠΊΡ‚-ΠŸΠ΅Ρ‚Π΅Ρ€Π±ΡƒΡ€Π³", "street": "Гороховая ΡƒΠ»ΠΈΡ†Π°", "house": "4", "floor": "4" } } ] } } ``` -------------------------------- ### Nearby Search - GET /{database}/{collection}/nearbySearch Source: https://context7_llms Finds documents near a specified geographic location. Pricing is similar to the general collection search. ```APIDOC ## GET /{database}/{collection}/nearbySearch ### Description Finds documents near a specified geographic location. Pricing is similar to the general collection search. ### Method GET ### Endpoint `/{database}/{collection}/nearbySearch` ### Parameters #### Query Parameters - **latitude** (float) - Required - Latitude of the search center. - **longitude** (float) - Required - Longitude of the search center. - **radius** (integer) - Required - Search radius in meters. - **count** (integer) - Optional - Number of documents to return (25-500). ### Request Example No request body for GET requests. ### Response #### Success Response (200) - **status** (string) - Indicates success or error. - **data** (object) - Contains search results. - **count** (integer) - Number of documents returned. - **items** (array) - Array of document objects. - **hitsCount** (integer) - Approximate total number of matching documents. #### Response Example ```json { "status": "success", "data": { "count": 5, "items": [ { "_id": "some_id", "name": "Example Location", "latitude": 59.936322, "longitude": 30.311550, "distance": 150 } ], "hitsCount": 20 } } ``` ``` -------------------------------- ### Nearby Search API Request Example Source: https://context7_llms Shows how to perform a geographical radius search using the /{database}/{collection}/nearbySearch endpoint. Requires latitude, longitude, radius, and optionally count. ```http GET /v1/{database}/{collection}/nearbySearch?lat=55.75&lon=37.61&radius=1000&count=50 HTTP/1.1 Host: api.usersbox.ru Authorization: ``` -------------------------------- ### Get Russian Localization for Fields Source: https://context7_llms Provides Russian translations for field names used within the API. This is useful for displaying human-readable labels in localized interfaces. ```json { "status": "success", "data": { "id": "ID", "uid": "User ID", "first_name": "Имя", "last_name": "Ѐамилия", "sex": "Пол", "age": "Возраст" // ... } } ``` -------------------------------- ### Search Collection - GET /{database}/{collection}/search Source: https://context7_llms Searches within a specific collection in a database. Supports query parameters for filtering and sorting. Pricing is per document, with a minimum charge. ```APIDOC ## GET /{database}/{collection}/search ### Description Searches within a specific collection in a database. Supports query parameters for filtering and sorting. Pricing is per document, with a minimum charge. ### Method GET ### Endpoint `/{database}/{collection}/search` ### Parameters #### Query Parameters - **q** (string) - Required - Search query. - **count** (integer) - Optional - Number of documents to return (25-500). - **sort** (string) - Optional - Field to sort by. - **sort_type** (string) - Optional - Type of sort (e.g., 'asc', 'desc'). ### Request Example No request body for GET requests. ### Response #### Success Response (200) - **status** (string) - Indicates success or error. - **data** (object) - Contains search results. - **count** (integer) - Number of documents returned. - **items** (array) - Array of document objects. - **hitsCount** (integer) - Approximate total number of matching documents. #### Response Example ```json { "status": "success", "data": { "count": 10, "items": [ { "_id": "492033988", "user_id": 225889705, "office": "28", "doorcode": "3460#", "comment": "Π°Ρ€ΠΊΠ° 0625#", "latitude": "59.936322", "longitude": "30.311550", "_score": 1.0 } ], "hitsCount": 50 } } ``` ``` -------------------------------- ### Get Collection JSON Schema Source: https://context7_llms Returns the JSON Schema (draft-07) for a given collection, based on approximately the first 5000 records. This helps understand the data structure within a collection. ```json { "status": "success", "data": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "_id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "sex": { "type": "integer" } // ... } } } ``` -------------------------------- ### Usersbox API - General Information Source: https://context7_llms This section provides general information about the Usersbox API, including authentication, base URL, and response structure. ```APIDOC ## Usersbox API General Information ### Description The Usersbox API provides access to a large dataset of over 20 billion documents. All requests are made using the GET method and require an Authorization header with an application token. The base URL for all requests is https://api.usersbox.ru/v1/{method_name}. ### Authorization - Obtain a token via the Telegram bot (command /api β†’ create application): http://link.usersbox.ru - Token must be passed in the `Authorization` header. ### Base URL `https://api.usersbox.ru/v1/{method_name}` ### Response Structure - `status`: "success" | "error" - `data`: object/array of data (if success) - `error`: { code, message } (if error) ``` -------------------------------- ### Error Handling Source: https://context7_llms Details common error codes returned by the API. ```APIDOC ## Error Codes ### Description Details common error codes returned by the API. ### Error Codes - **code 1**: Invalid access token β€” token is invalid/expired (check Authorization). - **code 2**: Missing access token β€” token not provided (add Authorization). - **code 3**: Rate limit exceeded. Retry after N seconds β€” request limit exceeded. - **code 4**: Not enough requests β€” insufficient funds on application balance. - **code 100**: Missing query parameter β€” missing 'q' in GET request. - **code 101**: Missing path parameter β€” missing {database} or {collection}. - **code 102**: Source not found β€” source not found (check /sources). - **code 1000**: Unknown Error β€” internal server error. ### Error Response Example ```json { "status": "error", "error": { "code": 1, "message": "Invalid access token" } } ``` ``` -------------------------------- ### Handle API Error Response Source: https://context7_llms Demonstrates the structure of an error response from the Usersbox API, including error code and message. Common codes indicate issues like invalid tokens or rate limits. ```json { "status": "error", "error": { "code": 1, "message": "Invalid access token" } } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.